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

connection
string
required

Query Parameters

snapshot
string<uuid> | null

The snapshot whose differences to show; the newest when left out.

after
string<uuid> | null

The next of the previous page.

Response

StockSnapshotsResource

connection_id
string
required
label
string
required
vendor
string
required
data
StockSnapshotResource · object[]
required
selected
StockSnapshotResource · object | null
required

The snapshot whose differences follow.

lines
any[]
required

Its differences in the item's base unit, at most 500.

more_lines
integer
required

Differences beyond those listed.

next
string | null
required

Pass as after for the next page of snapshots; null on the last.