...
Retailers can call FAVS API at the time of label printing to make sure the label is printed for the correct address. Printing labels for incorrect addresses can lead to delivery delays, additional shipping spend to correct addresses and in the worst case, return the package back to the warehouse.
API Details
Resource Name | Fenix Address Validation and Standardization |
Resource URL | /fenixaddressvalidate/api/v1/address/validate |
Method | POST |
Params (query/path) | |
Headers | store_name |
Request Payload | { "address1": "xyz", "address2": "47 W Broadway", "city": "Bangor", "state": "", "country": "", "zipCode": "04401" } |
Response Payload | { "error": { "code": "SUCCESS", "identifier": 200, "description": "We found a better match for your address" }, "originalAddress": { "address1": "47 W Broadway", "address2": "Apt #1", "city": "Bangor", "state": "NV", "country": "US", "zipCode": "04401" }, "proposedAddresses": [ { "address1": "47 W Broadway", "address2": "Apt #1", "city": "BANGOR", "state": "ME", "country": "US", "zipCode": "04401", "zipCode4": "4502", "metainfo": { "deliverable": true, "business": true, "vacant": false, "cmrvIndicator": false, "partialAddressIndicator": false, } } ] } |
Response Status | 200 - Success 400 - Failure |
...
In partial address validation use cases, Fenix takes care of the below things.
S No | Description | Definition |
1 | Zip Code Corrected | The address was found to have a different 5-digit Zip Code than given in the submitted list. The correct Zip Code is shown in the output address. |
2 | City / State Spelling Corrected | The spelling of the city name and/or state abbreviation in the submitted address was found to be different from the standard spelling. The standard spelling of the city name and state abbreviation are shown in the output address. |
3 | Street Name Changed | The spelling of the street name was changed in order to achieve a match. |
4 | Apartment number missing | Incorrect apartment number or missing apartment number |
...
When the address has some fields corrected or missing in it, Fenix populates an indicator that suggests what part of the address is corrected or missing. The possible values are as follows.
Indicator | Description |
A | Zip Code corrected |
B | City or State name corrected |
H | Missing apartment number |
M | Street name changed |