Skip to main content
GET
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.

Query Parameters

status
enum<string> | null

Where a sales order is in its life. Shipping, invoicing and closing set the later statuses.

Available options:
draft,
confirmed,
partially_shipped,
shipped,
invoiced,
closed,
cancelled
customer_id
string<uuid> | null
number
string | null

An order number, matched exactly, such as SO-00042.

Maximum string length: 32
after
string<uuid> | null

The next_cursor of the page before.

Response

SalesOrderPageResource

data
SalesOrderPageResource · object
required