{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:version/campaigns/:campaign_id/orders/batch_update.json","auth":"required","method":"put","examples":{"codes":[{"language":"curl","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"}]},"results":{"codes":[{"name":"","code":"{\"response\":{\"job_id\":\"aWlvA3OEhKGQm9Xd2cvalVKQTQr\"}}","language":"json","status":200}]},"settings":"","params":[{"name":"campaign_id","type":"string","default":"","desc":"The ID number assigned to the Indiegogo account.","required":false,"in":"path","ref":"","_id":"59b84a9e8c45630028f0d47e"},{"name":"order_ids","type":"array_int","default":"","desc":"The list of order IDs for transitioning.","required":false,"in":"query","ref":"","_id":"59b84a9e8c45630028f0d47d"},{"name":"new_state","type":"string","default":"","desc":"The new state for all of the orders supplied. Can be one of “pending”, “in_fulfillment”, or “fulfilled”.","required":false,"in":"query","ref":"","_id":"59b84a9e8c45630028f0d47c"}]},"next":{"description":"","pages":[]},"title":"Campaign Orders Batch Update","type":"endpoint","slug":"campaign-orders","excerpt":"/2/campaigns/:campaign_id/orders/batch_update.json","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.","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59b8219090064400101c55ef","project":"542c6f8dddd3190e00228898","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5912369465888319004e5560","5912369465888319004e5561","5912369465888319004e5562","5d3940ed4c6ef200427daf54"],"_id":"5912369265888319004e555f","createdAt":"2017-05-09T21:37:22.992Z","__v":2,"project":"542c6f8dddd3190e00228898","releaseDate":"2017-05-09T21:37:22.992Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"API Reference","slug":"api-reference","order":1,"from_sync":false,"reference":false,"_id":"5912369465888319004e5560","__v":0,"version":"5912369265888319004e555f","project":"542c6f8dddd3190e00228898","createdAt":"2016-05-19T19:52:12.019Z"},"user":"5474d5e859fade080004ca6c","createdAt":"2017-09-12T18:04:00.310Z","githubsync":"","__v":5,"parentDoc":null}

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.