Skip to main content

setInventoryPushExclusions

Marks the given SKUs out-of-stock (pushes quantity 0) on the given sales-channel integrations, or resumes pushing real availability when excluded is false. Applies to every (SKU, integration) pair in a single action.

Business Rules​

  • Each integration must belong to the current company and declare the inventory push exclusion capability.
  • Each inventory item must belong to the current company.
  • Excluding is idempotent: re-excluding an already-excluded pair is a no-op, and resuming a pair that is not excluded is a no-op.

Error Scenarios​

  • **BAD_REQUEST**: an integration is unknown, belongs to another company, or does not support inventory push exclusion; or an inventory item is unknown or belongs to another company.
  • **UNAUTHORIZED**: the actor lacks the inventory:set_push_exclusions permission.

Permissions Required​

  • inventory:set_push_exclusions permission
setInventoryPushExclusions(
  input: SetInventoryPushExclusionsInput!
): [InventoryItem!]!

Arguments​

setInventoryPushExclusions.input ● SetInventoryPushExclusionsInput! non-null input common​

Parameters for SetInventoryPushExclusions

Type​

InventoryItem object inventory​

Represents an inventory item that tracks stock quantities and locations for a specific product within a brand's warehouses.

Inventory Calculations​

The inventory system uses a hierarchical structure where:

  • **Physical** = Total units present in the building
  • **Available** = Physical - Reserved (units available for sale)
  • **Stock** = Physical - Unavailable (usable inventory)
  • **Allocated** = Units assigned to specific orders

Warehouse Filtering​

Most quantity fields accept an optional warehouse_id argument to get inventory levels for a specific warehouse. When omitted, returns totals across all active warehouses.

Depth Status​

The depth field indicates stock availability:

  • FULL_STOCK: Available inventory exceeds ordered quantities
  • OUT_OF_STOCK: No available inventory
  • OVERSOLD: Ordered quantities exceed available inventory

Incoming Items​

The incoming_items field shows Shipment items that haven't been closed yet, ordered by expected arrival date (earliest first).