RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Admin / POS

inventory_level

Per-location stock for a variant.

Available / onHand / committed / incoming for a variant at a shop_location. Unique on (variantId, locationId).

Exposure

Used in Admin, POS, or Storefront. Not exposed on Merchant API v1 routes yet.

What

The inventory_level object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

8 fields on inventory_level. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Inventory level id.

Type
id: string

available

number

Sellable quantity at the location.

Type
available: number

onHand

number

Physical on-hand quantity.

Type
onHand: number

committed

number

Quantity reserved for open orders.

Type
committed: number

incoming

number

Quantity expected from purchase orders / transfers.

Type
incoming: number

variantId

string

Variant id.

Type
variantId: string

locationId

string

ShopLocation id.

Type
locationId: string

updatedAt

string

ISO-8601 last update.

Type
updatedAt: string

Related