BigCommerce Docs

mutation ExampleMutation($reCaptchaV2: ReCaptchaV2Input, $input: AddCustomerAddressInput) {
  addCustomerAddress(reCaptchaV2: $reCaptchaV2, input: $input) {
    address {
      entityId
      firstName
      lastName
      address1
      address2
      addressType
      city
      country
      countryId
      countryCode
    }
    errors
  }
}

{
  "reCaptchaV2": {
    "token": "example"
  },
  "input": {
    "firstName": "example",
    "lastName": "example",
    "address1": "example",
    "address2": "example",
    "city": "example",
    "company": "example",
    "countryCode": "example",
    "stateOrProvince": "example",
    "phone": "example",
    "postalCode": "example"
  }
}

{
  "data": {
    "addCustomerAddress": {
      "address": {
        "entityId": 0,
        "firstName": "example",
        "lastName": "example",
        "address1": "example",
        "address2": "example",
        "addressType": "COMMERCIAL",
        "city": "example",
        "country": "example",
        "countryId": 0,
        "countryCode": "example"
      },
      "errors": [
        {
          "message": "example"
        }
      ]
    }
  }
}

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.