Get the Shipping Score for a particular address.
Staging address is : https://staging.shippingscore.com/v1
NEW: The REST call returns the addresses rdi value and whether the address is active by the USPS (Domestic, only).
See below for return values.
NEW
The REST call returns the addresses rdi value and whether the address is active by the USPS (Domestic, only).
See below for return values.
Apikey
Make sure to keep your apikey private!
Once you setup a staging account you can change the endpoint to:
https://staging.shippingscore.com/v1
Examples
'Staging
curl --get --include "https://staging.shippingscore.com/v1/score?apikey=[APIKEY]&addressline1=<required>&addressline2=&city=<required>&state=&postalcode=&country=<required>&format="
'Production
curl --get --include "https://api.shippingscore.com/v1/score?apikey=[APIKEY]&addressline1=<required>&addressline2=&city=<required>&state=&postalcode=&country=<required>&format="
'Staging
https://staging.shippingscore.com/v1/score?addressline1=&addressline2=&city=&state=&postalcode=&country=&apikey=[YOUR API KEY]&format=
'Production
https://api.shippingscore.com/v1/score?addressline1=&addressline2=&city=&state=&postalcode=&country=&apikey=[YOUR API KEY]&format=
Returned ShippingScore Values and Definitions
| ShippingScore | Definition | Color |
|---|---|---|
| 0 | There is no record of this address. | White |
| 1 | There was an address match, but there are no risk factors. | Green |
| 2 | There was an address match and there is a minor risk. | Yellow |
| 3 | There was an address match and there is a moderate risk. | Orange |
| 4 | There was an address match and there is a significant risk. | Red |
Customize the ShippingScore return values
We provide a simple 0-4 scale but we encourage you to create your own scale.
For example:
- 0%-100% scale
- 0-100 point scale
- Color scale
- Combination of color and rating
Returned Suggestions Values and Definitions - comma delimited
| Suggestions |
|---|
| Verify Address |
| Signature Required |
| Verify Sufficient Packaging |
| Verify Recipient Name |
| Ship with Tracking |
| Verify Completed Payment |
| Verify Your Return Policy |
| Verify Package Contents |
| Verify Weather at Destination |
rdi Values
RDI means Residential Delivery Indicator. It indicates whether an address is a residential or commercial location as per the USPS.
| Values |
|---|
| residential |
| commercial |
| unknown |
uspsactive Values
Indicates whether the address is active, or "in-service" according to the USPS.
| Values | Description |
|---|---|
| Y | Yes |
| N | No |
| "blank" | Unknown |
WeatherScore
The returned WeatherScore is separate than the ShippingScore. It indicates if the weather at the shipping destination will be sever in the next 7 days.
WeatherScore results are 1 or 2.
For example, if the return ShippingScore for an address is "1", but there is a Tsunami in the weather forecast, the WeatherScore will be "2" and the suggestion can be "Verify Weather at Destination".
WeatherScore Values
| WeatherScore | Reason |
|---|---|
| 1 | There is no severe weather in the forecast. |
| 2 | There IS severe weather in the forecast. |