WinShopAPI docs
ReferenceProduct

Get the variant matrix of one product

Returns the grid of one product's colour/size/length/dimension variants with the quantity available in each cell. Requires `Permissions.Product.View`.

GET
/api/products/{productId}/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.

Path Parameters

productId*integer
Formatint32
Default0

Response Body

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

Remove a user-group membership DELETE

Removes the product from one user group and returns 204. Requires `Permissions.Product.Update`.

Get one product's matrix for one warehouse GET

Returns one product's variant grid restricted to the stock held in `warehouseId`, which is required. Requires `Permissions.Product.View`.