customerUpdateDefaultAddress - admin-graphql - MUTATION

Version: 2024-04

Description:

Updates a customer's default address.

Access Scopes

`write_customers` access scope.

Arguments

• addressId: ID! - The ID of the customer's new default address.
• customerId: ID! - The ID of the customer whose default address is being updated.

Returns

• customer: Customer The customer whose address was updated.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Sets the default address for a customer

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CustomerAddressDefault($addressId: ID!, $customerId: ID!) { customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) { customer { id defaultAddress { id address1 city } } userErrors { field message } } }\",\n \"variables\": {\n    \"customerId\": \"gid://shopify/Customer/624407574\",\n    \"addressId\": \"gid://shopify/MailingAddress/624407574?model_name=CustomerAddress\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation CustomerAddressDefault($addressId: ID!, $customerId: ID!) {\n      customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {\n        customer {\n          id\n          defaultAddress {\n            id\n            address1\n            city\n          }\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"customerId\": \"gid://shopify/Customer/624407574\",\n      \"addressId\": \"gid://shopify/MailingAddress/624407574?model_name=CustomerAddress\"\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 CustomerAddressDefault($addressId: ID!, $customerId: ID!) {\n    customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {\n      customer {\n        id\n        defaultAddress {\n          id\n          address1\n          city\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"customerId\": \"gid://shopify/Customer/624407574\",\n  \"addressId\": \"gid://shopify/MailingAddress/624407574?model_name=CustomerAddress\"\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/Customer/624407574\",\n  \"addressId\" => \"gid://shopify/MailingAddress/624407574?model_name=CustomerAddress\",\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 CustomerAddressDefault($addressId: ID!, $customerId: ID!) {\n    customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {\n      customer {\n        id\n        defaultAddress {\n          id\n          address1\n          city\n        }\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"customerId\": \"gid://shopify/Customer/624407574\",\n      \"addressId\": \"gid://shopify/MailingAddress/624407574?model_name=CustomerAddress\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation CustomerAddressDefault($addressId: ID!, $customerId: ID!) {\n  customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {\n    customer {\n      id\n      defaultAddress {\n        id\n        address1\n        city\n      }\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "customerId": "gid://shopify/Customer/624407574",
    "addressId": "gid://shopify/MailingAddress/624407574?model_name=CustomerAddress"
  }

  response: {
    "data": {
      "customerUpdateDefaultAddress": {
        "customer": {
          "id": "gid://shopify/Customer/624407574",
          "defaultAddress": {
            "id": "gid://shopify/MailingAddress/624407574?model_name=CustomerAddress",
            "address1": "124 Amoebobacterieae St",
            "city": "Ottawa"
          }
        },
        "userErrors": []
      }
    }
  }

  Updates an existing customer address

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation customerUpdateDefaultAddress($addressId: ID!, $customerId: ID!) { customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) { customer { defaultAddress { id } } userErrors { message } } }\",\n \"variables\": {\n    \"customerId\": \"gid://shopify/Customer/624407574\",\n    \"addressId\": \"gid://shopify/MailingAddress/1053318600?model_name=CustomerAddress\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation customerUpdateDefaultAddress($addressId: ID!, $customerId: ID!) {\n      customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {\n        customer {\n          defaultAddress {\n            id\n          }\n        }\n        userErrors {\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"customerId\": \"gid://shopify/Customer/624407574\",\n      \"addressId\": \"gid://shopify/MailingAddress/1053318600?model_name=CustomerAddress\"\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 customerUpdateDefaultAddress($addressId: ID!, $customerId: ID!) {\n    customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {\n      customer {\n        defaultAddress {\n          id\n        }\n      }\n      userErrors {\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"customerId\": \"gid://shopify/Customer/624407574\",\n  \"addressId\": \"gid://shopify/MailingAddress/1053318600?model_name=CustomerAddress\"\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/Customer/624407574\",\n  \"addressId\" => \"gid://shopify/MailingAddress/1053318600?model_name=CustomerAddress\",\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 customerUpdateDefaultAddress($addressId: ID!, $customerId: ID!) {\n    customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {\n      customer {\n        defaultAddress {\n          id\n        }\n      }\n      userErrors {\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"customerId\": \"gid://shopify/Customer/624407574\",\n      \"addressId\": \"gid://shopify/MailingAddress/1053318600?model_name=CustomerAddress\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation customerUpdateDefaultAddress($addressId: ID!, $customerId: ID!) {\n  customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {\n    customer {\n      defaultAddress {\n        id\n      }\n    }\n    userErrors {\n      message\n    }\n  }\n}"
        

  input: {
    "customerId": "gid://shopify/Customer/624407574",
    "addressId": "gid://shopify/MailingAddress/1053318600?model_name=CustomerAddress"
  }

  response: {
    "data": {
      "customerUpdateDefaultAddress": {
        "customer": {
          "defaultAddress": {
            "id": "gid://shopify/MailingAddress/1053318600?model_name=CustomerAddress"
          }
        },
        "userErrors": []
      }
    }
  }