Skip to main content

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.

Required scope: products:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

  • on_hand = total stock less in-transit; available and allocated come from the same warehouse.
  • cells is aligned with columns; a null cell means no variant exists for that combination.
  • column_totals is aligned with columns; each row carries its own total.
  • A variant missing a size or color value appears in a — column/row so totals still reconcile.
  • warehouses lists the warehouses holding stock of any variant (use them for warehouse_id).

Requires the products view permission and the products scope.

Request​

Responses​

OK

Response Headers
    Content-Type