API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

inventoryActivate mutation

Version unstable

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 2021-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 2020-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 2020-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 2020-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.

Version 2020-01

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 (Unsupported)

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 (Unsupported)

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 (Unsupported)

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.