Choose a version:

locationEdit

mutation

Requires write_locations access scope or write_fulfillments access scope. Also: write_locations: access scope is required to modify merchant-managed locations. write_fulfillments: apps can edit the locations associated with their fulfillment services if they have this scope. Only the app that created the fulfillment service can edit its associated location.

Updates the properties of an existing Location. You can modify the location's name, address, whether it fulfills online orders, and custom metafields.

Apps that created a FulfillmentService can edit the associated location to ensure accurate representation of their fulfillment network.

Note

You can't disable the fulfillsOnlineOrders setting for fulfillment service locations.

Learn more about editing locations for fulfillment services.

Anchor to Arguments

Arguments

Anchor to idid

•ID!

required

The ID of a location to edit.

Anchor to inputinput

•LocationEditInput!

required

The updated properties for the location.

Was this section helpful?

Anchor to LocationEditPayload returnsLocationEditPayload returns

Anchor to locationlocation •Location: The location that was edited.
Anchor to userErrorsuserErrors •[LocationEditUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Create a new metafield and update another on an existing location

Description

Create a new metafield `my_field.delivery_type` and update an existing metafield `global.store_hours` on a specific location. Alternatively, refer to the [metafieldsSet](https://shopify.dev/api/admin-graphql/latest/mutations/metafieldsset) mutation to create and/or update metafields on location resources.

Query

mutation updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {
  locationEdit(input: $input, id: $ownerId) {
    location {
      id
      metafields(first: 3) {
        edges {
          node {
            id
            namespace
            key
            value
          }
        }
      }
    }
    userErrors {
      message
      field
    }
  }
}

Variables

{
  "input": {
    "metafields": [
      {
        "namespace": "my_field",
        "key": "delivery_type",
        "type": "single_line_text_field",
        "value": "local"
      },
      {
        "id": "gid://shopify/Metafield/1069229306",
        "value": "Open from 7am to 10pm"
      }
    ]
  },
  "ownerId": "gid://shopify/Location/346779380"
}

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 updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) { locationEdit(input: $input, id: $ownerId) { location { id metafields(first: 3) { edges { node { id namespace key value } } } } userErrors { message field } } }",
 "variables": {
    "input": {
      "metafields": [
        {
          "namespace": "my_field",
          "key": "delivery_type",
          "type": "single_line_text_field",
          "value": "local"
        },
        {
          "id": "gid://shopify/Metafield/1069229306",
          "value": "Open from 7am to 10pm"
        }
      ]
    },
    "ownerId": "gid://shopify/Location/346779380"
  }
}'

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 updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {
    locationEdit(input: $input, id: $ownerId) {
      location {
        id
        metafields(first: 3) {
          edges {
            node {
              id
              namespace
              key
              value
            }
          }
        }
      }
      userErrors {
        message
        field
      }
    }
  }`,
  {
    variables: {
        "input": {
            "metafields": [
                {
                    "namespace": "my_field",
                    "key": "delivery_type",
                    "type": "single_line_text_field",
                    "value": "local"
                },
                {
                    "id": "gid://shopify/Metafield/1069229306",
                    "value": "Open from 7am to 10pm"
                }
            ]
        },
        "ownerId": "gid://shopify/Location/346779380"
    },
  },
  );
  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 updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {
    locationEdit(input: $input, id: $ownerId) {
      location {
        id
        metafields(first: 3) {
          edges {
            node {
              id
              namespace
              key
              value
            }
          }
        }
      }
      userErrors {
        message
        field
      }
    }
  }
QUERY

variables = {
  "input": {
    "metafields": [
      {
        "namespace": "my_field",
        "key": "delivery_type",
        "type": "single_line_text_field",
        "value": "local"
      },
      {
        "id": "gid://shopify/Metafield/1069229306",
        "value": "Open from 7am to 10pm"
      }
    ]
  },
  "ownerId": "gid://shopify/Location/346779380"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {
      locationEdit(input: $input, id: $ownerId) {
        location {
          id
          metafields(first: 3) {
            edges {
              node {
                id
                namespace
                key
                value
              }
            }
          }
        }
        userErrors {
          message
          field
        }
      }
    }`,
    "variables": {
        "input": {
            "metafields": [
                {
                    "namespace": "my_field",
                    "key": "delivery_type",
                    "type": "single_line_text_field",
                    "value": "local"
                },
                {
                    "id": "gid://shopify/Metafield/1069229306",
                    "value": "Open from 7am to 10pm"
                }
            ]
        },
        "ownerId": "gid://shopify/Location/346779380"
    },
  },
});

Response

{
  "locationEdit": {
    "location": {
      "id": "gid://shopify/Location/346779380",
      "metafields": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/Metafield/1069229306",
              "namespace": "global",
              "key": "store_hours",
              "value": "Open from 7am to 10pm"
            }
          },
          {
            "node": {
              "id": "gid://shopify/Metafield/1069229307",
              "namespace": "my_field",
              "key": "delivery_type",
              "value": "local"
            }
          }
        ]
      }
    },
    "userErrors": []
  }
}

Edit a location and return the location ID

Description

Edit a location's name, address and fulfillsOnlineOrders status

Query

mutation locationEdit {
  locationEdit(id: "gid://shopify/Location/346779380", input: {name: "Shipping Warehouse", address: {address1: "290 Bremner Blvd", city: "Toronto", zip: "M5V 3L9", provinceCode: "ON", countryCode: CA}, fulfillsOnlineOrders: false}) {
    location {
      id
      name
      address {
        address1
        provinceCode
        countryCode
        zip
      }
      fulfillsOnlineOrders
    }
  }
}

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 locationEdit { locationEdit(id: \"gid://shopify/Location/346779380\", input: {name: \"Shipping Warehouse\", address: {address1: \"290 Bremner Blvd\", city: \"Toronto\", zip: \"M5V 3L9\", provinceCode: \"ON\", countryCode: CA}, fulfillsOnlineOrders: false}) { location { id name address { address1 provinceCode countryCode zip } fulfillsOnlineOrders } } }"
}'

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 locationEdit {
    locationEdit(id: "gid://shopify/Location/346779380", input: {name: "Shipping Warehouse", address: {address1: "290 Bremner Blvd", city: "Toronto", zip: "M5V 3L9", provinceCode: "ON", countryCode: CA}, fulfillsOnlineOrders: false}) {
      location {
        id
        name
        address {
          address1
          provinceCode
          countryCode
          zip
        }
        fulfillsOnlineOrders
      }
    }
  }`,
  );
  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 locationEdit {
    locationEdit(id: "gid://shopify/Location/346779380", input: {name: "Shipping Warehouse", address: {address1: "290 Bremner Blvd", city: "Toronto", zip: "M5V 3L9", provinceCode: "ON", countryCode: CA}, fulfillsOnlineOrders: false}) {
      location {
        id
        name
        address {
          address1
          provinceCode
          countryCode
          zip
        }
        fulfillsOnlineOrders
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `mutation locationEdit {
    locationEdit(id: "gid://shopify/Location/346779380", input: {name: "Shipping Warehouse", address: {address1: "290 Bremner Blvd", city: "Toronto", zip: "M5V 3L9", provinceCode: "ON", countryCode: CA}, fulfillsOnlineOrders: false}) {
      location {
        id
        name
        address {
          address1
          provinceCode
          countryCode
          zip
        }
        fulfillsOnlineOrders
      }
    }
  }`,
});

Response

{
  "locationEdit": {
    "location": {
      "id": "gid://shopify/Location/346779380",
      "name": "Shipping Warehouse",
      "address": {
        "address1": "290 Bremner Blvd",
        "provinceCode": "ON",
        "countryCode": "CA",
        "zip": "M5V 3L9"
      },
      "fulfillsOnlineOrders": false
    }
  }
}

locationEdit 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 updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {

locationEdit(input: $input, id: $ownerId) {

location {

metafields(first: 3) {

edges {

node {

namespace

key

value

}

userErrors {

message

field

}

}`,

{

variables: {

"input": {

"metafields": [

{

"namespace": "my_field",

"key": "delivery_type",

"type": "single_line_text_field",

"value": "local"

{

"id": "gid://shopify/Metafield/1069229306",

"value": "Open from 7am to 10pm"

}

]

"ownerId": "gid://shopify/Location/346779380"

);

const json = await response.json();

return json.data;

}

GQL

mutation updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {
  locationEdit(input: $input, id: $ownerId) {
    location {
      id
      metafields(first: 3) {
        edges {
          node {
            id
            namespace
            key
            value
          }
        }
      }
    }
    userErrors {
      message
      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 updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) { locationEdit(input: $input, id: $ownerId) { location { id metafields(first: 3) { edges { node { id namespace key value } } } } userErrors { message field } } }",
 "variables": {
    "input": {
      "metafields": [
        {
          "namespace": "my_field",
          "key": "delivery_type",
          "type": "single_line_text_field",
          "value": "local"
        },
        {
          "id": "gid://shopify/Metafield/1069229306",
          "value": "Open from 7am to 10pm"
        }
      ]
    },
    "ownerId": "gid://shopify/Location/346779380"
  }
}'

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 updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {
    locationEdit(input: $input, id: $ownerId) {
      location {
        id
        metafields(first: 3) {
          edges {
            node {
              id
              namespace
              key
              value
            }
          }
        }
      }
      userErrors {
        message
        field
      }
    }
  }`,
  {
    variables: {
        "input": {
            "metafields": [
                {
                    "namespace": "my_field",
                    "key": "delivery_type",
                    "type": "single_line_text_field",
                    "value": "local"
                },
                {
                    "id": "gid://shopify/Metafield/1069229306",
                    "value": "Open from 7am to 10pm"
                }
            ]
        },
        "ownerId": "gid://shopify/Location/346779380"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {
      locationEdit(input: $input, id: $ownerId) {
        location {
          id
          metafields(first: 3) {
            edges {
              node {
                id
                namespace
                key
                value
              }
            }
          }
        }
        userErrors {
          message
          field
        }
      }
    }`,
    "variables": {
        "input": {
            "metafields": [
                {
                    "namespace": "my_field",
                    "key": "delivery_type",
                    "type": "single_line_text_field",
                    "value": "local"
                },
                {
                    "id": "gid://shopify/Metafield/1069229306",
                    "value": "Open from 7am to 10pm"
                }
            ]
        },
        "ownerId": "gid://shopify/Location/346779380"
    },
  },
});

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 updateLocationMetafields($input: LocationEditInput!, $ownerId: ID!) {
    locationEdit(input: $input, id: $ownerId) {
      location {
        id
        metafields(first: 3) {
          edges {
            node {
              id
              namespace
              key
              value
            }
          }
        }
      }
      userErrors {
        message
        field
      }
    }
  }
QUERY

variables = {
  "input": {
    "metafields": [
      {
        "namespace": "my_field",
        "key": "delivery_type",
        "type": "single_line_text_field",
        "value": "local"
      },
      {
        "id": "gid://shopify/Metafield/1069229306",
        "value": "Open from 7am to 10pm"
      }
    ]
  },
  "ownerId": "gid://shopify/Location/346779380"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"input": {

"metafields": [

{

"namespace": "my_field",

"key": "delivery_type",

"type": "single_line_text_field",

"value": "local"

{

"id": "gid://shopify/Metafield/1069229306",

"value": "Open from 7am to 10pm"

}

]

"ownerId": "gid://shopify/Location/346779380"

}

Response

JSON

{

"locationEdit": {

"location": {

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

"metafields": {

"edges": [

{

"node": {

"id": "gid://shopify/Metafield/1069229306",

"namespace": "global",

"key": "store_hours",

"value": "Open from 7am to 10pm"

}

{

"node": {

"id": "gid://shopify/Metafield/1069229307",

"namespace": "my_field",

"key": "delivery_type",

"value": "local"

}

]

}

"userErrors": []

}