Get Location Inventory

Get product inventory. You can provide up to a maximum of 200 product codes and 200 location codes in the endpoint by default.

GET /commerce/catalog/storefront/products/{productCode}/locationinventory

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "bopisFulfillmentDate": "2023-11-07T05:31:56Z",
      "bopisProcessingTimeHours": 123,
      "futureInventories": [
        {
          "allocated": 123,
          "available": 123,
          "bopisProcessingTimeDate": 123,
          "bopisProcessingTimeHours": 123,
          "createDate": "2023-11-07T05:31:56Z",
          "deliveryDate": "2023-11-07T05:31:56Z",
          "futureInventoryID": 123,
          "onhand": 123,
          "pending": 123,
          "sthFulfillmentDate": "2023-11-07T05:31:56Z",
          "sthProcessingTimeHours": 123,
          "transferFulfillmentDate": "2023-11-07T05:31:56Z",
          "transferProcessingTimeHours": 123
        }
      ],
      "locationCode": "<string>",
      "mfgPartNumber": "<string>",
      "productCode": "<string>",
      "segmentedQuantities": [
        {
          "bopisFulfillmentDate": "2023-11-07T05:31:56Z",
          "bopisProcessingTimeHours": 123,
          "futureInventory": [
            {
              "allocated": 123,
              "available": 123,
              "bopisProcessingTimeDate": 123,
              "bopisProcessingTimeHours": 123,
              "createDate": "2023-11-07T05:31:56Z",
              "deliveryDate": "2023-11-07T05:31:56Z",
              "futureInventoryID": 123,
              "onhand": 123,
              "pending": 123,
              "sthFulfillmentDate": "2023-11-07T05:31:56Z",
              "sthProcessingTimeHours": 123,
              "transferFulfillmentDate": "2023-11-07T05:31:56Z",
              "transferProcessingTimeHours": 123
            }
          ],
          "isAvailable": true,
          "quantity": 123,
          "sthFulfillmentDate": "2023-11-07T05:31:56Z",
          "sthProcessingTimeHours": 123,
          "tags": [
            {
              "category": "<string>",
              "tag": "<string>"
            }
          ],
          "transferFulfillmentDate": "2023-11-07T05:31:56Z",
          "transferProcessingTimeHours": 123
        }
      ],
      "sku": "<string>",
      "softStockAvailable": 123,
      "sthFulfillmentDate": "2023-11-07T05:31:56Z",
      "sthProcessingTimeHours": 123,
      "stockAvailable": 123,
      "transferFulfillmentDate": "2023-11-07T05:31:56Z",
      "transferProcessingTimeHours": 123
    }
  ],
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

productCode · string · required

Query Parameters

locationCodes · string

includeFutureInventory · boolean · default: false

includeSegmentedInventory · boolean · default: false

serialNumber · string

condition · string

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

items · object[] | null

Show child attributes

totalCount · integer<int32>