Skip to main content
POST
Create order from cart

Request

Headers

Body parameters

You can create an order using one of the following methods:

additionalInfo entries

Attach custom fields to the order (e.g. a gift message or delivery instructions). Each entry has a required label and an optional value. Entries without a label are dropped, and the list is capped at 50 entries.
If no body parameters are provided, the entire cart will be converted into an order.
Food and service cart items have no productId, so select them with indices (0-based cart positions) or send an empty body to include the whole cart. The resulting order items carry an itemType of product, food, or service; service items reference service and include any selectedAddons. Service (business) orders are non-shippable, so shippingCost is 0 and no shipment is created.

Request examples

Create order from entire cart

Create order from selected products

Create order from explicit items

Create order from cart indices

Create order with additional info

Successful response

Error response

Authorizations

Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Body

application/json

If no parameters provided, entire cart will be converted to order.

productIds
string[]

Array of product IDs to include (any variants of these products).

items
object[]

Array of explicit items with productId and optional variantId.

indices
integer[]

Array of 0-based cart item positions to include.

Required range: x >= 0
additionalInfo
object[]

Custom labelled key/value info to attach to the order (e.g. gift message, delivery instructions). Max 50 entries.

Maximum array length: 50

Response

Order created successfully.

status
integer
required
success
boolean
required
message
string
required
data
object
required