Anchor to section titled 'undefined'

locationActivate
mutation

Requires write_locations access scope.

Activates a location.

Anchor to section titled 'Arguments'

Arguments

Anchor to locationId
locationId
ID!
required

The ID of a location to activate.

Was this section helpful?
Anchor to section titled 'LocationActivatePayload returns'

LocationActivatePayload returns

Anchor to LocationActivatePayload.location
location
Location

The location that was activated.

Anchor to LocationActivatePayload.locationActivateUserErrors
locationActivateUserErrors
[LocationActivateUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Hide code
Copy
mutation {
  locationActivate(locationId: "gid://shopify/Location/658095763") {
    location {
      id
      isActive
    }
  }
}
Hide code
Response
JSON
{
  "locationActivate": {
    "location": {
      "id": "gid://shopify/Location/658095763",
      "isActive": true
    }
  }
}