inventoryDeactivate mutation

Deactivate an inventory item at a location.

Required access

write_inventory access scope.

On this page

Interactive example

This is an example mutation query.

mutation inventoryDeactivate($inventoryLevelId: ID!) { inventoryDeactivate(inventoryLevelId: $inventoryLevelId) { 
  1. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">field</font>
  5.   <font style="color:#1F61A0;">message</font>
  7. <font style="color:#555555;">}</font>
} } { “inventoryLevelId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=” }

Arguments

Argument Description
inventoryLevelId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 Specifies which inventory level should be deactivated.

Return fields

  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.