customerAddressCreate

Mutationin Customer

Add a new address to the customer's address book

Arguments

Argument	Type	Description
address	AddressInput!

Returns

CustomerAddressCreateResponse!

Field	Type	Description
customer	Customer	Updated customer account information with new address
customerErrors	[CustomerAddressCreateError!]	Error details if address creation failed

Example

Query

mutation {
  customerAddressCreate(address: {
    givenName: "John"
    familyName: "Doe"
    streetName: "Secondary Street"
    streetNumber: "456"
    city: "Rotterdam"
    postalCode: "2000BB"
    country: "NL"
  }) {
    customer {
      id
      addresses {
        items {
          id
          givenName
          familyName
          city
        }
      }
    }
    customerErrors {
      ... on ValidationError {
        message
      }
    }
  }
}

Response

{
  "data": {
    "customerAddressCreate": {
      "customer": {
        "id": "id-1",
        "addresses": {
          "items": [
            {
              "id": "id-1",
              "givenName": "Example",
              "familyName": "Example",
              "city": "Example"
            }
          ]
        }
      },
      "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	Stub: answers Not implemented

Used by

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

• @evolve-storefront/feature-account: CustomerAddressCreate