Skip to main content
Anchor to LocationDeactivatePayload

LocationDeactivatePayload

payload

Return type for locationDeactivate mutation.

•Location

The location that was deactivated.

Anchor to locationDeactivateUserErrorslocationDeactivateUserErrors
•[LocationDeactivateUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Deactivates a location and moves inventory, pending orders, and moving transfers " "to a destination location.


Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.


Arguments

•ID!
required

The ID of a location to deactivate.

Anchor to destinationLocationIddestinationLocationId
•ID

The ID of a destination location to which inventory, pending orders and moving transfers will be moved from the location to deactivate.



Was this section helpful?