{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:version/campaigns/:campaign_id/orders/batch_status.json","auth":"required","settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"response\": {\n    \"status\": \"completed\",\n    \"message\": \"Completed at 2017-05-04 17:10:09 -0700\",\n    \"number_processed\": 2,\n    \"total\": 2\n  }\n}","name":""}]},"examples":{"codes":[{"language":"curl","code":"curl -G -d api_token={API TOKEN} -d access_token={ACCESS TOKEN} -d job_id=aWlvA3OEhKGQm9Xd2cvalVKQTQr https://api.indiegogo.com/2/campaigns/{CAMPAIGN ID}/orders/batch_status.json"}]},"method":"get","params":[{"name":"campaign_id","type":"string","default":"","desc":"The ID number assigned to the Indiegogo account.","required":false,"in":"path","ref":"","_id":"59b84a9e8c45630028f0d47e"},{"name":"job_id","type":"string","default":"","desc":"The previously obtained job ID.","required":false,"in":"query","ref":"","_id":"59b84ccb8c45630028f0d74e"}]},"next":{"description":"","pages":[]},"title":"Campaign Orders Batch Status","type":"endpoint","slug":"campaign-orders-batch-status","excerpt":"/2/campaigns/:campaign_id/orders/batch_status.json","body":"Get the current status of a batch order update job given an id. Must provide an access_token of the campaign creator or a team member account. Possible status responses are “queued”, “working”, “completed”, “failed”, or “killed”.","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59b84c3d2c15d900243c84da","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-12T21:06:05.884Z","githubsync":"","__v":5,"parentDoc":null}

getCampaign Orders Batch Status

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

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Query Params

job_id:
string
The previously obtained job ID.

Examples


Result Format


Documentation

Get the current status of a batch order update job given an id. Must provide an access_token of the campaign creator or a team member account. Possible status responses are “queued”, “working”, “completed”, “failed”, or “killed”.