AddressValidationData Object

Represents address validation rules for a country.

type AddressValidationData {
  countryCode: String!
  countryName: String!
  addressFormat: String!
  addressLatinFormat: String!
  allowedFields: [String!]!
  requiredFields: [String!]!
  upperFields: [String!]!
  countryAreaType: String!
  countryAreaChoices: [ChoiceValue!]!
  cityType: String!
  cityChoices: [ChoiceValue!]!
  cityAreaType: String!
  cityAreaChoices: [ChoiceValue!]!
  postalCodeType: String!
  postalCodeMatchers: [String!]!
  postalCodeExamples: [String!]!
  postalCodePrefix: String!
}

Fields

countryCode

countryCode · String!

The country code of the address validation rule.

countryName

countryName · String!

The country name of the address validation rule.

addressFormat

addressFormat · String!

The address format of the address validation rule.

Many fields in the JSON refer to address fields by one-letter abbreviations. These are defined as follows:

• N: Name
• O: Organization
• A: Street Address Line(s)
• D: Dependent locality (may be an inner-city district or a suburb)
• C: City or Locality
• S: Administrative area such as a state, province, island etc
• Z: Zip or postal code
• X: Sorting code

Click here for more information.

addressLatinFormat

addressLatinFormat · String!

The latin address format of the address validation rule.

Many fields in the JSON refer to address fields by one-letter abbreviations. These are defined as follows:

• N: Name
• O: Organization
• A: Street Address Line(s)
• D: Dependent locality (may be an inner-city district or a suburb)
• C: City or Locality
• S: Administrative area such as a state, province, island etc
• Z: Zip or postal code
• X: Sorting code

Click here for more information.

allowedFields

allowedFields · [String!]!

The allowed fields to use in address.

requiredFields

requiredFields · [String!]!

The required fields to create a valid address.

upperFields

upperFields · [String!]!

The list of fields that should be in upper case for address validation rule.

countryAreaType

countryAreaType · String!

The formal name of the county area of the address validation rule.

countryAreaChoices

countryAreaChoices · [ChoiceValue!]!

The available choices for the country area of the address validation rule.

cityType

cityType · String!

The formal name of the city of the address validation rule.

cityChoices

cityChoices · [ChoiceValue!]!

The available choices for the city of the address validation rule.

cityAreaType

cityAreaType · String!

The formal name of the city area of the address validation rule.

cityAreaChoices

cityAreaChoices · [ChoiceValue!]!

The available choices for the city area of the address validation rule.

postalCodeType

postalCodeType · String!

The formal name of the postal code of the address validation rule.

postalCodeMatchers

postalCodeMatchers · [String!]!

The regular expression for postal code validation.

postalCodeExamples

postalCodeExamples · [String!]!

The example postal code of the address validation rule.

postalCodePrefix

postalCodePrefix · String!

The postal code prefix of the address validation rule.

Used by

• addressValidationRules (queries)

Schema: Saleor 3.23.43. Download SDL.