Choose a version:

locationDelete

mutation

Requires write_locations access scope.

Deletes a location.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to LocationDeletePayload returnsLocationDeletePayload returns

Anchor to deletedLocationIddeletedLocationId •ID: The ID of the location that was deleted.
Anchor to locationDeleteUserErrorslocationDeleteUserErrors •[LocationDeleteUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Delete a location and return the location ID

Description

Delete a location that has been deactivated.

Query

mutation {
  locationDelete(locationId: "gid://shopify/Location/658095763") {
    deletedLocationId
  }
}

cURL

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

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 {
    locationDelete(locationId: "gid://shopify/Location/658095763") {
      deletedLocationId
    }
  }`,
  );
  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 {
    locationDelete(locationId: "gid://shopify/Location/658095763") {
      deletedLocationId
    }
  }
QUERY

response = client.query(query: query)

Node.js

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

Shopify CLI

shopify app execute \
--query \
'mutation {
  locationDelete(locationId: "gid://shopify/Location/658095763") {
    deletedLocationId
  }
}'

Response

{
  "locationDelete": {
    "deletedLocationId": "gid://shopify/Location/658095763"
  }
}

Delete an active location

Description

Deleting an active location returns an error.

Query

mutation {
  locationDelete(locationId: "gid://shopify/Location/658095763") {
    deletedLocationId
    locationDeleteUserErrors {
      message
      code
      field
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation { locationDelete(locationId: \"gid://shopify/Location/658095763\") { deletedLocationId locationDeleteUserErrors { 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 {
    locationDelete(locationId: "gid://shopify/Location/658095763") {
      deletedLocationId
      locationDeleteUserErrors {
        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 {
    locationDelete(locationId: "gid://shopify/Location/658095763") {
      deletedLocationId
      locationDeleteUserErrors {
        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 {
    locationDelete(locationId: "gid://shopify/Location/658095763") {
      deletedLocationId
      locationDeleteUserErrors {
        message
        code
        field
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'mutation {
  locationDelete(locationId: "gid://shopify/Location/658095763") {
    deletedLocationId
    locationDeleteUserErrors {
      message
      code
      field
    }
  }
}'

Response

{
  "locationDelete": {
    "deletedLocationId": null,
    "locationDeleteUserErrors": [
      {
        "message": "The location cannot be deleted while it is active.",
        "code": "LOCATION_IS_ACTIVE",
        "field": [
          "locationId"
        ]
      }
    ]
  }
}

locationDelete 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 {

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

deletedLocationId

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

mutation {
  locationDelete(locationId: "gid://shopify/Location/658095763") {
    deletedLocationId
  }
}

cURL

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

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 {
    locationDelete(locationId: "gid://shopify/Location/658095763") {
      deletedLocationId
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

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

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 {
    locationDelete(locationId: "gid://shopify/Location/658095763") {
      deletedLocationId
    }
  }
QUERY

response = client.query(query: query)

Shopify CLI

shopify app execute \
--query \
'mutation {
  locationDelete(locationId: "gid://shopify/Location/658095763") {
    deletedLocationId
  }
}'

Response

JSON

{

"locationDelete": {

"deletedLocationId": "gid://shopify/Location/658095763"

}