Get Variant Stock Grid
GET/api/v2/products/:product/variant-stock-grid
Size × color stock grid for a matrix (parent) product: rows are the color option (or, when the style has no color, the first other option whose value differs between variants), columns are the size option in natural size order (0-3m, 6-12m, 2T, 3y, 4, XS, S, M…), and each cell is one variant's stock.
products:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
on_hand= total stock less in-transit;availableandallocatedcome from the same warehouse.cellsis aligned withcolumns; anullcell means no variant exists for that combination.column_totalsis aligned withcolumns; each row carries its owntotal.- A variant missing a size or color value appears in a
—column/row so totals still reconcile. warehouseslists the warehouses holding stock of any variant (use them forwarehouse_id).
Requires the products view permission and the products scope.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.