Create Order

Create an order. A new order returns 201 with fulfillment_status unfulfilled, status unverified and no shipments. Save the order id and each item id against your order and lines.

  • Idempotent on order_number. If the store already has that order number, you get 200 with the existing order and nothing changes, even if the body is different or the order is cancelled. After a timeout, send the same request again. To change an order, use the update and item endpoints.
  • Unknown SKUs are accepted. The order waits, unfulfilled, until your customer maps the SKU to one of their products. Until then the item's sku_id is null.
  • Validation errors return 404, with one message per problem, as the API many platforms were built against does. Malformed JSON also returns 404. If your customer filters which orders this store accepts, a filtered order returns 404 {"errors": ["Order was rejected by the store's import filter"]}.
  • The body can be wrapped ({"order": {...}}) or have the order's fields at the top level.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The store ID your customer sent you with the credentials. It must belong to the same store as the username.

Body Params
order
object
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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