Retrieve Item Inventory

Beta
GET/v1/catalog/items/{id}/inventory

This endpoint is idempotent. Learn more

Returns inventory quantities for an item, including on-hand, reserved, available-to-promise, and short amounts.

Permissions requiredValues:items:read
The role behind your API key or agent must grant every one of these permissions.
idstring

Item ID.

include[]optional arrayenumValues:on_handreservedavailable_to_promise

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:item_inventory

Resource type identifier.

on_handquantityExpandablenullable

Physical quantity currently in stock.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

Always returned as null in this endpoint.
reservedquantityExpandablenullable

Quantity committed to existing orders and therefore not free to allocate.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

Always returned as null in this endpoint.
available_to_promisequantityExpandablenullable

Quantity free to commit to new orders, i.e. on-hand minus reserved minus short.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

Always returned as null in this endpoint.
shortquantityExpandablenullable

Quantity by which demand exceeds available supply (the unfulfillable shortfall).

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

Always returned as null in this endpoint.

Responses

200

Successful response for Retrieve Item Inventory