Retrieve Item Inventory

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

This endpoint is idempotent. Learn more

Returns the stock position for an item: what is on hand, what is reserved against existing orders, what is free to promise, and what is short.

Stock your account either owns or holds counts toward the on-hand figure, so customer-supplied material sitting in your facility is included. All four quantities are reported in the base unit of the item's category.

Permission requiredValues:items:read
The role behind your API key or agent must grant this permission.
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_handcomputed_quantityExpandablenullable

Physical quantity currently in stock.

objectstringenumValues:computed_quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering.

display_valuestring

Formatted value with unit abbreviation (e.g. "1,200 pr").

unitunitnullable

Unit of measure for this value.

Resolved in full rather than expandable: a computed quantity is not a stored row a caller could fetch on its own, so the unit it is counted in travels with it. Null only where the figure was derived without a unit record behind it.

Always returned as null in this endpoint.
reservedcomputed_quantityExpandablenullable

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

objectstringenumValues:computed_quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering.

display_valuestring

Formatted value with unit abbreviation (e.g. "1,200 pr").

unitunitnullable

Unit of measure for this value.

Resolved in full rather than expandable: a computed quantity is not a stored row a caller could fetch on its own, so the unit it is counted in travels with it. Null only where the figure was derived without a unit record behind it.

Always returned as null in this endpoint.
available_to_promisecomputed_quantityExpandablenullable

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

objectstringenumValues:computed_quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering.

display_valuestring

Formatted value with unit abbreviation (e.g. "1,200 pr").

unitunitnullable

Unit of measure for this value.

Resolved in full rather than expandable: a computed quantity is not a stored row a caller could fetch on its own, so the unit it is counted in travels with it. Null only where the figure was derived without a unit record behind it.

Always returned as null in this endpoint.
shortcomputed_quantityExpandablenullable

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

objectstringenumValues:computed_quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering.

display_valuestring

Formatted value with unit abbreviation (e.g. "1,200 pr").

unitunitnullable

Unit of measure for this value.

Resolved in full rather than expandable: a computed quantity is not a stored row a caller could fetch on its own, so the unit it is counted in travels with it. Null only where the figure was derived without a unit record behind it.

Always returned as null in this endpoint.

Responses

200

Successful response for Retrieve Item Inventory