locationActivate

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.

Arguments

Anchor to locationIdlocationId • ID!required: The ID of a location to activate.

Was this section helpful?

Anchor to LocationActivatePayload returnsLocationActivatePayload returns

Anchor to locationlocation • 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?

Activate a deactivated location
locationActivate reference

Examples

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation {

locationActivate(locationId: "gid://shopify/Location/658095763") {

location {

isActive

}

}`,

);

const data = await response.json();

mutation {
  locationActivate(locationId: "gid://shopify/Location/658095763") {
    location {
      id
      isActive
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation { locationActivate(locationId: \"gid://shopify/Location/658095763\") { location { id isActive } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation {
    locationActivate(locationId: "gid://shopify/Location/658095763") {
      location {
        id
        isActive
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `mutation {
    locationActivate(locationId: "gid://shopify/Location/658095763") {
      location {
        id
        isActive
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation {
    locationActivate(locationId: "gid://shopify/Location/658095763") {
      location {
        id
        isActive
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"locationActivate": {

"location": {

"id": "gid://shopify/Location/658095763",

"isActive": true

}