Get Inventory
GET /inventory/items/{sku} query bearer
Returns available, reserved, and allocated quantities for a given SKU across all locations.
Overview
|
|
| ID |
get-inventory-api |
| Method |
GET |
| Path |
/inventory/items/{sku} |
| Classification |
query |
| Domain |
inventory |
| Capability |
inventory-visibility |
| Service |
retrieve-location-stock |
| Application |
sim — SIM |
| Auth |
bearer |
Response
|
|
| Business Object |
inventory-item |
| Description |
Item-level inventory reference used by basket, order, shipment, reservation, and allocation records. |
Scenarios using inventory-visibility
| 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 |
Related APIs — inventory domain