post https://api.business.amazon.com/ordering/2022-10-30/orders
Attempts to place an order with the given attributes and expectations from the order request.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 0.5 | 10 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. The preceding table indicates the default rate and burst values for this operation. For questions about your usage plan, reach out to your Amazon Business technical contact.
To test this API, select the Edit JSON body field (
{ }) in the request code box on the right and provide any of the following sample request payloads.Example #1 - Click to expand
{ "lineItems": [ { "attributes": [ { "attributeType": "SelectedProductReference", "productReference": { "productReferenceType": "ProductIdentifier", "id": "B001W0QL2I" } }, { "attributeType": "SelectedBuyingOptionReference", "buyingOptionReference": { "buyingOptionReferenceType": "BuyingOptionIdentifier", "id": "C8f0WuwepAqdhzcODiXbBk3M5ELAg0uCpF1NhSQwG%2BXe9d1fv5O0EmoG1EuHXOkwuXdb1Rh54eA7OXQ7BR%2FGxLRGNWfBhMsX4ekpT%2FK8Jx%2F7sFRutBZ%2B1F4EAHgbIr8HwWTxDTQx9Uz0PdB2mLnJd2xqhzg2Aepx" } } ], "externalId": "line-item-1", "quantity": 1, "expectations": [ { "expectationType": "ExpectedUnitPrice", "amount": { "currencyCode": "EUR", "amount": 6.03 } }, { "expectationType": "ExpectedCharge", "amount": { "currencyCode": "EUR", "amount": 6.03 }, "source": "SUBTOTAL" } ] } ], "externalId": "TestOrderDev124", "attributes": [ { "attributeType": "PurchaseOrderNumber", "purchaseOrderNumber": "TestOrderDev124" }, { "attributeType": "BuyerReference", "userReference": { "userReferenceType": "UserEmail", "emailAddress": "[email protected]" } }, { "attributeType": "BuyingGroupReference", "groupReference": { "groupReferenceType": "GroupIdentity", "identifier": "OrderingAPI9644267000" } }, { "attributeType": "Region", "region": "DE" }, { "attributeType": "SelectedPaymentMethodReference", "paymentMethodReference": { "paymentMethodReferenceType": "StoredPaymentMethod" } }, { "attributeType": "ShippingAddress", "address": { "addressType": "PhysicalAddress", "fullName": "Full Name", "phoneNumber": "+1-888-280-0000", "companyName": "Company Name", "addressLine1": "Address Line 1", "city": "Munich", "stateOrRegion": "DE", "postalCode": "80807", "countryCode": "DE" } } ] }Example #2 - Click to expand
{ "lineItems": [ { "attributes": [ { "attributeType": "SelectedProductReference", "productReference": { "productReferenceType": "ProductIdentifier", "id": "B0D9MNL82X" } }, { "attributeType": "SelectedBuyingOptionReference", "buyingOptionReference": { "buyingOptionReferenceType": "BuyingOptionIdentifier", "id": "kI4pr2YmElYitRZbjhyztNkgrIfMtnB91AlrK0%2FYysnmz8DLipyFHjq5XWaYQ37b%2FDH2GSkad2D53S7ngFRHOiBCPx1%2Fab3ctqts%2FwKX4vR7197IoYyO0GtMJXMexJJpJYLT%2FXx7ywlDTPL4XqOCEg%3D%3D" } } ], "externalId": "line-item-1", "quantity": 1, "expectations": [ { "expectationType": "ExpectedUnitPrice", "amount": { "currencyCode": "USD", "amount": 9.99 } }, { "expectationType": "ExpectedCharge", "amount": { "currencyCode": "USD", "amount": 6.99 }, "source": "SUBTOTAL" } ] }, { "attributes": [ { "attributeType": "SelectedProductReference", "productReference": { "productReferenceType": "ProductIdentifier", "id": "B082PMRSBK" } }, { "attributeType": "SelectedBuyingOptionReference", "buyingOptionReference": { "buyingOptionReferenceType": "BuyingOptionIdentifier", "id": "kI4pr2YmElYitRZbjhyztDPUZRdmRhO93fC5aIo1YedZ7gdBXAvyXlt0aOfkt9B1DwfHEtXRS1yeLm8t3S3MolrttU80QOfOc2KbRQ08tzkU5krmlOFWC3urEzNZaNZtqU%2BPNmO%2Fpr3caBTUcn5Wse2tG6W2qcDp" } } ], "externalId": "line-item-2", "quantity": 1, "expectations": [ { "expectationType": "ExpectedUnitPrice", "amount": { "currencyCode": "USD", "amount": 4.87 } }, { "expectationType": "ExpectedCharge", "amount": { "currencyCode": "USD", "amount": 6.99 }, "source": "SUBTOTAL" } ] } ], "externalId": "TestOrderDev112", "attributes": [ { "attributeType": "PurchaseOrderNumber", "purchaseOrderNumber": "TestOrderDev112" }, { "attributeType": "BuyerReference", "userReference": { "userReferenceType": "UserEmail", "emailAddress": "[email protected]" } }, { "attributeType": "BuyingGroupReference", "groupReference": { "groupReferenceType": "GroupIdentity", "identifier": "OrderingAPI5706136000" } }, { "attributeType": "Region", "region": "US" }, { "attributeType": "SelectedPaymentMethodReference", "paymentMethodReference": { "paymentMethodReferenceType": "StoredPaymentMethod" } }, { "attributeType": "ShippingAddress", "address": { "addressType": "PhysicalAddress", "fullName": "Full Name", "phoneNumber": "+1-888-280-0000", "companyName": "Company Name", "addressLine1": "Address Line 1", "city": "City", "stateOrRegion": "WA", "postalCode": "98109", "countryCode": "US" } } ] }Example #3 - Click to expand
{ "lineItems": [ { "attributes": [ { "attributeType": "SelectedProductReference", "productReference": { "productReferenceType": "ProductIdentifier", "id": "B0D9MNL82X1" } }, { "attributeType": "SelectedBuyingOptionReference", "buyingOptionReference": { "buyingOptionReferenceType": "BuyingOptionIdentifier", "id": "kI4pr2YmElYitRZbjhyztNkgrIfMtnB91AlrK0%2FYysnmz8DLipyFHjq5XWaYQ37b%2FDH2GSkad2D53S7ngFRHOiBCPx1%2Fab3ctqts%2FwKX4vR7197IoYyO0GtMJXMexJJpJYLT%2FXx7ywlDTPL4XqOCEg%3D%3ED" } } ], "externalId": "line-item-1", "quantity": 1, "expectations": [ { "expectationType": "ExpectedUnitPrice", "amount": { "currencyCode": "USD", "amount": 9.99 } }, { "expectationType": "ExpectedCharge", "amount": { "currencyCode": "USD", "amount": 6.99 }, "source": "SUBTOTAL" } ] }, { "attributes": [ { "attributeType": "SelectedProductReference", "productReference": { "productReferenceType": "ProductIdentifier", "id": "B082PMRSBK" } }, { "attributeType": "SelectedBuyingOptionReference", "buyingOptionReference": { "buyingOptionReferenceType": "BuyingOptionIdentifier", "id": "kI4pr2YmElYitRZbjhyztDPUZRdmRhO93fC5aIo1YedZ7gdBXAvyXlt0aOfkt9B1DwfHEtXRS1yeLm8t3S3MolrttU80QOfOc2KbRQ08tzkU5krmlOFWC3urEzNZaNZtqU%2BPNmO%2Fpr3caBTUcn5Wse2tG6W2qcDp" } } ], "externalId": "line-item-2", "quantity": 1, "expectations": [ { "expectationType": "ExpectedUnitPrice", "amount": { "currencyCode": "USD", "amount": 4.87 } }, { "expectationType": "ExpectedCharge", "amount": { "currencyCode": "USD", "amount": 6.99 }, "source": "SUBTOTAL" } ] } ], "externalId": "TestOrderDev220", "attributes": [ { "attributeType": "PurchaseOrderNumber", "purchaseOrderNumber": "TestOrderDev220" }, { "attributeType": "BuyerReference", "userReference": { "userReferenceType": "UserEmail", "emailAddress": "[email protected]" } }, { "attributeType": "BuyingGroupReference", "groupReference": { "groupReferenceType": "GroupIdentity", "identifier": "OrderingAPI5706136000" } }, { "attributeType": "Region", "region": "US" }, { "attributeType": "SelectedPaymentMethodReference", "paymentMethodReference": { "paymentMethodReferenceType": "StoredPaymentMethod" } }, { "attributeType": "ShippingAddress", "address": { "addressType": "PhysicalAddress", "fullName": "Full Name", "phoneNumber": "+1-888-280-0000", "companyName": "Company Name", "addressLine1": "Address line 1", "city": "City", "stateOrRegion": "WA", "postalCode": "98109", "countryCode": "US" } } ] }Example #4 - Click to expand
{ "lineItems": [ { "attributes": [ { "attributeType": "SelectedProductReference", "productReference": { "productReferenceType": "ProductIdentifier", "id": "B001W0QL2I" } }, { "attributeType": "SelectedBuyingOptionReference", "buyingOptionReference": { "buyingOptionReferenceType": "BuyingOptionIdentifier", "id": "C8f0WuwepAqdhzcODiXbBk3M5ELAg0uCpF1NhSQwG%2BXe9d1fv5O0EmoG1EuHXOkwuXdb1Rh54eA7OXQ7BR%2FGxLRGNWfBhMsX4ekpT%2FK8Jx%2F7sFRutBZ%2B1F4EAHgbIr8HwWTxDTQx9Uz0PdB2mLnJd2xqhzg2Aepx" } } ], "externalId": "line-item-1", "quantity": 1, "expectations": [ { "expectationType": "ExpectedUnitPrice", "amount": { "currencyCode": "GBP", "amount": 6.03 } }, { "expectationType": "ExpectedCharge", "amount": { "currencyCode": "EUR", "amount": 6.03 }, "source": "SUBTOTAL" } ] } ], "externalId": "TestOrderDev711", "attributes": [ { "attributeType": "PurchaseOrderNumber", "purchaseOrderNumber": "TestOrderDev711" }, { "attributeType": "BuyerReference", "userReference": { "userReferenceType": "UserEmail", "emailAddress": "[email protected]" } }, { "attributeType": "BuyingGroupReference", "groupReference": { "groupReferenceType": "GroupIdentity", "identifier": "OrderingAPI9644267000" } }, { "attributeType": "Region", "region": "DE" }, { "attributeType": "SelectedPaymentMethodReference", "paymentMethodReference": { "paymentMethodReferenceType": "StoredPaymentMethod" } }, { "attributeType": "ShippingAddress", "address": { "addressType": "PhysicalAddress", "fullName": "Full Name", "phoneNumber": "+1-888-280-0000", "companyName": "Company Name", "addressLine1": "Address line 1", "city": "Munich", "stateOrRegion": "DE", "postalCode": "80807", "countryCode": "DE" } } ] }