Skip to main content

Create order

POST 

/v1/orders

Rate limit32 requests per minute

Pushes a new order into Otter for the store identified by the X-Store-Id header. Used by ordering marketplaces and other order sources when a customer places an order. Provide the order's line items, fulfillment information, customer payments, and at least one financial breakdown — orderTotal (V1) or orderTotalV2 (V2). Both are accepted; when both are present, V2 takes precedence. New integrations should prefer orderTotalV2. All monetary values use the major unit of the order's currencyCode. The response returns the order reference: the source externalIdentifiers (id and friendlyId) and storeId. Use those values to correlate and update the order later. externalIdentifiers.id is the order's stable identity for the source and store. Retrying with an ID that already exists does not create another order; the API returns 409 Conflict instead of replaying the original success response.

Request

Responses

The order was successfully created.