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
barcodestring
Barcode associated with the inventory item
dimensionsobject
Physical dimensions of the inventory item
inventory_idinteger
Unique identifier for the inventory item
is_caseboolean
Indicates if the inventory item is stored in cases
is_lotboolean
Indicates if the inventory item is tracked by lot number
namestring
Name of the inventory item
skustring
Stock keeping unit identifier
user_idinteger
User ID associated with this inventory item
variantobject
Variant details including active status and product characteristics
weightobject
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