inventoryActivate mutation

Version 2020-01 (Release candidate)

Activate an inventory item at a location.

Required access

write_inventory access scope

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

available ( Int )

The initial available quantity at the location.

inventoryItemId ( ID! ) required

Specifies which item should be activated.

locationId ( ID! ) required

Specifies where the item should be activated.

Return fields

inventoryLevel (InventoryLevel)

The newly activated inventory level.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Latest)

Activate an inventory item at a location.

Required access

write_inventory access scope

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

available ( Int )

The initial available quantity at the location.

inventoryItemId ( ID! ) required

Specifies which item should be activated.

locationId ( ID! ) required

Specifies where the item should be activated.

Return fields

inventoryLevel (InventoryLevel)

The newly activated inventory level.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07

Activate an inventory item at a location.

Required access

write_inventory access scope

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

available ( Int )

The initial available quantity at the location.

inventoryItemId ( ID! ) required

Specifies which item should be activated.

locationId ( ID! ) required

Specifies where the item should be activated.

Return fields

inventoryLevel (InventoryLevel)

The newly activated inventory level.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04

Activate an inventory item at a location.

Required access

write_inventory access scope

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

available ( Int )

The initial available quantity at the location.

inventoryItemId ( ID! ) required

Specifies which item should be activated.

locationId ( ID! ) required

Specifies where the item should be activated.

Return fields

inventoryLevel (InventoryLevel)

The newly activated inventory level.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up