API ReferenceInventory

Get an inventory item

View as Markdown

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

inventoryIdstringRequiredformat: "int32"
The inventory id to get

Response

Success
dimensionsobjectOptional
Information about an inventory item's dimensions
fulfillable_quantity_by_fulfillment_centerlist of objects or nullOptional
Fulfillable quantity of this inventory item broken down by fulfillment center location
fulfillable_quantity_by_lotlist of objects or nullOptional
Fulfillable quantity of this inventory item broken down by lot
idintegerOptional
Unique id of the inventory item
is_activebooleanOptional
Whether the inventory is active or not
is_case_pickbooleanOptional
True if the inventory item is marked as case pick
is_digitalbooleanOptional
True if the inventory item is marked as a digital item
is_lotbooleanOptional
True if this inventory item is organized into lots
namestring or nullOptional
Name of the inventory item
packaging_attributeenumOptional
total_awaiting_quantityintegerOptional
Total quantity in unreceived receiving orders for this inventory item
total_backordered_quantityintegerOptional

The amount of the item you need to send to ShipBob to fulfill all exception orders containing the item. This is the exception_quantity less the fulfillable_quantity of the item.

total_committed_quantityintegerOptional
Total committed quantity of this inventory item
total_exception_quantityintegerOptional

The total quantity of all items that are contained within orders that are in exception/out of stock status. Out of stock orders have not been processed and therefore do not have lot or fulfillment centers assigned.

total_fulfillable_quantityintegerOptional
Total fulfillable quantity of this inventory item
total_internal_transfer_quantityintegerOptional
The total quantity of all items that are in the process of internal transit between ShipBob fulfillment centers. These items are not pickable or fulfillable until they have been received and moved to the "On Hand" quantity of the destination FC. Internal transit quantities for each FC represent the incoming transfer stock for that specific location.
total_onhand_quantityintegerOptional
Total onhand quantity of this inventory item
total_sellable_quantityintegerOptional
Total quantity that can be sold without overselling the inventory item. This is calculated by subtracting the total exception quantity from the fulfillable quantity.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error