Choose a version:

locationDeactivate

mutation

Requires write_locations access scope.

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.

Anchor to Arguments

Arguments

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.
Anchor to locationIdlocationId •ID! required: The ID of a location to deactivate.

Was this section helpful?

Anchor to LocationDeactivatePayload returnsLocationDeactivatePayload returns

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

Examples

Deactivate a location with active inventory

Description

Deactivating a location with inventory without specifying a destination location returns an error.

Query

mutation locationDeactivate {
  locationDeactivate(locationId: "gid://shopify/Location/922479430") {
    location {
      id
      isActive
    }
    locationDeactivateUserErrors {
      message
      code
      field
    }
  }
}

cURL

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

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation locationDeactivate {
    locationDeactivate(locationId: "gid://shopify/Location/922479430") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 locationDeactivate {
    locationDeactivate(locationId: "gid://shopify/Location/922479430") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `mutation locationDeactivate {
    locationDeactivate(locationId: "gid://shopify/Location/922479430") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }`,
});

Response

{
  "locationDeactivate": {
    "location": {
      "id": "gid://shopify/Location/922479430",
      "isActive": true
    },
    "locationDeactivateUserErrors": [
      {
        "message": "Location could not be deactivated without specifying where to relocate inventory stocked at the location.",
        "code": "HAS_ACTIVE_INVENTORY_ERROR",
        "field": [
          "locationId"
        ]
      }
    ]
  }
}

Deactivate a location with pending orders

Description

Deactivating a location with pending orders without specifying a destination location returns an error

Query

mutation locationDeactivate {
  locationDeactivate(locationId: "gid://shopify/Location/123") {
    location {
      id
      isActive
    }
    locationDeactivateUserErrors {
      message
      code
      field
    }
  }
}

cURL

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

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation locationDeactivate {
    locationDeactivate(locationId: "gid://shopify/Location/123") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 locationDeactivate {
    locationDeactivate(locationId: "gid://shopify/Location/123") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `mutation locationDeactivate {
    locationDeactivate(locationId: "gid://shopify/Location/123") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }`,
});

Response

{
  "locationDeactivate": {
    "location": null,
    "locationDeactivateUserErrors": [
      {
        "message": "Location could not be deactivated because it has open purchase orders.",
        "code": "HAS_OPEN_PURCHASE_ORDERS_ERROR",
        "field": [
          "locationId"
        ]
      }
    ]
  }
}

Deactivate an active location

Description

Deactivates a location and transfers inventory, pending orders, and transfers to another location

Query

mutation {
  locationDeactivate(locationId: "gid://shopify/Location/922479430", destinationLocationId: "gid://shopify/Location/147921425") {
    location {
      id
      isActive
    }
    locationDeactivateUserErrors {
      message
      code
      field
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation { locationDeactivate(locationId: \"gid://shopify/Location/922479430\", destinationLocationId: \"gid://shopify/Location/147921425\") { location { id isActive } locationDeactivateUserErrors { message code field } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation {
    locationDeactivate(locationId: "gid://shopify/Location/922479430", destinationLocationId: "gid://shopify/Location/147921425") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 {
    locationDeactivate(locationId: "gid://shopify/Location/922479430", destinationLocationId: "gid://shopify/Location/147921425") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `mutation {
    locationDeactivate(locationId: "gid://shopify/Location/922479430", destinationLocationId: "gid://shopify/Location/147921425") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }`,
});

Response

{
  "locationDeactivate": {
    "location": {
      "id": "gid://shopify/Location/922479430",
      "isActive": false
    },
    "locationDeactivateUserErrors": []
  }
}

locationDeactivate reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation locationDeactivate {

locationDeactivate(locationId: "gid://shopify/Location/922479430") {

location {

isActive

}

locationDeactivateUserErrors {

message

code

field

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

mutation locationDeactivate {
  locationDeactivate(locationId: "gid://shopify/Location/922479430") {
    location {
      id
      isActive
    }
    locationDeactivateUserErrors {
      message
      code
      field
    }
  }
}

cURL

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

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation locationDeactivate {
    locationDeactivate(locationId: "gid://shopify/Location/922479430") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `mutation locationDeactivate {
    locationDeactivate(locationId: "gid://shopify/Location/922479430") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }`,
});

Ruby

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 locationDeactivate {
    locationDeactivate(locationId: "gid://shopify/Location/922479430") {
      location {
        id
        isActive
      }
      locationDeactivateUserErrors {
        message
        code
        field
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"locationDeactivate": {

"location": {

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

"isActive": true

"locationDeactivateUserErrors": [

{

"message": "Location could not be deactivated without specifying where to relocate inventory stocked at the location.",

"code": "HAS_ACTIVE_INVENTORY_ERROR",

"field": [

"locationId"

]

}

]

}