addressValidate

Queryin Cart

Validate a shipping or billing address for correctness and formatting

Arguments

Argument	Type	Description
`address`	`AddressInput!`

Returns

AddressValidationResult

Field	Type	Description
`valid`	`Boolean!`
`suggestions`	`[AddressSuggestion]`

Example

Query
Response

query {
    addressValidate(address: {
      givenName: "John"
      familyName: "Doe"
      streetName: "Main Street"
      streetNumber: "123"
      city: "Amsterdam"
      postalCode: "1000AA"
      country: "NL"
    }) {
      valid
      suggestions {
        streetName
        city
        postalCode
      }
    }
  }

{
  "data": {
    "addressValidate": {
      "valid": true,
      "suggestions": [
        {
          "streetName": "Example",
          "city": "Example",
          "postalCode": "Example"
        }
      ]
    }
  }
}

The query is the example the schema documents. The response shows its shape with placeholder values.

Served by

@evolve-framework/commercetools	Not resolved
@evolve-framework/medusa	Not resolved
@evolve-framework/sfcc	Not resolved