List inventory

ERP (Priority, Pro plan and above). Stock items with quantities per warehouse and value at cost, deleted ones left out. An integration whose connector does not sync this stream answers an empty page with freshness.dataAsOf null, not an error.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^intg_[0-9A-HJKMNP-TV-Z]{26}$

The integration's id (intg_ and 26 characters), from GET /integrations/.

Query Params
string
length between 1 and 100

Case-insensitive part of the name or the SKU, 1–100 characters (trimmed).

boolean

Only items with stock on hand. true or false.

integer
1 to 200
Defaults to 50

Items per page, 1–200. Default 50.

string
length between 1 and 2048

nextCursor from the previous page. It is valid only for the same integration and listing; anything else answers 400 CURSOR_INVALID.

Responses

401

Missing or invalid access token (answered by the API gateway, without the error envelope).

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json