Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

A sales order, with up to 50 lines.

customer_id
string<uuid>
required
location_id
string<uuid>
required

The stock location the order ships from.

lines
object[]
required
Required array length: 1 - 50 elements
shipping_address
string | null

The customer's shipping address when left out.

Maximum string length: 1000
requested_on
string<date> | null
note
string | null
Maximum string length: 1000

Response

SalesOrderResource

data
SalesOrderResource · object
required