Check Availability¶

GET /inventory/{sku}/availability query bearer

Returns real-time ATP (Available-to-Promise) quantity for a SKU across all nodes, with per-location breakdown.

Overview¶


ID	`check-availability-api`
Method	`GET`
Path	`/inventory/{sku}/availability`
Classification	`query`
Domain	`inventory`
Capability	`inventory-visibility`
Service	`check-availability`
Application	`inventory-service` — Inventory Service
Auth	`bearer`


Business Object	`inventory-item`
Description	Item-level inventory reference used by basket, order, shipment, reservation, and allocation records.

Pattern	Flow	Style	Description
eCommerce Platform → SIM Availability Check	`ecommerce-platform` → `sim`	`synchronous-api`	The eCommerce Platform queries the SIM for real-time ATP before displaying stock availability on product pages and at basket add.
POS → SIM Stock Lookup	`pos` → `sim`	`synchronous-api`	Associates can look up real-time stock levels for a product at the POS, including availability at other stores for BOPIS and ship-from-store.
SIM → Inventory Service ATP Calculation	`sim` → `inventory-service`	`synchronous-api`	The SIM delegates ATP calculation and allocation logic to the Inventory Service, which applies network-wide optimisation rules across all nodes.

Scenario	Description
`Buy Online, Pick Up In Store`	Customer browses and purchases online, then collects the order from a physical store. The canonical
`Buy Online, Return In Store`	Customer purchased online (any channel) and returns the item at a physical store. The store processe
`Clienteling Sale`	A store associate uses a clienteling application to identify a known customer, review their purchase
`Endless Aisle`	Store associate helps a customer order an item that is not physically stocked in the current store b
`Exchange Anywhere`	Customer exchanges an item purchased in any channel at any supported touchpoint. The original item i
`Ship From Store`	An online order is fulfilled by shipping the goods directly from a physical store rather than a cent
`Unified Return`	Customer returns an item regardless of the original purchase channel. The return may be initiated on

API	Method	Path	Type
`Get Inventory`	`GET`	`/inventory/items/{sku}`	`query`
`Reserve Inventory`	`POST`	`/inventory/reservations`	`command`
`Confirm Reservation`	`POST`	`/inventory/reservations/{id}/confirm`	`action`
`Release Reservation`	`DELETE`	`/inventory/reservations/{id}`	`action`
`Get Stock Locations`	`GET`	`/stock/{sku}/locations`	`query`
`Allocate Inventory`	`POST`	`/inventory/allocate`	`command`