addresses
Arguments
Returns
AddressConnectionTypeConnectionThis field is a connection type. Connections are used to implement cursor based pagination.
Possible Errors
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-7899: An internal error occurred.
- KT-GB-6610: We're sorry but we can't communicate with our address database right now to look up your address. Please try again.
- KT-GB-6611: We couldn't find a match for this postcode. Please verify it and try again.
- KT-GB-6620: Invalid data.
- KT-GB-6621: Invalid data.
Allowed Viewers
Query Complexity
6Examples
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 Addresses(
$after: String,
$before: String,
$dataSource: DataSource,
$first: Int,
$last: Int,
$postcode: String!,
$searchDomesticOnly: Boolean,
$useDes: Boolean
) {
addresses(
after: $after,
before: $before,
dataSource: $dataSource,
first: $first,
last: $last,
postcode: $postcode,
searchDomesticOnly: $searchDomesticOnly,
useDes: $useDes
) {
edgeCount
edges {
...AddressConnectionTypeEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "YXJyYXljb25uZWN0aW9uOjEw=",
"before": "YXJyYXljb25uZWN0aW9uOjEw=",
"dataSource": "CACHE",
"first": 10,
"last": 10,
"postcode": "matter-occur-find-me-ground",
"searchDomesticOnly": true,
"useDes": true
}
Response
{
"data": {
"addresses": {
"edgeCount": 68,
"edges": [AddressConnectionTypeEdge],
"pageInfo": PageInfo,
"totalCount": 42
}
}
}