addCustomerAddress

Example Query

1 mutation ExampleMutation($reCaptchaV2: ReCaptchaV2Input, $input: AddCustomerAddressInput) {
2   addCustomerAddress(reCaptchaV2: $reCaptchaV2, input: $input) {
3     address {
4       entityId
5       firstName
6       lastName
7       address1
8       address2
9       addressType
10       city
11       country
12       countryId
13       countryCode
14     }
15     errors
16   }
17 }

Variables

1 {
2   "reCaptchaV2": {
3     "token": "example"
4   },
5   "input": {
6     "firstName": "example",
7     "lastName": "example",
8     "address1": "example",
9     "address2": "example",
10     "city": "example",
11     "company": "example",
12     "countryCode": "example",
13     "stateOrProvince": "example",
14     "phone": "example",
15     "postalCode": "example"
16   }
17 }

Example response

1 {
2   "data": {
3     "addCustomerAddress": {
4       "address": {
5         "entityId": 0,
6         "firstName": "example",
7         "lastName": "example",
8         "address1": "example",
9         "address2": "example",
10         "addressType": "COMMERCIAL",
11         "city": "example",
12         "country": "example",
13         "countryId": 0,
14         "countryCode": "example"
15       },
16       "errors": [
17         {
18           "message": "example"
19         }
20       ]
21     }
22   }
23 }

Submit a customer address.

Arguments

reCaptchaV2ObjectOptional

Recaptcha token.

inputObjectRequired

Input for adding a customer address.

Returns

an Object

errorslist of Objects

List of response errors when attempting to submit an address.

addressObject

Customer address that was created.