Skip to main content
mutation

Requires write_locations access scope.

Activates a location so that you can stock inventory at the location. Refer to the isActive and activatable fields on the Location object.


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.


•ID!
required

The ID of a location to activate.


Was this section helpful?

Anchor to LocationActivatePayload returnsLocationActivatePayload returns

•Location

The location that was activated.

Anchor to locationActivateUserErrorslocationActivateUserErrors
•[LocationActivateUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?