Address
Address are used to represent people, places, and organizations in a number of contexts. As a fundamental element for a shipment and other relevant services by EzeeShip.com, addresses should be created before a shipment can be created. For instance, ToAddress and FromAddress are required to generate shipment and calculate shipping rates.
EzeeShip.com also offers verification tools that can be used to detect deliverability issues, correct minor errors in spelling\/formatting, and determine if an address is residential or not (which has a significant effect on Shipment rating for many carriers).
Address Object
| Attributes | Definitions |
|---|---|
| countryCode | ISO 3166-1-alpha-2 code (ISO 2 country code) |
| stateCode | State values are only required for shipments from the United States and Canada (most carriers only accept two-character state abbreviations). However, to receive more accurate quotes, passing it is generally recommended. |
| personName | Name of the person |
| company | Name of the organization |
| city | City the address is located in |
| addressLine1 | First line of the address, can't be more than 35 characters |
| addressLine2 | Second line of the address, can't be more than 35 characters |
| state | Name or Code of the state or province the address is located in |
| zipCode | ZIP or postal code the address is located in |
| phone | Phone number to reach the person or organization |
| Email to reach the person or organization | |
| isValid | Whether the address is verified (true:verified; false:not verified) |
| isResidential | Whether the address is a residential address (true:residential; false:not residential) |
Validate Address
Verifying an Address before shipment is an effective way to reduce issues during delivery.
If there are minor errors in spelling\/format in the address, our server will automatically amend it, and determine whether it is residential.
endpoint : https://ezeeship.com/api/ezeeship-openapi/address/validate
Verify Address Sample
POST : https://ezeeship.com/api/ezeeship-openapi/address/validate
{
"countryCode":"US",
"stateCode":"CA",
"city":"San Francisco",
"addressLine1":"215 Clayton St.",
"addressLine2":"1092,IFC",
"zipCode":"94117"
}
Response :
{
"result": "OK",
"message": "",
"data": {
"countryCode": "US",
"stateCode": "CA",
"city": "San Francisco",
"addressLine1": "215 Clayton St.",
"addressLine2":"1092,IFC",
"isResidential": false,
"zipCode": "94117",
"isValid": true
}
}