customerUpdateDefaultAddress
mutation

Choose a version:

Requires write_customers access scope. Also: User needs customers permission.

Updates a customer's default address.

Anchor to section titled 'Arguments'

Arguments

Anchor to addressId addressId ID! required: The ID of the customer's new default address.
Anchor to customerId customerId ID! required: The ID of the customer whose default address is being updated.

Was this section helpful?

Anchor to section titled 'CustomerUpdateDefaultAddressPayload returns'

CustomerUpdateDefaultAddressPayload returns

Anchor to CustomerUpdateDefaultAddressPayload.customer customer Customer: The customer whose address was updated.
Anchor to CustomerUpdateDefaultAddressPayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: customerUpdateDefaultAddress

Query Reference for MUTATION: customerUpdateDefaultAddress

"mutation customerUpdateDefaultAddress($addressId: ID!, $customerId: ID!) {\n  customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {\n    customer {\n      # Customer fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: customerUpdateDefaultAddress

"{\n  \"addressId\": \"gid://shopify/<objectName>/10079785100\",\n  \"customerId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: customerUpdateDefaultAddress

""

Display Examples for MUTATION: customerUpdateDefaultAddress

[
  {
    "example": {
      "type_name": "customerupdatedefaultaddress",
      "title": "Update a customer's default address",
      "query_string": "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}",
      "variables": {
        "customerId": "gid://shopify/Customer/624407574",
        "addressId": "gid://shopify/MailingAddress/1053317286?model_name=CustomerAddress"
      },
      "response": {
        "data": {
          "customerUpdateDefaultAddress": {
            "customer": {
              "defaultAddress": {
                "id": "gid://shopify/MailingAddress/1053317286?model_name=CustomerAddress"
              }
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/customers/test/unit/graph_api/admin/mutations/customer_update_default_address_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/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/1053317286?model_name=CustomerAddress\"\n  }\n}'\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/1053317286?model_name=CustomerAddress\"\n    },\n  },\n);\n\nconst data = await response.json();\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/1053317286?model_name=CustomerAddress\"\n}\n\nresponse = client.query(query: query, variables: variables)\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/1053317286?model_name=CustomerAddress\"\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<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\n$variables = [\n  \"customerId\" => \"gid://shopify/Customer/624407574\",\n  \"addressId\" => \"gid://shopify/MailingAddress/1053317286?model_name=CustomerAddress\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "customerId",
          "description": "The ID of the customer whose default address is being updated.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "customerId",
        "argValue": " \"gid://shopify/Customer/624407574\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "addressId",
          "description": "The ID of the customer's new default address.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "addressId",
        "argValue": " \"gid://shopify/MailingAddress/1053317286?model_name=CustomerAddress\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]

customerUpdateDefaultAddressmutation

Arguments

CustomerUpdateDefaultAddressPayload returns

customerUpdateDefaultAddress
mutation