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

inventoryItemUpdate mutation

Version unstable

Updates an inventory item.

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

id ( ID! ) required

The ID of the inventory item to update.

input ( InventoryItemUpdateInput! ) required

The updated properties for the inventory item.

InventoryItemUpdateInput fields

cost (Decimal)

Unit cost associated with the inventory item, the currency is the shop's default currency.

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

countryHarmonizedSystemCodes ([CountryHarmonizedSystemCodeInput!])

List of country-specific harmonized system codes.

harmonizedSystemCode (String)

The harmonized system code of the inventory item.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

tracked (Boolean)

Whether the inventory item is tracked.

Return fields

inventoryItem (InventoryItem)

The updated inventory item.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Updates an inventory item.

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

id ( ID! ) required

The ID of the inventory item to update.

input ( InventoryItemUpdateInput! ) required

The updated properties for the inventory item.

InventoryItemUpdateInput fields

cost (Decimal)

Unit cost associated with the inventory item, the currency is the shop's default currency.

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

countryHarmonizedSystemCodes ([CountryHarmonizedSystemCodeInput!])

List of country-specific harmonized system codes.

harmonizedSystemCode (String)

The harmonized system code of the inventory item.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

tracked (Boolean)

Whether the inventory item is tracked.

Return fields

inventoryItem (InventoryItem)

The updated inventory item.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-10 (Latest)

Updates an inventory item.

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

id ( ID! ) required

The ID of the inventory item to update.

input ( InventoryItemUpdateInput! ) required

The updated properties for the inventory item.

InventoryItemUpdateInput fields

cost (Decimal)

Unit cost associated with the inventory item, the currency is the shop's default currency.

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

countryHarmonizedSystemCodes ([CountryHarmonizedSystemCodeInput!])

List of country-specific harmonized system codes.

harmonizedSystemCode (String)

The harmonized system code of the inventory item.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

tracked (Boolean)

Whether the inventory item is tracked.

Return fields

inventoryItem (InventoryItem)

The updated inventory item.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-07

Updates an inventory item.

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

id ( ID! ) required

The ID of the inventory item to update.

input ( InventoryItemUpdateInput! ) required

The updated properties for the inventory item.

InventoryItemUpdateInput fields

cost (Decimal)

Unit cost associated with the inventory item, the currency is the shop's default currency.

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

countryHarmonizedSystemCodes ([CountryHarmonizedSystemCodeInput!])

List of country-specific harmonized system codes.

harmonizedSystemCode (String)

The harmonized system code of the inventory item.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

tracked (Boolean)

Whether the inventory item is tracked.

Return fields

inventoryItem (InventoryItem)

The updated inventory item.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-04

Updates an inventory item.

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

id ( ID! ) required

The ID of the inventory item to update.

input ( InventoryItemUpdateInput! ) required

The updated properties for the inventory item.

InventoryItemUpdateInput fields

cost (Decimal)

Unit cost associated with the inventory item, the currency is the shop's default currency.

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

countryHarmonizedSystemCodes ([CountryHarmonizedSystemCodeInput!])

List of country-specific harmonized system codes.

harmonizedSystemCode (String)

The harmonized system code of the inventory item.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

tracked (Boolean)

Whether the inventory item is tracked.

Return fields

inventoryItem (InventoryItem)

The updated inventory item.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-01

Updates an inventory item.

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

id ( ID! ) required

The ID of the inventory item to update.

input ( InventoryItemUpdateInput! ) required

The updated properties for the inventory item.

InventoryItemUpdateInput fields

cost (Decimal)

Unit cost associated with the inventory item, the currency is the shop's default currency.

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

countryHarmonizedSystemCodes ([CountryHarmonizedSystemCodeInput!])

List of country-specific harmonized system codes.

harmonizedSystemCode (String)

The harmonized system code of the inventory item.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

tracked (Boolean)

Whether the inventory item is tracked.

Return fields

inventoryItem (InventoryItem)

The updated inventory item.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Updates an inventory item.

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

id ( ID! ) required

The ID of the inventory item to update.

input ( InventoryItemUpdateInput! ) required

The updated properties for the inventory item.

InventoryItemUpdateInput fields

cost (Decimal)

Unit cost associated with the inventory item, the currency is the shop's default currency.

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

countryHarmonizedSystemCodes ([CountryHarmonizedSystemCodeInput!])

List of country-specific harmonized system codes.

harmonizedSystemCode (String)

The harmonized system code of the inventory item.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

tracked (Boolean)

Whether the inventory item is tracked.

Return fields

inventoryItem (InventoryItem)

The updated inventory item.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Updates an inventory item.

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

id ( ID! ) required

The ID of the inventory item to update.

input ( InventoryItemUpdateInput! ) required

The updated properties for the inventory item.

InventoryItemUpdateInput fields

cost (Decimal)

Unit cost associated with the inventory item, the currency is the shop's default currency.

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

countryHarmonizedSystemCodes ([CountryHarmonizedSystemCodeInput!])

List of country-specific harmonized system codes.

harmonizedSystemCode (String)

The harmonized system code of the inventory item.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

tracked (Boolean)

Whether the inventory item is tracked.

Return fields

inventoryItem (InventoryItem)

The updated inventory item.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Updates an inventory item.

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

id ( ID! ) required

The ID of the inventory item to update.

input ( InventoryItemUpdateInput! ) required

The updated properties for the inventory item.

InventoryItemUpdateInput fields

cost (Decimal)

Unit cost associated with the inventory item, the currency is the shop's default currency.

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

countryHarmonizedSystemCodes ([CountryHarmonizedSystemCodeInput!])

List of country-specific harmonized system codes.

harmonizedSystemCode (String)

The harmonized system code of the inventory item.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

tracked (Boolean)

Whether the inventory item is tracked.

Return fields

inventoryItem (InventoryItem)

The updated inventory item.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.