updateCustomerAddress mutation

Use the updateCustomerAddress mutation to update the customer’s address.

To return or modify information about a customer, Magento recommends you use customer tokens in the header of your GraphQL calls. However, you also can use session authentication.

Syntax

mutation: {updateCustomerAddress(id: Int!, input: CustomerAddressInput) {CustomerAddress}}

Example usage

The following call updates the customer’s city and postcode.

Request:

1
2
3
4
5
6
7
8
9
10
mutation {
  updateCustomerAddress(id:3, input: {
    city: "New City"
    postcode: "55555"
  }) {
    id
    city
    postcode
  }
}

Response:

1
2
3
4
5
6
7
8
9
{
  "data": {
    "updateCustomerAddress": {
      "id": 3,
      "city": "New City",
      "postcode": 55555
    }
  }
}

Input attributes

The updateCustomerAddress object contains the following inputs:

CustomerAddressInput attributes

The CustomerAddressInput object can contain the following attributes:

CustomerAddressAttributeInput attributes

The CustomerAddressAttributeInput data type has been deprecated because the contents are not applicable for GraphQL. It can contain the following attributes:

CustomerAddressRegionInput attributes

The customerAddressRegionInput object can contain the following attributes:

Output attributes

The updateCustomerAddress mutation returns the CustomerAddress object.

CustomerAddress attributes

The values assigned to attributes such as firstname and lastname in this object may be different from those defined in the Customer object.

The CustomerAddress output returns the following attributes:

CustomerAddressAttribute attributes

The CustomerAddressAttribute output data type has been deprecated because the contents are not applicable for GraphQL. It can contain the following attributes:

CustomerAddressRegion attributes

The customerAddressRegion output returns the following attributes:

Errors

Related topics

• customer query
• createCustomer mutation
• updateCustomer mutation
• createCustomerAddress mutation
• deleteCustomerAddress mutation