WinShopAPI docs
ReferenceProduct

Get the variant matrix for one warehouse

Same grid as `GET variants-availability-matrix`, restricted to the stock held in `warehouseId`. `warehouseId` is required. Requires `Permissions.Product.View`.

GET
/api/products/warehouse-variants-availability-matrix

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Query Parameters

warehouseId?integer
Formatint32
productIds?array<>

Response Body

application/json
  1. response
[index: integer]?
curl -X GET 'https://<your-instance>/api/products/warehouse-variants-availability-matrix' \  -H 'Authorization: Bearer <access-token>'
[  {    "colorId": 0,    "dimensionId": 0,    "lengthId": 0,    "productId": 0,    "quantityBlocked": 0,    "quantityInStock": 0,    "sizeId": 0,    "stockItemId": 0,    "warehouseId": 0  }]

Get the variant matrix of several products GET

Returns, for each product in `productIds`, the grid of its colour/size/length/dimension variants with the quantity available in each cell. Requires `Permissions.Product.View`.

Get a product GET

Returns one product by `productId`. Use `details` to pick which sub-collections (barcodes, units, variants, …) are loaded; omit it for the header only, which is much cheaper. Requires `Permissions.Product.View`.