inventoryActivate mutation

Activate an inventory item at a location.

Required access

write_inventory access scope.

On this page

Interactive example

This is an example mutation query.

mutation inventoryActivate($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { 
  1. <font style="color:#1F61A0;">inventoryLevel</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
} } { “inventoryItemId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “locationId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=” }

Arguments

Argument Description
available
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 The initial available quantity at the location.
inventoryItemId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 Specifies which item should be activated.
locationId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 Specifies where the item should be activated.

Return fields

  • inventoryLevel ([InventoryLevel](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventorylevel))
    The newly activated inventory level.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.