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.

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_handobjectExpandablenullable

On-hand quantity. Expandable via include[]=on_hand.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Decimal value.

display_valuestring

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

unitobjectnullable

Associated unit.

Always returned as null in this endpoint.

reservedobjectExpandablenullable

Reserved quantity. Expandable via include[]=reserved.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Decimal value.

display_valuestring

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

unitobjectnullable

Associated unit.

Always returned as null in this endpoint.

available_to_promiseobjectExpandablenullable

Available-to-promise quantity. Expandable via include[]=available_to_promise.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Decimal value.

display_valuestring

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

unitobjectnullable

Associated unit.

Always returned as null in this endpoint.

shortobjectExpandablenullable

Short quantity. Expandable via include[]=short.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Decimal value.

display_valuestring

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

unitobjectnullable

Associated unit.

Always returned as null in this endpoint.

Responses

200

Successful response for Retrieve Item Inventory

Retrieve Item Inventory

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const itemInventory = await client.catalog.items.retrieveInventory('it_0131e386ac683e8c29a71f6f1f');

console.log(itemInventory.available_to_promise);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const itemInventory = await client.catalog.items.retrieveInventory('it_0131e386ac683e8c29a71f6f1f');

console.log(itemInventory.available_to_promise);

200 example

{
  "object": "item_inventory",
  "on_hand": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "reserved": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "available_to_promise": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "short": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  }
}

{
  "object": "item_inventory",
  "on_hand": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "reserved": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "available_to_promise": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "short": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  }
}

Retrieve Item Inventory

Path Parameters

Query Parameters

Returns

Responses