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
Attribute | Data Type | Description |
---|---|---|
id |
Int | The ID assigned to the address object |
CustomerAddressInput |
CustomerAddress | An array containing the customer’s shipping and billing addresses |
CustomerAddressInput attributes
The CustomerAddressInput
object can contain the following attributes:
Attribute | Data Type | Description |
---|---|---|
city |
String | The city or town |
company |
String | The customer’s company |
country_code |
String | The customer’s country |
country_id |
String | Deprecated. Use country_code instead. The customer’s country |
custom_attributes |
CustomerAddressAttributeInput | Deprecated. Not applicable for GraphQL |
default_billing |
Boolean | Indicates whether the address is the default billing address |
default_shipping |
Boolean | Indicates whether the address is the default shipping address |
fax |
String | The fax number |
firstname |
String | The first name of the person associated with the shipping/billing address |
lastname |
String | The family name of the person associated with the shipping/billing address |
middlename |
String | The middle name of the person associated with the shipping/billing address |
postcode |
String | The customer’s ZIP or postal code |
prefix |
String | An honorific, such as Dr., Mr., or Mrs. |
region |
CustomerAddressRegionInput | An object that defines the customer’s state or province |
street |
[String] | An array of strings that define the street number and name |
suffix |
String | A value such as Sr., Jr., or III |
telephone |
String | The telephone number |
vat_id |
String | The customer’s Tax/VAT number (for corporate customers) |
CustomerAddressAttributeInput attributes
The CustomerAddressAttributeInput
data type has been deprecated because the contents are not applicable for GraphQL. It can contain the following attributes:
Attribute | Data Type | Description |
---|---|---|
attribute_code |
String | Attribute code |
value |
String | Attribute value |
CustomerAddressRegionInput attributes
The customerAddressRegionInput
object can contain the following attributes:
Attribute | Data Type | Description |
---|---|---|
region |
String | The state or province name |
region_code |
String | The address region code |
region_id |
Int | The unique ID for a pre-defined region |
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:
Attribute | Data Type | Description |
---|---|---|
city |
String | The city or town |
company |
String | The customer’s company |
country_code |
CountryCodeEnum | The customer’s country |
country_id |
String | Deprecated. Use country_code instead. The customer’s country |
custom_attributes |
CustomerAddressAttribute | Deprecated. Not applicable for GraphQL |
customer_id |
Int | Deprecated. This attribute is not applicable for GraphQL. The ID assigned to the customer |
default_billing |
Boolean | Indicates whether the address is the default billing address |
default_shipping |
Boolean | Indicates whether the address is the default shipping address |
extension_attributes |
CustomerAddressAttribute | Address extension attributes |
fax |
String | The fax number |
firstname |
String | The first name of the person associated with the shipping/billing address |
id |
Int | The ID assigned to the address object |
lastname |
String | The family name of the person associated with the shipping/billing address |
middlename |
String | The middle name of the person associated with the shipping/billing address |
postcode |
String | The customer’s ZIP or postal code |
prefix |
String | An honorific, such as Dr., Mr., or Mrs. |
region |
CustomerAddressRegion | An object that defines the customer’s state or province |
region_id |
Int | The unique ID for a pre-defined region |
street |
[String] | An array of strings that define the street number and name |
suffix |
String | A value such as Sr., Jr., or III |
telephone |
String | The telephone number |
vat_id |
String | The customer’s Tax/VAT number (for corporate customers) |
CustomerAddressAttribute attributes
The CustomerAddressAttribute
output data type has been deprecated because the contents are not applicable for GraphQL. It can contain the following attributes:
Attribute | Data Type | Description |
---|---|---|
attribute_code |
String | Attribute code |
value |
String | Attribute value |
CustomerAddressRegion attributes
The customerAddressRegion
output returns the following attributes:
Attribute | Data Type | Description |
---|---|---|
region |
String | The state or province name |
region_code |
String | The address region code |
region_id |
Int | The unique ID for a pre-defined region |
Errors
Error | Description |
---|---|
Expected type CustomerAddressInput!, found "". |
The input attribute contains an empty value. |
"input" value should be specified |
The input argument is specified but is empty. |
Required parameters are missing: firstname |
The input.firstname argument was omitted or contains an empty value. |
"Street Address" cannot contain more than 2 lines. |
The input.street argument contains array with more than two elements. |
Syntax Error: Expected Name, found ) |
The input argument was omitted. |
The current customer isn't authorized. |
The current customer is not currently logged in, or the customer’s token does not exist in the oauth_token table. |