List inventories · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/ListInventories

Returns one row per product and warehouse. Both filters are optional. Without filters, you get every product in every warehouse.

Request body

productstring

Only return this product. Bundle IDs aren't accepted.

Pattern^([A-Za-z0-9]{4}-[A-Za-z0-9]{6}-[A-Za-z0-9]{4}|)$

warehousestring

Only return this warehouse.

Pattern^([A-Za-z]{2}-[A-Za-z]{3}-[0-9]{3}|)$

page_sizeintegerdefault 1000

Rows per page.

Maximum 1,000

page_tokenstring

The next_page_token from the previous response.

Responses

200A page of inventory rows.

inventoriesInventory[]

One row per product and warehouse.

next_page_tokenstring

Token for the next page. Missing on the last page.

Inventory

productstring

Product ID.

Pattern^[A-Za-z0-9]{4}-[A-Za-z0-9]{6}-[A-Za-z0-9]{4}$

warehousestring

Warehouse ID.

Pattern^[A-Za-z]{2}-[A-Za-z]{3}-[0-9]{3}$

availableinteger

Units you can sell now.

in_warehouseinteger

Good units in the warehouse, including reserved units.

damagedinteger

Damaged units.

quality_controlinteger

Units held for inspection.

expiredinteger

Expired units.

backorderedinteger

Units ordered that stock couldn't cover.

lotsInventory.Lot[]

Counts per lot. Up to 100 lots.

See Stock counts for details.

400A filter is invalid or page_size is above 1000.

{
  "code": "invalid_argument",
  "msg": "page_size value must be less than or equal to 1000",
  "meta": { "argument": "page_size" }
}

POST/bigblue.storeapi.v1.PublicAPI/ListInventories

Request: all stock

{ "page_size": 1000 }

Request: one product in one warehouse

{ "product": "BGBL-COFBEA-1KGX", "warehouse": "FR-CDG-001" }

200: lot-tracked product

{
  "inventories": [
    {
      "product": "BGBL-COFBEA-1KGX",
      "warehouse": "FR-CDG-001",
      "available": 348,
      "in_warehouse": 372,
      "damaged": 4,
      "quality_control": 480,
      "expired": 12,
      "lots": [
        {
          "lot_code": "L2026-02",
          "lot_expiration_date": "2027-02-28",
          "in_warehouse": 372,
          "damaged": 4,
          "expired": 12
        },
        {
          "lot_code": "L2026-04",
          "lot_expiration_date": "2027-04-30",
          "quality_control": 480
        }
      ]
    }
  ]
}

All units in lot L2026-04 are in quality control, so they aren't available.