Get All Inventory Levels by Channel | ShipBob Developer API

curl -G https://sandbox-api.shipbob.com/Experimental/inventory-level/channels \
     -H "Authorization: Bearer <token>" \
     -d SearchBy=string \
     -d InventoryIds=0 \
     -d IsActive=true \
     -d IsDigital=true \
     -d SortBy=string \
     -d has_quarantine=true

{
  "first": "string",
  "items": [
    {
      "b2b_reservation_quantity": 0,
      "b2b_sellable_quantity": 0,
      "d2c_sellable_quantity": 0,
      "inventory_id": 0,
      "name": "string",
      "sku": "string",
      "total_awaiting_quantity": 0,
      "total_backordered_quantity": 0,
      "total_committed_quantity": 0,
      "total_damaged_quantity": 0,
      "total_exception_quantity": 0,
      "total_fulfillable_quantity": 0,
      "total_in_fulfillment_quantity": 0,
      "total_internal_transfer_quantity": 0,
      "total_on_hand_quantity": 0,
      "total_quarantine_quantity": 0,
      "total_sellable_quantity": 0
    }
  ],
  "last": "string",
  "next": "string",
  "prev": "string"
}

Retrieves current inventory levels across all locations. Returns available, on-hand, committed, and other quantity types. Supports filtering by inventory IDs, product attributes, and quarantine status.

This version adds the per-channel split of sellable inventory: b2b_reservation_quantity, b2b_sellable_quantity and d2c_sellable_quantity. b2b_sellable_quantity is the quantity the merchant reserved for B2B (0 when none is set). d2c_sellable_quantity is the sellable quantity left for D2C after the B2B reservation, with a minimum of 0. Set the reservation with PUT /inventory:setB2bReservationQuantity. This operation is the channel-aware version of Get All Inventory Levels (GET /inventory-level). These three fields are returned only for merchants where feature flag PIX.GIS.B2bInventoryReservation is enabled. For other merchants the fields are omitted from the response. There is no request parameter that filters by channel. Both channels are returned in each item.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Query parameters

SearchBystringOptional

Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).

InventoryIdslist of integersOptional

Comma-separated list of inventory IDs to filter results. Use this to retrieve inventory levels for specific inventory items only.

IsActivebooleanOptional

Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status.

IsDigitalbooleanOptional

Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment.

PageSizeintegerOptional

Number of inventory level items to return per page. Controls pagination size for the response.

SortBystringOptional

Sort results by field name. Results are returned in ascending order by default; append ’ desc’ to a field for descending order (e.g., ‘total_on_hand_quantity desc’ sorts by quantity descending).

has_quarantinebooleanOptional

Set to true to return only inventory with a positive quarantine quantity. False behaves the same as omitting the parameter.

Response

firststring or nullOptional

URL to retrieve the first page of results. Null if already on the first page.

itemslist of objects or nullOptional

Array of inventory quantity items in the current page of results.

laststring or nullOptional

URL to retrieve the last page of results. Null if already on the last page.

nextstring or nullOptional

URL to retrieve the next page of results. Null if on the last page.

prevstring or nullOptional

URL to retrieve the previous page of results. Null if on the first page.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

503

Service Unavailable Error