Create a order

Create a new order. If your order includes products that ship from multiple facilities, each facility’s products will be processed as a separate shipment within the overarching order.

📘

Authentication

Provide your bearer token in the Authorization header.
Example: Authorization: Bearer 123

🚧

Errors

There are 3 possible errors that you will receive from the Create_Shipment endpoint.

1/ The given shipping address is invalid.

2/ The product has insufficient inventory. We don't process partial orders.

📘

Idempotency

This endpoint supports idempotency keys to safely retry requests without creating duplicate orders.

📖 See Idempotency Guide →

Body Params
string
required
string
required
string
string
string
string
required
string
string
required
string
required
string
required
string
required

2 character country code. (eg: US)

string
file
string

The notecard URL, if defined, will be used rather than the notecard message and logo

products
array of objects
products
string
string
string
string
string
string
string
boolean
Headers
string
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json