InventoryAdjustQuantitiesInput

input

Input fields required for adjusting inventory quantity.

Fields

name ● String!non-null

The name of the quantity to adjust.

Inventory state	Description
available	The inventory that a merchant can sell. Available inventory isn’t committed to any orders and isn’t part of incoming transfers.
on_hand	The total number of units that are physically at a location. The `on_hand` state equals the sum of inventory quantities that are in the `available`, `committed` and `unavailable` states.

reason ● String!non-null

The cause of the quantity change.

Reason	Description
correction	Used to correct an inventory error or as a general adjustment reason.
cycle_count_available	Used to specify an adjusted inventory count due to a discrepancy between the actual inventory quantity and previously recorded inventory quantity.
damaged	Used to remove units from inventory count due to damage.
other	Used to specify an alternate reason for the inventory adjustment.
promotion	Used to remove units from inventory count due to a promotion or donation.
received	Used to specify inventory that the merchant received.
restock	Used to add a returned unit back to available inventory so the unit can be resold.
shrinkage	Used when actual inventory levels are less than recorded due to theft or loss.

Inventory quantity changes at specific locations.

Status and error codes

For detailed information about common codes, see Status and error codes.

Map

Argument from

InventoryAdjustQuantitiesInput

Was this article helpful to you?

SHOPLINE

SHOPLINE

Legal

Privacy