# locationLocalPickupEnable - admin-graphql - MUTATION Version: 2024-10 ## Description Enables local pickup for a location. ### Access Scopes Any of `shipping` access scopes or `manage_delivery_settings` user permission. ## Arguments * [localPickupSettings](/docs/api/admin-graphql/2024-10/input-objects/DeliveryLocationLocalPickupEnableInput): DeliveryLocationLocalPickupEnableInput! - The settings required to enable local pickup for a location. ## Returns * [localPickupSettings](/docs/api/admin-graphql/2024-10/objects/DeliveryLocalPickupSettings): DeliveryLocalPickupSettings The local pickup settings that were enabled. * [userErrors](/docs/api/admin-graphql/2024-10/objects/DeliveryLocationLocalPickupSettingsError): DeliveryLocationLocalPickupSettingsError! The list of errors that occurred from executing the mutation. ## Examples ### Enable local pickup for a location Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) { locationLocalPickupEnable(localPickupSettings: $localPickupSettings) { localPickupSettings { pickupTime instructions } userErrors { message field } } }\",\n \"variables\": {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/530388139\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n message\n field\n }\n }\n }`,\n \"variables\": {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/530388139\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\n }\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n message\n field\n }\n }\n }\nQUERY\n\nvariables = {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/530388139\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n message\n field\n }\n }\n }`,\n {\n variables: {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/530388139\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n message\n field\n }\n }\n}" #### Graphql Input { "localPickupSettings": { "locationId": "gid://shopify/Location/530388139", "pickupTime": "TWENTY_FOUR_HOURS", "instructions": "Use side door." } } #### Graphql Response { "data": { "locationLocalPickupEnable": { "localPickupSettings": { "pickupTime": "TWENTY_FOUR_HOURS", "instructions": "Use side door." }, "userErrors": [] } } } ### Enabling local pickup for an invalid location returns an error Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) { locationLocalPickupEnable(localPickupSettings: $localPickupSettings) { localPickupSettings { pickupTime instructions } userErrors { code field message } } }\",\n \"variables\": {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/123\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/123\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\n }\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/123\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"localPickupSettings\": {\n \"locationId\": \"gid://shopify/Location/123\",\n \"pickupTime\": \"TWENTY_FOUR_HOURS\",\n \"instructions\": \"Use side door.\"\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation enableLocalPickup($localPickupSettings: DeliveryLocationLocalPickupEnableInput!) {\n locationLocalPickupEnable(localPickupSettings: $localPickupSettings) {\n localPickupSettings {\n pickupTime\n instructions\n }\n userErrors {\n code\n field\n message\n }\n }\n}" #### Graphql Input { "localPickupSettings": { "locationId": "gid://shopify/Location/123", "pickupTime": "TWENTY_FOUR_HOURS", "instructions": "Use side door." } } #### Graphql Response { "data": { "locationLocalPickupEnable": { "localPickupSettings": null, "userErrors": [ { "code": "ACTIVE_LOCATION_NOT_FOUND", "field": [ "localPickupSettings" ], "message": "Unable to find an active location for location ID 123" } ] } } }