createCustomerAddress mutation

Use the createCustomerAddress mutation to create 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: {createCustomerAddress(input: CustomerAddressInput!) {CustomerAddress}}

Example usage

The following call creates an address for the specified customer.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
mutation {
  createCustomerAddress(input: {
    region: {
      region: "Arizona"
      region_code: "AZ"
    }
    country_code: US
    street: ["123 Main Street"]
    telephone: "7777777777"
    postcode: "77777"
    city: "Phoenix"
    firstname: "Bob"
    lastname: "Loblaw"
    default_shipping: true
    default_billing: false
  }) {
    id
    region {
      region
      region_code
    }
    country_code
    street
    telephone
    postcode
    city
    default_shipping
    default_billing
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "data": {
    "createCustomerAddress": {
      "id": 4,
      "region": {
        "region": "Arizona",
        "region_code": "AZ"
      },
      "country_code": "US",
      "street": [
        "123 Main Street"
      ],
      "telephone": "7777777777",
      "postcode": "77777",
      "city": "Phoenix",
      "default_shipping": true,
      "default_billing": false
    }
  }
}

Input attributes

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 createCustomerAddress mutation returns the following attributes:

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
• updateCustomerAddress mutation
• deleteCustomerAddress mutation