addCustomerAddress

Example Query

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

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     "customer": {
4       "addCustomerAddress": {
5         "address": {
6           "entityId": 0,
7           "firstName": "example",
8           "lastName": "example",
9           "address1": "example",
10           "address2": "example",
11           "addressType": "COMMERCIAL",
12           "city": "example",
13           "country": "example",
14           "countryId": 0,
15           "countryCode": "example"
16         },
17         "errors": [
18           {
19             "message": "example"
20           }
21         ]
22       }
23     }
24   }
25 }

Submit a customer address.

Arguments

reCaptchaV2ReCaptchaV2InputOptional

Recaptcha token.

inputAddCustomerAddressInputRequired

Input for adding a customer address.

Returns

an AddCustomerAddressResult

errorslist of AddCustomerAddressErrors

List of response errors when attempting to submit an address.

addressCustomerAddress

Customer address that was created.