mutation

validateAddress

Validate addresses using specific templates customized for each country and tailored to various business scenarios. This validation ensures that the data conforms to the information currently stored in the system.
Arguments
countryIsoCode
String
The ISO 3166-1 alpha-2 code representing the country (e.g., "IN" for India, "US" for the United States).
templateName
templateNameEnum
The type of address form.
validateAddressRequestInput
ValidateAddressRequestInput
Validate the detail of a given address.
Response
address
String
Complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode.
address1
String
First line of the address, typically containing street or building information.
address2
String
Second line of the address, which can be used for additional address details if needed.
area
String
Locality or area associated with the address.
landmark
String
Prominent nearby landmark that aids in locating the address.
pincode
String
Postal code or PIN code of the address area.
sector
String
Specifies the sector or district of the address if applicable.
city
String
Denote the city or municipality of the address.
state
String
Indicates the state or province of the address.
name
String
Recipient's name associated with the address.
phone
String
Recipient's contact phone number.
email
String
Recipient's email address.
Mutation
1mutation validateAddress(
2 $countryIsoCode: String
3 $templateName: templateNameEnum
4 $validateAddressRequestInput: ValidateAddressRequestInput
5) {
6 validateAddress(
7 countryIsoCode: $countryIsoCode
8 templateName: $templateName
9 validateAddressRequestInput: $validateAddressRequestInput
10 ) {
11 address
12 address1
13 address2
14 area
15 landmark
16 pincode
17 sector
18 city
19 state
20 name
21 phone
22 email
23 }
24}
Try it
Input Variables
1{
2 "countryIsoCode": "countryIsoCode",
3 "templateName": "checkout_form",
4 "validateAddressRequestInput": {
5 "address": "2832 Sesame Street",
6 "address1": "address1",
7 "address2": "address2",
8 "area": "area",
9 "landmark": "landmark",
10 "pincode": "pincode",
11 "sector": "sector",
12 "city": "Montreal",
13 "state": "Quebec",
14 "name": "A name",
15 "phone": "1+ 418-323-4236",
16 "email": "test-email@yourcompany.com"
17 }
18}
Response
1{
2 "validateAddress": {
3 "address": "2832 Sesame Street",
4 "address1": "address1",
5 "address2": "address2",
6 "area": "area",
7 "landmark": "landmark",
8 "pincode": "pincode",
9 "sector": "sector",
10 "city": "Montreal",
11 "state": "Quebec",
12 "name": "A name",
13 "phone": "1+ 418-323-4236",
14 "email": "test-email@yourcompany.com"
15 }
16}