Skip to main content

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. Add locationId to restrict either to one warehouse. Pass inStock: true to skip empty and negative rows.
  • cycleCount (Experimental) — Fetch a single cycle count by its id.
  • cycleCounts (Experimental) — List cycle counts, newest first, optionally filtered by status, warehouse, assignee or date. Filters combine with AND. This reads the database directly, so it is always current: sync from it with updatedAtAfter.
  • cycleCountsSearch (Experimental) — Search cycle counts by text and filters, with the same matching as the Redo app’s cycle count search box: the count’s name, rule, warehouse, and the SKUs, titles and vendors it covers. Results come from a search index and can trail writes by a few seconds; to sync changes, use cycleCounts with updatedAtAfter instead.
  • inventoryContainer (Experimental) — Get a container by ID, optionally within a warehouse. Missing, foreign and removed containers return null.
  • inventoryContainers (Experimental) — List containers in descending ID order. Name matching is case-insensitive and treats punctuation literally.
  • 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.
  • inventoryLevelLedgerEntries — Page inventory ledger rows for one bin-level inventory record (inventoryLevelId) or one source record (exact referenceId), newest first. Same rows as binInventoryLevel { ledgerEntries } when scoped to one inventoryLevelId. To find a bin’s levels first, use storageLocation { binInventoryLevels } or binInventoryLevels(storageLocationId:).
  • inventoryLevelLedgerEntry — Fetch a single ledger row by id. Prefer binInventoryLevel { ledgerEntries } to page history for a bin.
  • 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.
  • transfer (Experimental) — Fetch a single transfer by its id.
  • transfers (Experimental) — List transfers, newest first, optionally filtered by status, origin, destination, number or date. Filters combine with AND. This reads the database directly, so it is always current: sync from it with updatedAtAfter.

Mutations

  • inventoryContainerAddItem (Experimental) — Add a labeled unit or a product quantity to an unplaced container before receiving. This does not change stock. Replaying a request returns the current container without adding again. Reusing a request with different inputs returns IDEMPOTENCY_KEY_REUSED. Placed containers, already received or recorded items, and merchant mismatches return CONTAINER_ALREADY_PLACED, CONTAINER_ITEM_ALREADY_RECEIVED, CONTAINER_ITEM_ALREADY_RECORDED, or CONTAINER_MERCHANT_MISMATCH.
  • inventoryContainerCreate (Experimental) — Create one empty, unplaced container. Reusing a request ID recovers the original container and rejects a changed name or warehouse. Creates no stock or membership.
  • inventoryContainerLabelPrint (Experimental) — Send a label to a printer configured on this account’s workstation. The request UUID deduplicates retries at the print provider. Returns the container after submission, not confirmation of physical printing.
  • inventoryContainerUndoAddItem (Experimental) — Reverse one addition by its request UUID while all its units remain staged. Retrying an undone addition or reversing a fully processed addition leaves the contents unchanged. A partially processed addition returns CONTAINER_ITEM_ADDITION_ALREADY_PROCESSED. A placed container returns CONTAINER_ALREADY_PLACED.

Objects

  • BinInventoryLevel — On-hand quantity for a product (and optionally a specific inventory item) in a storage location.
  • CycleCount (Experimental) — A count of the stock in some of a location’s bins or products, checked against what the system expects.
  • CycleCountPlan (Experimental) — One product or one bin a cycle count covers, with when counting it started and finished. A count’s progress is its plans’ progress.
  • InventoryContainer (Experimental) — A permanently identified container operated by the authenticated warehouse. It can hold items before or after being registered to a bin.
  • InventoryContainerItem (Experimental) — An active entry in a physical container. Separate additions of the same product can be separate entries.
  • InventoryItem — A traceable unit of inventory (product stock, return, or undeclared goods).
  • InventoryLevelLedgerEntry — An append-only ledger row describing a quantity change at a bin-level inventory level.
  • 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.
  • Transfer (Experimental) — A movement of products from one of a store’s locations to another.
  • TransferItem (Experimental) — A quantity of one product that a transfer moves.

Input objects

  • CycleCountFilter (Experimental) — Which cycle counts to include. Fields set side by side must all match; and, or and not nest up to 4 levels and 50 filters in all.

Enums

  • BinInventoryLevelSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
  • CycleCountSearchSortKey (Experimental) — How a cycle count search orders its results; pair with reverse to flip direction.
  • CycleCountSortKey (Experimental) — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
  • CycleCountSource (Experimental) — How a cycle count came to exist.
  • CycleCountStatus (Experimental) — Where a cycle count is in its lifecycle.
  • InventoryContainerLabelSize (Experimental) — The printed label dimensions in inches.
  • InventoryContainerSortKey — 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.
  • InventoryLevelAdjustmentKind — Why an inventory level changed. Each ledger entry records one signed quantity delta.
  • InventoryLevelLedgerEntrySortKey — 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.
  • TransferKind (Experimental) — How a transfer moves its items.
  • TransferSortKey (Experimental) — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
  • TransferStatus (Experimental) — Where a transfer is between being drafted and finished.