Get the address field descriptor for a given identifier. The identifier can be an ISO 3166-1 alpha-2 country code (e.g. 'AU', 'GB') or a custom descriptor key configured for the deployment. Returns null if the identifier is not recognised.

Arguments

addressFieldDescriptorId : String!


            required

Address field descriptor identifier. Typically an ISO 3166-1 alpha-2 country code, but may also be a custom descriptor key.

Returns

AddressFieldDescriptorType

Describes the structure of an address form for a given country, including all field groups, field configurations, and validation rules.

Possible Errors

KT-CT-1113: Disabled GraphQL field requested.
KT-CT-7899: An internal error occurred.

Allowed Viewers

Customer

Partner User

Third party

Rate Limits

Key	Steps
`ip`	['10/s']

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Query

query AddressFields($addressFieldDescriptorId: String!) {
  addressFields(addressFieldDescriptorId: $addressFieldDescriptorId) {
    fieldGroups {
      ...AddressFieldGroupTypeFragment
    }
  }
}

Variables

{
  "addressFieldDescriptorId": "16027140"
}

Response

{
  "data": {
    "addressFields": {
      "fieldGroups": [AddressFieldGroupType]
    }
  }
}