Radial Integration | 2016

Retail Order Management > Address Validation > Address Validation API

Address Validation API

For overview information and a list of supported countries, see Address Validation.

For a step-by-step guide to this API, see How to Build an Address Validation API Request.

Address Validation URI Summary

The Address Validation URI uses the service identifier address.

Operation

Action

URI Template

URI Example

Transaction Type

Non-URI Request / Payload

Response

validate

POST

/vM.m/stores/STOREID/address/validate.format

/v1.0/stores/ABCD/address/validate.xml

Validate an address for deliverability

XML

200 + XML response

Schemas

Address Validation Response Codes

Code

Description

V

Address validated – the submitted address was correct and / or standardized
S Address was standardized and is deliverable. Can be updated without informing customer

C

Address was corrected, there are suggested addresses

K

Address was checked but could not be corrected, suggested addresses have a higher probability of delivery

N

Address could not be validated, address validation service does not suppor the address country

U

Unable to contact provider

T

Provider timeout

P

Provider returned a system error message (check the providerErrorText field value for details)

M

Address validation request was malformed or contained invalid data

Address Validation URI Example

Validate an address for deliverability

AddressValidationRequest receives a AddressValidationResponse

Request XML 

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <Header>
    <MaxAddressSuggestions>##MAX_SUGGESTIONS##</MaxAddressSuggestions>
  </Header>
  <Address>
    <Line1>##LINE_1##</Line1>
    <Line2>##LINE_2##</Line2>  <!-- optional -->
    <Line3>##LINE_3##</Line3>  <!-- optional -->
    <Line4>##LINE_4##</Line4>  <!-- optional -->
    <City>##CITY##</City>
    <MainDivision>##MAIN_DIVISION##</MainDivision>
    <CountryCode>##COUNTRY_CODE##</CountryCode>
    <PostalCode>##POSTAL_CODE##</PostalCode>
  </Address>
</AddressValidationRequest>

Response XML 

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <Header>
        <MaxAddressSuggestions>5</MaxAddressSuggestions>
    </Header>
    <RequestAddress>
        <Line1>9193 18th St</Line1>
        <City>Auburn</City>
        <MainDivision>NY</MainDivision>
        <CountryCode>US</CountryCode>
        <PostalCode>13021-0123</PostalCode>
        <FormattedAddress>9193 18th St
            Auburn NY 13021-0123
            US
        </FormattedAddress>
    </RequestAddress>
    <Result>
        <ResultCode>V</ResultCode>
        <ResultSuggestionCount>0</ResultSuggestionCount>
    </Result>
</AddressValidationResponse>

Mock Data Examples for Testing

The specific data examples listed below can be used in Radial's test environment to elicit the specified response codes. XML files follow for each example scenario.

Address Validation Response Code

Request Address

Response

C

Address line 1: 1st Ave

City: King of Prussia

Main Division: PA

Postal Code: 19406

Country code: US

3 Suggestions

M

Address line 1: Invalid Data Test

City: King of Prussia

Main Division: PA

Postal Code: 19406

Country code: US

No suggestion

N

Address line 1:   Not supported Test

City: King of Prussia

Main Division: PA

Postal Code: 19406

Country code: US

No suggestion

P

Address line 1: Provider error Test

City: King of Prussia

Main Division: PA

Postal Code: 19406

Country code: US

No suggestion

T

Address line 1: 630 Allendale Road

City: King of Prussia

Main Division: PA

Postal Code: 19406

Country code: US

No suggestion

U

Address line 1:   Unable to contact Test

City: King of Prussia

Main Division: PA

Postal Code: 19406

Country code: US

No suggestion

V

Address line 1: 935 First Ave

City: King of Prussia

Main Division: PA

Postal Code: 19406

Country code: US

Please use request address section from Address validation service response. It will have standardized address (like 9 digit zip code)

Example Request for C Response Code

Use this message, with its specific mocked data, in the Radial test environment to receive a Response Code of C. 

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <Address>
      <Line1>1st Ave</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </Address>
</AddressValidationRequest>

Example C Response

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <RequestAddress>
      <Line1>1st Ave</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </RequestAddress>
   <Result>
      <ResultCode>C</ResultCode>
      <ErrorLocations>
         <ErrorLocation>AddressLine1</ErrorLocation>
         <ErrorLocation>City</ErrorLocation>
      </ErrorLocations>
      <ResultSuggestionCount>3</ResultSuggestionCount>
      <SuggestedAddresses>
         <SuggestedAddress>
            <Line1>100 1st Ave</Line1>
            <City>King of Prussia</City>
            <MainDivision>PA</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>19406</PostalCode>
            <FormattedAddress>100 1st Ave, King of Prussia PA 19406, US</FormattedAddress>
            <ErrorLocations>
               <ErrorLocation>AddressLine1</ErrorLocation>
               <ErrorLocation>City</ErrorLocation>
            </ErrorLocations>
         </SuggestedAddress>
         <SuggestedAddress>
            <Line1>120 1st Ave</Line1>
            <City>King of Prussia</City>
            <MainDivision>PA</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>19406</PostalCode>
            <FormattedAddress>120 1st Ave, King of Prussia PA 19406, US</FormattedAddress>
            <ErrorLocations>
               <ErrorLocation>AddressLine1</ErrorLocation>
               <ErrorLocation>City</ErrorLocation>
            </ErrorLocations>
         </SuggestedAddress>
         <SuggestedAddress>
            <Line1>935 1st Ave</Line1>
            <City>King of Prussia</City>
            <MainDivision>PA</MainDivision>
            <CountryCode>US</CountryCode>
            <PostalCode>19406</PostalCode>
            <FormattedAddress>935 1st Ave, King of Prussia PA 19406, US</FormattedAddress>
            <ErrorLocations>
               <ErrorLocation>AddressLine1</ErrorLocation>
               <ErrorLocation>City</ErrorLocation>
            </ErrorLocations>
         </SuggestedAddress>
      </SuggestedAddresses>
   </Result>
</AddressValidationResponse>

Example Request for M Response Code

Use this message, with its specific mocked data, in the Radial test environment to receive a Response Code of M. 

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <Address>
      <Line1>Invalid Data Test</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </Address>
</AddressValidationRequest>

Example M Response

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <RequestAddress>
      <Line1>Invalid Data Test</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </RequestAddress>
   <Result>
      <ResultCode>M</ResultCode>
      <ResultSuggestionCount>0</ResultSuggestionCount>
   </Result>
</AddressValidationResponse>

Example Request for N Response Code

Use this message, with its specific mocked data, in the Radial test environment to receive a Response Code of N. 

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <Address>
      <Line1>Not supported Test</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </Address>
</AddressValidationRequest>

Example N Response

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <RequestAddress>
      <Line1>Not supported Test</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </RequestAddress>
   <Result>
      <ResultCode>N</ResultCode>
      <ResultSuggestionCount>0</ResultSuggestionCount>
   </Result>
</AddressValidationResponse>

Example Request for P Response Code

Use this message, with its specific mocked data, in the Radial test environment to receive a Response Code of P. 

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <Address>
      <Line1>Provider error Test</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </Address>
</AddressValidationRequest>

Example P Response

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <RequestAddress>
      <Line1>Provider error Test</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </RequestAddress>
   <Result>
      <ResultCode>P</ResultCode>
      <ResultSuggestionCount>0</ResultSuggestionCount>
   </Result>
</AddressValidationResponse>

Example Request for T Response Code

Use this message, with its specific mocked data, in the Radial test environment to receive a Response Code of T. 

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <Address>
      <Line1>630 Allendale Road</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </Address>
</AddressValidationRequest>

Example T Response

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <RequestAddress>
      <Line1>630 Allendale Road</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </RequestAddress>
   <Result>
      <ResultCode>T</ResultCode>
      <ResultSuggestionCount>0</ResultSuggestionCount>
   </Result>
</AddressValidationResponse>

Example Request for U Response Code

Use this message, with its specific mocked data, in the Radial test environment to receive a Response Code of U. 

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <Address>
      <Line1>Unable to contact Test</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </Address>
</AddressValidationRequest>

Example U Response

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <RequestAddress>
      <Line1>Unable to contact Test</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </RequestAddress>
   <Result>
      <ResultCode>U</ResultCode>
      <ResultSuggestionCount>0</ResultSuggestionCount>
   </Result>
</AddressValidationResponse>

Example Request for V Response Code

Use this message, with its specific mocked data, in the Radial test environment to receive a Response Code of V. 

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <Address>
      <Line1>Unable to contact Test</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406</PostalCode>
   </Address>
</AddressValidationRequest>

Example V Response

<?xml version="1.0" encoding="UTF-8"?>
<AddressValidationResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Header>
      <MaxAddressSuggestions>5</MaxAddressSuggestions>
   </Header>
   <RequestAddress>
      <Line1>935 First Ave</Line1>
      <City>King of Prussia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19406-1418</PostalCode>
   </RequestAddress>
   <Result>
      <ResultCode>V</ResultCode>
      <ResultSuggestionCount>0</ResultSuggestionCount>
   </Result>
</AddressValidationResponse>

 

Copyright © 2017 Radial. All rights reserved.