---
title: locationLocalPickupEnable - GraphQL Admin
description: Enables local pickup for a location.
api_version: 2025-10
api_name: admin
type: mutation
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationlocalpickupenable
  md: https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationlocalpickupenable.md
---

# location​Local​Pickup​Enable

mutation

Requires Any of `shipping` access scopes or `manage_delivery_settings` user permission.

Enables local pickup for a location.

## Arguments

* local​Pickup​Settings

  [Delivery​Location​Local​Pickup​Enable​Input!](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/DeliveryLocationLocalPickupEnableInput)

  required

  The settings required to enable local pickup for a location.

***

## Location​Local​Pickup​Enable​Payload returns

* local​Pickup​Settings

  [Delivery​Local​Pickup​Settings](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryLocalPickupSettings)

  The local pickup settings that were enabled.

* user​Errors

  [\[Delivery​Location​Local​Pickup​Settings​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryLocationLocalPickupSettingsError)

  non-null

  The list of errors that occurred from executing the mutation.

***

## Examples

* ### Enable local pickup for a location

  #### Description

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

  #### Query

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

  #### Variables

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

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2025-10/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

  ```javascript
  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

  ```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

  ```javascript
  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

  ```json
  {
    "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

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

  #### Variables

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

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2025-10/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

  ```javascript
  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

  ```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

  ```javascript
  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

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

* ### locationLocalPickupEnable reference

[Open in GraphiQL](http://localhost:3457/graphiql?query=mutation%20enableLocalPickup\(%24localPickupSettings%3A%20DeliveryLocationLocalPickupEnableInput!\)%20%7B%0A%20%20locationLocalPickupEnable\(localPickupSettings%3A%20%24localPickupSettings\)%20%7B%0A%20%20%20%20localPickupSettings%20%7B%0A%20%20%20%20%20%20pickupTime%0A%20%20%20%20%20%20instructions%0A%20%20%20%20%7D%0A%20%20%20%20userErrors%20%7B%0A%20%20%20%20%20%20message%0A%20%20%20%20%20%20field%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D\&variables=%7B%0A%20%20%22localPickupSettings%22%3A%20%7B%0A%20%20%20%20%22locationId%22%3A%20%22gid%3A%2F%2Fshopify%2FLocation%2F530388139%22%2C%0A%20%20%20%20%22pickupTime%22%3A%20%22TWENTY_FOUR_HOURS%22%2C%0A%20%20%20%20%22instructions%22%3A%20%22Use%20side%20door.%22%0A%20%20%7D%0A%7D)

```javascript
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/2025-10/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

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

## Response

JSON

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