API ReferenceInventory

Get Inventory

View as Markdown
Retrieves detailed information about a specific inventory item by its ID, including product details, variant information, and associated metadata.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

inventoryIdintegerRequired
Unique identifier for the inventory item to retrieve. This ID is returned when listing all inventories and is used to fetch detailed information about a specific inventory item.

Response

OK
barcodestringOptional
Barcode associated with the inventory item
dimensionsobjectOptional
Physical dimensions of the inventory item
inventory_idintegerOptional
Unique identifier for the inventory item
is_casebooleanOptional
Indicates if the inventory item is stored in cases
is_lotbooleanOptional
Indicates if the inventory item is tracked by lot number
namestringOptional
Name of the inventory item
skustringOptional
Stock keeping unit identifier
user_idintegerOptional
User ID associated with this inventory item
variantobjectOptional
Variant details including active status and product characteristics
weightobjectOptional
Weight information of the inventory item

Errors

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