v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Product

View stock details of a product

Returns stock details of a given product

get/api/v1/products/{id}/stocks

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Success

Example response

{
  "data": {
    "id": "123",
    "totals": {
      "pseudo": null,
      "sellable": 75,
      "reserved": 20,
      "correction": -5,
      "physical": 100.5,
      "openSalesOrders": 12.3,
      "calculated": 95.5,
      "producible": 4
    },
    "warehouses": [
      {
        "id": "1",
        "physical": 50.5
      },
      {
        "id": "2",
        "physical": 50
      }
    ],
    "salesChannels": [
      {
        "id": "1",
        "isShopActive": true,
        "isProductSalesChannelSettingActive": false,
        "pseudo": 10,
        "correction": -40.5,
        "useIndividualSalesChannelSettings": true,
        "isStockSyncActive": true
      },
      {
        "id": "2",
        "isShopActive": false,
        "isProductSalesChannelSettingActive": true,
        "pseudo": null,
        "correction": null,
        "useIndividualSalesChannelSettings": false,
        "isStockSyncActive": false
      }
    ]
  }
}