List product inventory across 3PL integrations
GET/inventory
Returns a paginated list of shippable products with the quantity each connected integration holds, the combined total, and a stock status. Served from a cached snapshot — GET /inventory/sources reports when it was taken and POST /inventory/refresh rebuilds it.
Request
Responses
- 200
- 202
- 400
- 401
- 403
- 429
- 500
- 504
The merchant is entitled but its OMS environment is not provisioned yet. Provisioning has been kicked off (exactly once) and is in progress; retry the request — it succeeds once the environment is ready. Returned only for identity-token (dashboard) requests bound to an active-entitled merchant, not for secret-key API calls; any such endpoint can return it while provisioning is underway.
The request failed validation. errors lists every problem found; an entry attributable to a specific field is prefixed with that field’s path.
No credentials were supplied, or the identity token / secret key is not valid for the target merchant.
The credentials are valid but lack the permission this operation requires.
Too many requests. The rate limit is applied per client across all operations.
The request could not be completed because of an unexpected error.
The request exceeded the processing time limit and was abandoned.