locationLocalPickupDisable - admin-graphql - MUTATION

Version: 2024-10

Description:

Disables local pickup for a location.

Access Scopes

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

Arguments

• locationId: ID! - The ID of the location to disable local pickup for.

Returns

• locationId: ID The ID of the location for which local pickup was disabled.
• userErrors: DeliveryLocationLocalPickupSettingsError! The list of errors that occurred from executing the mutation.

Examples

• Disable 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 disableLocalPickup($locationId: ID!) { locationLocalPickupDisable(locationId: $locationId) { locationId userErrors { code field message } } }\",\n \"variables\": {\n    \"locationId\": \"gid://shopify/Location/750123840\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation disableLocalPickup($locationId: ID!) {\n      locationLocalPickupDisable(locationId: $locationId) {\n        locationId\n        userErrors {\n          code\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"locationId\": \"gid://shopify/Location/750123840\"\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 disableLocalPickup($locationId: ID!) {\n    locationLocalPickupDisable(locationId: $locationId) {\n      locationId\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"locationId\": \"gid://shopify/Location/750123840\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/Location/750123840\",\n];\n\n$response = $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 disableLocalPickup($locationId: ID!) {\n    locationLocalPickupDisable(locationId: $locationId) {\n      locationId\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"locationId\": \"gid://shopify/Location/750123840\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation disableLocalPickup($locationId: ID!) {\n  locationLocalPickupDisable(locationId: $locationId) {\n    locationId\n    userErrors {\n      code\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "locationId": "gid://shopify/Location/750123840"
  }

  response: {
    "data": {
      "locationLocalPickupDisable": {
        "locationId": "gid://shopify/Location/750123840",
        "userErrors": []
      }
    }
  }

  Disabling 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 disableLocalPickup($locationId: ID!) { locationLocalPickupDisable(locationId: $locationId) { locationId userErrors { code field message } } }\",\n \"variables\": {\n    \"locationId\": \"gid://shopify/Location/123\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation disableLocalPickup($locationId: ID!) {\n      locationLocalPickupDisable(locationId: $locationId) {\n        locationId\n        userErrors {\n          code\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"locationId\": \"gid://shopify/Location/123\"\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 disableLocalPickup($locationId: ID!) {\n    locationLocalPickupDisable(locationId: $locationId) {\n      locationId\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"locationId\": \"gid://shopify/Location/123\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/Location/123\",\n];\n\n$response = $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 disableLocalPickup($locationId: ID!) {\n    locationLocalPickupDisable(locationId: $locationId) {\n      locationId\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"locationId\": \"gid://shopify/Location/123\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation disableLocalPickup($locationId: ID!) {\n  locationLocalPickupDisable(locationId: $locationId) {\n    locationId\n    userErrors {\n      code\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "locationId": "gid://shopify/Location/123"
  }

  response: {
    "data": {
      "locationLocalPickupDisable": {
        "locationId": null,
        "userErrors": [
          {
            "code": "ACTIVE_LOCATION_NOT_FOUND",
            "field": [
              "locationId"
            ],
            "message": "Unable to find an active location for location ID 123"
          }
        ]
      }
    }
  }