Choose a version:

InventoryActivatePayload

payload

Return type for inventoryActivate mutation.

Anchor to FieldsFields

Anchor to inventoryLevelinventoryLevel •InventoryLevel: The inventory level that was activated.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to inventoryActivate inventoryActivate •mutation: Activates an inventory item at a Location by creating an InventoryLevel that tracks stock quantities. This enables you to manage inventory for a ProductVariant at the specified location.

When you activate an inventory item, you can set its initial quantities. The available argument sets the quantity that's available for sale. onHand argument sets the total physical quantity at the location. If you don't specify quantities, then available and onHand default to zero.

Caution
As of version 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of version 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.
Learn more about managing inventory quantities and states.

Was this section helpful?