Create a sales order

Creates a new sales order object. The order, its rows and their traceability are created together: when a row or traceability entry is refused, no order is created.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

new sales order details

string
integer
required
≤ 2147483647
sales_order_rows
array of objects
required
length ≥ 1
sales_order_rows*
number
required
≤ 100000000000000000
integer
required
≤ 2147483647
integer
≤ 2147483647
integer
≤ 2147483647
attributes
array of objects
attributes
number
≤ 1000000000000000000
number
≤ 1000000000000000000
traceability
array of objects

Batch, serial number and bin location breakdown of the row quantity. Omit it or send [] to leave the row untraced.

traceability
string | null

Pre-fills the tracking of the sales order’s next shipment. When a fulfillment is created without any tracking of its own, the sales order’s tracking_number, tracking_number_url, tracking_carrier and tracking_method move onto that fulfillment together and are cleared from the sales order. A sales order can ship in several fulfillments, each with its own tracking, so after shipping read and set tracking on /sales_order_fulfillments.

string | null

Pre-fills the tracking of the sales order’s next shipment. When a fulfillment is created without any tracking of its own, the sales order’s tracking_number, tracking_number_url, tracking_carrier and tracking_method move onto that fulfillment together and are cleared from the sales order. A sales order can ship in several fulfillments, each with its own tracking, so after shipping read and set tracking on /sales_order_fulfillments.

string | null

Pre-fills the tracking of the sales order’s next shipment. When a fulfillment is created without any tracking of its own, the sales order’s tracking_number, tracking_number_url, tracking_carrier and tracking_method move onto that fulfillment together and are cleared from the sales order. A sales order can ship in several fulfillments, each with its own tracking, so after shipping read and set tracking on /sales_order_fulfillments.

string | null

Pre-fills the tracking of the sales order’s next shipment. When a fulfillment is created without any tracking of its own, the sales order’s tracking_number, tracking_number_url, tracking_carrier and tracking_method move onto that fulfillment together and are cleared from the sales order. A sales order can ship in several fulfillments, each with its own tracking, so after shipping read and set tracking on /sales_order_fulfillments.

addresses
array of objects
addresses
string
string
string

E.g. USD, EUR. All currently active currency codes in ISO 4217 format.

integer
≤ 2147483647
string
enum

When the status is omitted, NOT_SHIPPED is used as default.
Use PENDING when you want to create sales order quotes.

Allowed:
string
string | null
string
string
string
custom_fields
object | null

Custom field values keyed by custom field definition ID (UUID). Each value matches the definition’s field_type — string for shortText/url, number for number, boolean for boolean, YYYY-MM-DD string for date, or the integer choice id for singleSelect.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json