{"_id":"569805328d2a770d00d2fd3c","user":"55fae9d4825d5f19001fa379","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":35,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295","5a009de510890d001c2aabfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"project":"55faeacad0e22017005b8265","parentDoc":null,"__v":15,"category":{"_id":"5601ae926811d00d00ceb487","pages":["561d51f56386060d00e06016","561d52469e8e1f0d00983290","561d527a31d9630d001eb5ce","561d52ef9e8e1f0d00983292","56411e7f2a2a4c0d00c69773","564a36d43242592b00338a74","566b368c1766bf0d00e73970","569805328d2a770d00d2fd3c","569806dd69393517000c846d","5698073e3503e40d0061f4f3","56aa5dce09cb9c0d00f0c8c3","56cf5b5f287eb20b009f9f26"],"project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","__v":12,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-22T19:40:02.922Z","from_sync":false,"order":5,"slug":"ordering-guide","title":"Ordering Guide"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-14T20:29:38.384Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","name":"","code":"[\n    \"104001000506EE00\",\n    \"1010010005231400\"\n]"}]},"method":"post","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"order_id\": \"ebffda38-1d6e-4fff-9ae2-aaca94243c45\",\n  \"acquisitions\": [\n    {\n      \"acquisition_id\": \"1010010005231400\",\n      \"state\": \"delivered\",\n      \"location\": \"s3://receiving-dgcs-tdgplatform-com/055046034010_01_003\"\n    },\n    {\n      \"acquisition_id\": \"104001000506EE00\",\n      \"state\": \"delivered\",\n      \"location\": \"s3://receiving-dgcs-tdgplatform-com/055046005010_01_003\"\n    }\n  ]\n}"}]},"settings":"56143e6a1a8caf0d00689482","auth":"required","params":[],"url":"/orders/v2/order"},"isReference":false,"order":3,"body":"The example above shows two catalog IDs (acquisitions) that have been **delivered** to the GBDX catalog. The location shows the S3 bucket location where the acquisitions are stored.\n\nThe following example shows the response to an order where the acquisitions have an order status of **\"submitted\"**. Since they haven't been delivered to the catalog yet, their location shows \"not_delivered.\"\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"order_id\\\": \\\"39cbb1fc-c895-4daa-b072-2b83e46ab299\\\",\\n  \\\"acquisitions\\\": [\\n    {\\n      \\\"acquisition_id\\\": \\\"10400100086A9700\\\",\\n      \\\"state\\\": \\\"submitted\\\",\\n      \\\"location\\\": \\\"not_delivered\\\"\\n    },\\n    {\\n      \\\"acquisition_id\\\": \\\"10400100168FFA00\\\",\\n      \\\"state\\\": \\\"submitted\\\",\\n      \\\"location\\\": \\\"not_delivered\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nOnce the ordering process has begun, the response will show a state of **\"ordering.\"**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"order_id\\\": \\\"59ae277a-d448-4c34-bc68-477d2bf4e061\\\",\\n  \\\"acquisitions\\\": [\\n    {\\n      \\\"acquisition_id\\\": \\\"10400100086A9700\\\",\\n      \\\"state\\\": \\\"ordering\\\",\\n      \\\"location\\\": \\\"not_delivered\\\"\\n    },\\n    {\\n      \\\"acquisition_id\\\": \\\"10400100168FFA00\\\",\\n      \\\"state\\\": \\\"ordering\\\",\\n      \\\"location\\\": \\\"not_delivered\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n\n## Order Limit\n Orders are limited to 100 catalog IDs per order requests. \n\n##Duplicates in an Order\nIf the same catalog ID is requested more than once in the same order request, they will be collapsed into one ID before the order is sent to the factory.\n\n\n## Reference\nAttribute | Description\n--- | ----\norder_id | The ID assigned to the order. \nacquisitions | Groups the acquisitions that were part of their order and their state.\nacquisition_id | A separate line item for each acquisition that was part of the order. \nstate | The status of the acquisition that was ordered. See the Order States table below.\n\nOrder States | Description\n--- | ---\nsubmitted | The order has been submitted to the GBDX platform\nordering | The Acquisition IDs are being ordered from the DigitalGlobe (DG) factory\nplaced | The order has been placed with the DG factory. \ndelivered | The Acquisition ID has been delivered from the DG factory and is available\nfailed | The order failed. \n\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This is version 2 of the GBDX Orders API.\",\n  \"body\": \"Version 1 has been deprecated.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"You need a token to try this request.\",\n  \"body\": \"For more information, see the Authentication Guide.\"\n}\n[/block]","excerpt":"Place an Order for one or more catalog IDs to the Orders V2 API","slug":"place-an-order-v2","type":"endpoint","title":"Place an Order v2"}

postPlace an Order v2

Place an Order for one or more catalog IDs to the Orders V2 API

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

The example above shows two catalog IDs (acquisitions) that have been **delivered** to the GBDX catalog. The location shows the S3 bucket location where the acquisitions are stored. The following example shows the response to an order where the acquisitions have an order status of **"submitted"**. Since they haven't been delivered to the catalog yet, their location shows "not_delivered." [block:code] { "codes": [ { "code": "{\n \"order_id\": \"39cbb1fc-c895-4daa-b072-2b83e46ab299\",\n \"acquisitions\": [\n {\n \"acquisition_id\": \"10400100086A9700\",\n \"state\": \"submitted\",\n \"location\": \"not_delivered\"\n },\n {\n \"acquisition_id\": \"10400100168FFA00\",\n \"state\": \"submitted\",\n \"location\": \"not_delivered\"\n }\n ]\n}", "language": "json" } ] } [/block] Once the ordering process has begun, the response will show a state of **"ordering."** [block:code] { "codes": [ { "code": "{\n \"order_id\": \"59ae277a-d448-4c34-bc68-477d2bf4e061\",\n \"acquisitions\": [\n {\n \"acquisition_id\": \"10400100086A9700\",\n \"state\": \"ordering\",\n \"location\": \"not_delivered\"\n },\n {\n \"acquisition_id\": \"10400100168FFA00\",\n \"state\": \"ordering\",\n \"location\": \"not_delivered\"\n }\n ]\n}", "language": "json" } ] } [/block] ## Order Limit Orders are limited to 100 catalog IDs per order requests. ##Duplicates in an Order If the same catalog ID is requested more than once in the same order request, they will be collapsed into one ID before the order is sent to the factory. ## Reference Attribute | Description --- | ---- order_id | The ID assigned to the order. acquisitions | Groups the acquisitions that were part of their order and their state. acquisition_id | A separate line item for each acquisition that was part of the order. state | The status of the acquisition that was ordered. See the Order States table below. Order States | Description --- | --- submitted | The order has been submitted to the GBDX platform ordering | The Acquisition IDs are being ordered from the DigitalGlobe (DG) factory placed | The order has been placed with the DG factory. delivered | The Acquisition ID has been delivered from the DG factory and is available failed | The order failed. [block:callout] { "type": "info", "title": "This is version 2 of the GBDX Orders API.", "body": "Version 1 has been deprecated." } [/block] [block:callout] { "type": "warning", "title": "You need a token to try this request.", "body": "For more information, see the Authentication Guide." } [/block]

User Information

Try It Out


post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}