Inventory

​

Queries

• binInventoryLevel — Fetch a single bin-level inventory record by its id. List records with binInventoryLevels or StorageLocation.binInventoryLevels.
• binInventoryLevels — List bin-level inventory: the quantity of each product in each storage location, newest first. Pass storageLocationId for one bin’s contents, sku for every bin holding a product, or both. Pass inStock: true to skip empty and negative rows.
• inventoryItem — Fetch a single inventory item by its id.
• inventoryItems — List traceable inventory items, newest first. Pass at least one of storageLocationId, sku, or lotNumber.
• inventoryLevel — Fetch a single inventory level by its id. List levels through Product.inventoryLevels or Location.inventoryLevels.
• location — Fetch a single location by its id.
• locations — List locations.
• searchReplenishmentReports — Search the replenishment report (OpenSearch location bin inventory index) for products at a warehouse location. Narrow results with textSearch on product title, SKU, UPC, or barcodes. Each row includes replenishment status fields such as needsReplenishment and suggestedQuantity. Always scoped to the authenticated account and the requested location.
• storageLocation — Fetch a single storage location by its id.
• storageLocations — List storage locations (bins, totes, and other slots), newest first. Pass locationId, name, or both.

​

Objects

• BinInventoryLevel — On-hand quantity for a product (and optionally a specific inventory item) in a storage location.
• InventoryItem — A traceable unit of inventory (product stock, return, or undeclared goods).
• InventoryProduct — An inventory/fulfillment-oriented view of the product: scoped to what a partner needs to identify and ship it, without exposing all of the owner’s product data.
• Location — A physical or logical location where inventory is held or shipped from.
• LocationInventoryLevel — Inventory levels for a product at a single location.
• ReplenishmentReport — One product at a warehouse location on the replenishment report: pickable and reserve inventory, demand, thresholds, and replenishment status (OpenSearch-backed).
• ReplenishmentReportBin — A warehouse bin and its on-hand quantity on the report row.
• StorageLocation — A bin, tote, staging area, or other slot that holds inventory within a location.

​

Enums

• BinInventoryLevelSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
• InventoryItemClass — Classification of the inventory item record.
• InventoryItemDisposition — Planned disposition for a return unit.
• InventoryItemGrade — Condition grade for return inventory.
• InventoryItemKind — What kind of traceable inventory unit this record represents.
• InventoryItemSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
• LocationSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
• ReplenishmentReportSortKey — Sort key for replenishment report rows (OpenSearch location bin inventory index).
• StorageLocationPriority — Pick priority when multiple bins hold the same product.
• StorageLocationSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
• StorageLocationSource — How the storage location record was created.
• StorageLocationType — The role of a storage location within the warehouse.