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.

Path Parameters

direction
enum<string>
required

The direction ID Which way a genealogy trace runs. Back runs from what was made to what it was made from. Forward runs from what was used to what it went into and who it was shipped to.

Available options:
backward,
forward

Query Parameters

item
string
required

The item, by id or SKU.

Maximum string length: 255
lot
string | null

A lot of the item.

Maximum string length: 255
serial
string | null

A serial number of the item.

Maximum string length: 255

Response

The response is of type string.