Skip to navigation
API ReferenceInventory

Get Inventory Levels by Channel

View as Markdown

Retrieves the aggregated inventory levels for a specific inventory item across all locations, including available, on-hand, committed, and other quantity types.

This version adds the per-channel split of sellable inventory: b2b_reservation_quantity, b2b_sellable_quantity and d2c_sellable_quantity. These fields are returned only for merchants where feature flag PIX.GIS.B2bInventoryReservation is enabled. For other merchants the fields are omitted from the response.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

inventoryIdintegerRequired

Response

OK
b2b_reservation_quantityinteger or nullOptional

Quantity the merchant has reserved for the B2B channel. Null when no value has been stored; after a reservation is cleared with PUT /inventory:setB2bReservationQuantity, this field is 0. Returned only when feature flag PIX.GIS.B2bInventoryReservation is enabled for the merchant. Otherwise the field is omitted from the response.

b2b_sellable_quantityintegerOptional

Sellable quantity assigned to the B2B channel. Equals b2b_reservation_quantity, or 0 when no reservation is set. Returned only when feature flag PIX.GIS.B2bInventoryReservation is enabled for the merchant. Otherwise the field is omitted from the response.

d2c_sellable_quantityintegerOptional
Sellable quantity assigned to the D2C channel. Equals the total sellable quantity minus the B2B reservation, with a minimum of 0. Returned only when feature flag PIX.GIS.B2bInventoryReservation is enabled for the merchant. Otherwise the field is omitted from the response.
inventory_idintegerOptional
Unique identifier for the inventory item
namestring or nullOptional
Name of the inventory item
skustring or nullOptional
Stock keeping unit identifier
total_awaiting_quantityintegerOptional
Total quantity expected to arrive from receiving or transfers
total_backordered_quantityintegerOptional
Total quantity on backorder for pending shipments
total_committed_quantityintegerOptional
Total quantity reserved for existing orders and allocations
total_damaged_quantityintegerOptional
Total quantity currently marked as damaged
total_exception_quantityintegerOptional

Total quantity in exception status (damaged, lost, or under investigation)

total_fulfillable_quantityintegerOptional

Total quantity available to fulfill new orders (on-hand minus committed)

total_in_fulfillment_quantityintegerOptional
Total quantity of inventory items that are currently in the fulfillment process
total_internal_transfer_quantityintegerOptional
Total quantity currently in transit between fulfillment centers
total_on_hand_quantityintegerOptional
Total quantity physically present in all fulfillment centers
total_quarantine_quantityintegerOptional
Total quantity currently in quarantine status
total_sellable_quantityintegerOptional

Total quantity available for sale across all channels (fulfillable plus awaiting minus quarantine minus damaged). It is not split by channel. Use d2c_sellable_quantity and b2b_sellable_quantity for the channel view.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error