customerDefaultAddressUpdate

Mutationin Customer

Set the customer's default shipping and/or billing address by referencing an existing address in their address book. At least one of the two ids is required.

Arguments

Argument	Type	Description
`shippingAddressId`	`ID`
`billingAddressId`	`ID`

Returns

CustomerDefaultAddressUpdateResponse!

Field	Type	Description
`customer`	`Customer`	Updated customer account information
`customerErrors`	`[CustomerDefaultAddressUpdateError!]`	Error details if update failed

Example

Query
Response

mutation {
  customerDefaultAddressUpdate(
    shippingAddressId: "addr-123"
    billingAddressId: "addr-456"
  ) {
    customer {
      id
      defaultShippingAddress {
        id
      }
      billingAddress {
        id
      }
    }
    customerErrors {
      ... on ValidationError {
        message
      }
    }
  }
}

{
  "data": {
    "customerDefaultAddressUpdate": {
      "customer": {
        "id": "id-1",
        "defaultShippingAddress": {
          "id": "id-1"
        },
        "billingAddress": {
          "id": "id-1"
        }
      },
      "customerErrors": [
        {
          "message": "Example"
        }
      ]
    }
  }
}

The query is the example the schema documents. The response shows its shape with placeholder values.

Served by

@evolve-framework/commercetools	Resolved
@evolve-framework/medusa	Resolved
@evolve-framework/sfcc	Not resolved

Used by

The storefront packages that send it, in these GraphQL documents:

@evolve-storefront/feature-account: CustomerDefaultAddressUpdate