locationLocalPickupEnable

mutation

Requires Any of shipping access scopes or manage_delivery_settings user permission.

Enables local pickup for a location.

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?

Enable local pickup for a location
Enabling local pickup for an invalid location returns an error
locationLocalPickupEnable reference

Examples

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 data = await response.json();

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

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

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 data = await response.json();

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."
      }
    },
  },
});

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": []

}