Fields

default : String

Pre-filled seed value shown before any user interaction. Null if not set.
errors : [String!]! required

Validation error messages for this field. Empty when the field is valid or no validation has been run.
fieldType : AddressFieldTypeEnum! required

Input widget type to render for this field.
hasAutocomplete : Boolean! required

Whether this field's SELECT options are fetched via the autocompleteAddressFieldOptions query rather than inlined in options. When true, options is empty and the client should call that query with this field's name.
label : String! required

Country-specific human-readable label, e.g. 'Suburb' or 'Postcode'.
name : String! required

Machine identifier for the field, e.g. 'locality' or 'postal_code'.
options : [AddressFieldOptionType!]

Available options for SELECT fields with a fixed option list. Empty for autocompletable SELECT fields (see hasAutocomplete); fetch those via the autocompleteAddressFieldOptions query instead. Null for all other field types.
userEditable : Boolean! required

Whether the user can interact with this field. False for hidden fields.
validation : AddressFieldValidationRuleType! required

Client-side validation constraints for this field.
value : String

Submitted or pre-loaded form value. Null if not set.
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.

Example

{ "default": "debate-current-guess-star-become", "errors": "send-bed-off-fund-dinner", "fieldType": "TEXT", "hasAutocomplete": true, "label": "whom-American-cost-society-often", "name": "TV-early-big-particularly-space", "options": [AddressFieldOptionType], "userEditable": true, "validation": AddressFieldValidationRuleType, "value": "begin-detail-space-I-environmental" }