{"_id":"59b8219090064400101c55ef","project":"542c6f8dddd3190e00228898","version":{"_id":"5912369265888319004e555f","__v":1,"project":"542c6f8dddd3190e00228898","createdAt":"2017-05-09T21:37:22.992Z","releaseDate":"2017-05-09T21:37:22.992Z","categories":["5912369465888319004e5560","5912369465888319004e5561","5912369465888319004e5562"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"5912369465888319004e5560","__v":0,"version":"5912369265888319004e555f","project":"542c6f8dddd3190e00228898","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-19T19:52:12.019Z","from_sync":false,"order":0,"slug":"api-reference","title":"API Reference"},"user":"5474d5e859fade080004ca6c","__v":5,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-12T18:04:00.310Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[{"code":"curl -X PUT -d api_token={API TOKEN} -d access_token={ACCESS TOKEN} -d order_ids%5B%5D={ORDER ID 1} -d order_ids%5B%5D={ORDER ID 2} -d new_state=fulfilled https://api.indiegogo.com/2/campaigns/{CAMPAIGN ID}/orders/batch_update.json","language":"curl"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\"response\":{\"job_id\":\"aWlvA3OEhKGQm9Xd2cvalVKQTQr\"}}","name":""}]},"settings":"","auth":"required","params":[{"_id":"59b84a9e8c45630028f0d47e","ref":"","in":"path","required":false,"desc":"The ID number assigned to the Indiegogo account.","default":"","type":"string","name":"campaign_id"},{"_id":"59b84a9e8c45630028f0d47d","ref":"","in":"query","required":false,"desc":"The list of order IDs for transitioning.","default":"","type":"array_int","name":"order_ids"},{"_id":"59b84a9e8c45630028f0d47c","ref":"","in":"query","required":false,"desc":"The new state for all of the orders supplied. Can be one of “pending”, “in_fulfillment”, or “fulfilled”.","default":"","type":"string","name":"new_state"}],"url":"/:version/campaigns/:campaign_id/orders/batch_update.json"},"isReference":false,"order":4,"body":"Changes order state. Must provide an access_token of the campaign creator or a team member account. If request was successful, returns a job_id to be used with the batch_status endpoint. Order transitioning happens asynchronously. Only one order transition job can be running per campaign at a time.","excerpt":"/2/campaigns/:campaign_id/orders/batch_update.json","slug":"campaign-orders","type":"endpoint","title":"Campaign Orders Batch Update"}

putCampaign Orders Batch Update

/2/campaigns/:campaign_id/orders/batch_update.json

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

campaign_id:
string
The ID number assigned to the Indiegogo account.

Query Params

order_ids:
array of integers
The list of order IDs for transitioning.
new_state:
string
The new state for all of the orders supplied. Can be one of “pending”, “in_fulfillment”, or “fulfilled”.

Examples


Result Format


Documentation

Changes order state. Must provide an access_token of the campaign creator or a team member account. If request was successful, returns a job_id to be used with the batch_status endpoint. Order transitioning happens asynchronously. Only one order transition job can be running per campaign at a time.