Skip to main content

Create Order v1

Create an order synchronously to receive order details in response

Order Creation v1​

Orders can be placed by a POST request to v1/order API endpoint. Each request to create an order must include, along with the necessary authentication headers, order information in the request body. The format for the same can be found in the Create Order API Reference.

  • Acquire the create-order-payload from Account Manager.
  • Configure the order details in the create-order-payload JSON. This payload will be placed in the request body.
  • Acquire access-token as mentioned in Authentication. The account's clientId and secret can be found in WebApp
  • Make a POST request to /order API endpoint. API reference in Create Order V1
danger

For orders placed with country=USA, the region field must be included in Shipping address.

Creating a test order​

To make sure the account and webhook have been successfully registered, we suggest to send few test orders before going live. The steps to create a test order are the same as a real one mentioned above. In case of a test order, the fakeOrder key in the payload will have true value.

warning

The fakeOrder flag, which is a part of the create-order-payload, has to be set as true (otherwise the order placed will be produced) .