Choose a version:

locationLocalPickupEnable

mutation

Requires Any of shipping access scopes or manage_delivery_settings user permission.

Enables local pickup for a location so customers can collect their orders in person. Configures the estimated pickup time that customers see at checkout and optional instructions for finding or accessing the pickup location.

Anchor to Arguments

Arguments

Anchor to localPickupSettingslocalPickupSettings

•DeliveryLocationLocalPickupEnableInput!

required

The settings required to enable local pickup for a location.

Was this section helpful?

Anchor to LocationLocalPickupEnablePayload returnsLocationLocalPickupEnablePayload returns

Anchor to localPickupSettingslocalPickupSettings •DeliveryLocalPickupSettings: The local pickup settings that were enabled.
Anchor to userErrorsuserErrors •[DeliveryLocationLocalPickupSettingsError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Enable local pickup for a location

Description

Enable local pickup for a location with a pickup time and instructions.

Query

mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
  locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
    localPickupSettings {
      pickupTime
      instructions
    }
    userErrors {
      message
      field
    }
  }
}

Variables

{
  "localPickupSettings": {
    "locationId": "gid://shopify/Location/530388139",
    "pickupTime": "TWENTY_FOUR_HOURS",
    "instructions": "Use side door."
  }
}

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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) { locationLocalPickupEnable(localPickupSettings: $localPickupSettings) { localPickupSettings { pickupTime instructions } userErrors { message field } } }",
 "variables": {
    "localPickupSettings": {
      "locationId": "gid://shopify/Location/530388139",
      "pickupTime": "TWENTY_FOUR_HOURS",
      "instructions": "Use side door."
    }
  }
}'

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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
    locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
      localPickupSettings {
        pickupTime
        instructions
      }
      userErrors {
        message
        field
      }
    }
  }`,
  {
    variables: {
        "localPickupSettings": {
            "locationId": "gid://shopify/Location/530388139",
            "pickupTime": "TWENTY_FOUR_HOURS",
            "instructions": "Use side door."
        }
    },
  },
  );
  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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
    locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
      localPickupSettings {
        pickupTime
        instructions
      }
      userErrors {
        message
        field
      }
    }
  }
QUERY

variables = {
  "localPickupSettings": {
    "locationId": "gid://shopify/Location/530388139",
    "pickupTime": "TWENTY_FOUR_HOURS",
    "instructions": "Use side door."
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
      locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
        localPickupSettings {
          pickupTime
          instructions
        }
        userErrors {
          message
          field
        }
      }
    }`,
    "variables": {
        "localPickupSettings": {
            "locationId": "gid://shopify/Location/530388139",
            "pickupTime": "TWENTY_FOUR_HOURS",
            "instructions": "Use side door."
        }
    },
  },
});

Response

{
  "locationLocalPickupEnable": {
    "localPickupSettings": {
      "pickupTime": "TWENTY_FOUR_HOURS",
      "instructions": "Use side door."
    },
    "userErrors": []
  }
}

Enabling local pickup for an invalid location returns an error

Description

Enabling local pickup for an invalid location returns an error.

Query

mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
  locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
    localPickupSettings {
      pickupTime
      instructions
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "localPickupSettings": {
    "locationId": "gid://shopify/Location/123",
    "pickupTime": "TWENTY_FOUR_HOURS",
    "instructions": "Use side door."
  }
}

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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) { locationLocalPickupEnable(localPickupSettings: $localPickupSettings) { localPickupSettings { pickupTime instructions } userErrors { code field message } } }",
 "variables": {
    "localPickupSettings": {
      "locationId": "gid://shopify/Location/123",
      "pickupTime": "TWENTY_FOUR_HOURS",
      "instructions": "Use side door."
    }
  }
}'

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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
    locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
      localPickupSettings {
        pickupTime
        instructions
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
        "localPickupSettings": {
            "locationId": "gid://shopify/Location/123",
            "pickupTime": "TWENTY_FOUR_HOURS",
            "instructions": "Use side door."
        }
    },
  },
  );
  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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
    locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
      localPickupSettings {
        pickupTime
        instructions
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "localPickupSettings": {
    "locationId": "gid://shopify/Location/123",
    "pickupTime": "TWENTY_FOUR_HOURS",
    "instructions": "Use side door."
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
      locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
        localPickupSettings {
          pickupTime
          instructions
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
        "localPickupSettings": {
            "locationId": "gid://shopify/Location/123",
            "pickupTime": "TWENTY_FOUR_HOURS",
            "instructions": "Use side door."
        }
    },
  },
});

Response

{
  "locationLocalPickupEnable": {
    "localPickupSettings": null,
    "userErrors": [
      {
        "code": "ACTIVE_LOCATION_NOT_FOUND",
        "field": [
          "localPickupSettings"
        ],
        "message": "Unable to find an active location for location ID 123"
      }
    ]
  }
}

locationLocalPickupEnable 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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {

locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {

localPickupSettings {

pickupTime

instructions

}

userErrors {

message

field

}

}`,

{

variables: {

"localPickupSettings": {

"locationId": "gid://shopify/Location/530388139",

"pickupTime": "TWENTY_FOUR_HOURS",

"instructions": "Use side door."

}

);

const json = await response.json();

return json.data;

}

GQL

mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
  locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
    localPickupSettings {
      pickupTime
      instructions
    }
    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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) { locationLocalPickupEnable(localPickupSettings: $localPickupSettings) { localPickupSettings { pickupTime instructions } userErrors { message field } } }",
 "variables": {
    "localPickupSettings": {
      "locationId": "gid://shopify/Location/530388139",
      "pickupTime": "TWENTY_FOUR_HOURS",
      "instructions": "Use side door."
    }
  }
}'

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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
    locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
      localPickupSettings {
        pickupTime
        instructions
      }
      userErrors {
        message
        field
      }
    }
  }`,
  {
    variables: {
        "localPickupSettings": {
            "locationId": "gid://shopify/Location/530388139",
            "pickupTime": "TWENTY_FOUR_HOURS",
            "instructions": "Use side door."
        }
    },
  },
  );
  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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
      locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
        localPickupSettings {
          pickupTime
          instructions
        }
        userErrors {
          message
          field
        }
      }
    }`,
    "variables": {
        "localPickupSettings": {
            "locationId": "gid://shopify/Location/530388139",
            "pickupTime": "TWENTY_FOUR_HOURS",
            "instructions": "Use side door."
        }
    },
  },
});

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 enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {
    locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {
      localPickupSettings {
        pickupTime
        instructions
      }
      userErrors {
        message
        field
      }
    }
  }
QUERY

variables = {
  "localPickupSettings": {
    "locationId": "gid://shopify/Location/530388139",
    "pickupTime": "TWENTY_FOUR_HOURS",
    "instructions": "Use side door."
  }
}

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

Input variables

JSON

{

"localPickupSettings": {

"locationId": "gid://shopify/Location/530388139",

"pickupTime": "TWENTY_FOUR_HOURS",

"instructions": "Use side door."

}

Response

JSON

{

"locationLocalPickupEnable": {

"localPickupSettings": {

"pickupTime": "TWENTY_FOUR_HOURS",

"instructions": "Use side door."

"userErrors": []

}