Estimate
The Estimate resource allows a user to retrieve the estimated cost of shipping a single package based on weight, dimensions, entry point, destination, and other parameters. Only the "Standard" shipping method will be present and used by default as shipping_methods is deprecated.
Note: Requests should provide as many parameters as possible to receive more accurate estimates.
Actions
GET /estimate |
Retrieves an estimate |
Properties
currency |
|
entry_point |
|
services |
{
"services": [
{
"chargeable_weight": 0.412,
"exit_point": "LAX",
"gross_weight": 0.25,
"insurance": {
"coverage": 30,
"fee": 0
},
"oversize_fee": 0,
"service": "BoxC Parcel",
"shipping_methods": [
[
{
"code": "",
"cost": 3.55,
"method": "Standard",
"total_cost": 3.55
}
]
],
"surcharge": 0.75,
"tax": 0,
"terms": [
"DDU"
],
"transit_min": 5,
"transit_max": 10,
"volumetric_weight": 0.412
}
]
}
Array - A list of services and their estimated price and transit time. Set by the system. If an empty array is returned then there are currently no services available for the given route.
carrier: String - The last mile carrier the shipment will use for delivery.
service: String - The shipping service. shipping_methods: Deprecated Array - The shipping methods available for this service.
tax: Deprecated Decimal - Always 0 for estimate. Tax and duty are calculated when creating a shipment. terms: Array - Acceptable incoterms for this route. transit_min: Integer - Estimated minimum transit time in days. transit_max: Integer - Estimated maximum transit time in days. volumetric_weight: Decimal - The volumetric weight based on the requested dimensions and route's divisor. |
GET
/estimate
Retrieves an estimate
carrier |
The last mile carrier the shipment should use for delivery. Optional. Default is null. |
country |
The destined country in ISO 3166-1 alpha-2 format. Required. |
currency |
The ISO 4217 currency code for the value parameter and rates that are returned. Default is USD. |
dg_codes |
A string or array of dangerous good codes contained in the shipment. Not required. |
entry_point |
The code for the drop off location. See Entry Points for a list of codes. Required. |
exit_point |
The IATA port where the shipment should enter for last mile delivery. Providing this limits results to only those routes with the matching port. Optional. Default is null. |
height |
The height of the shipment in CM. Default is 1. |
insurance |
By default all shipments except for BoxC Post include insurance covering up to $30 of the total item value including shipping cost. Setting this to true will raise the insured value for an additional fee. Default: false. |
irregular |
Indicates this shipment was packaged in irregular shaped polybag or soft packaging to assist in calculating the volumetric weight. Default: false. |
is_return |
Indicates this shipment is a return. Optional. Default: false. |
length |
The length of the shipment in CM. Default is 15. |
postal_code |
The destination Postal Code or ZIP Code. Conditional. |
province |
The destination province / state code. Conditional. |
signature_confirmation |
The shipment requires signature confirmation. Default is false. |
terms |
The preferred incoterm reference. Options are DDU or DDP. Default is null. |
value |
The total value of the items to calculate tax and insurance. Default is 0. Use with currency.
|
weight |
The weight of the shipment in KG. Required. |
width |
The width of the shipment in CM. Default is 10. |
request
GET /estimate
entry_point=CVG001&weight=0.345&height=10.5&width=2&length=15&province=CA \ &postal_code=94041&country=US&signature_confirmation=false&value=100 \ ¤cy=CAD&irregular=0&insurance=true&carrier=DHLeC&is_return=false
response
HTTP/1.1 200 OK
{
"estimate": {
"currency": "CAD",
"entry_point": "CVG001",
"services": [
{
"carrier": "DHLeC",
"chargeable_weight": 0.34,
"exit_point": "CVG",
"gross_weight": 0.34,
"insurance": {
"coverage": 100,
"fee": 1.23
},
"oversize_fee": 0,
"service": "BoxC Parcel",
"shipping_methods": [
{
"code": "",
"cost": 5.66,
"method": "Standard",
"total_cost": 5.66
}
],
"surcharge": 0,
"tax": 0,
"terms": [
"DDU"
],
"transit_min": 5,
"transit_max": 10,
"volumetric_weight": 0.053
},
{
"carrier": "DHLeC",
"chargeable_weight": 0.34,
"exit_point": "CVG",
"gross_weight": 0.34,
"insurance": {
"coverage": 100,
"fee": 1.23
},
"oversize_fee": 0,
"service": "BoxC Plus",
"shipping_methods": [
{
"code": "",
"cost": 5.98,
"method": "Standard",
"total_cost": 5.98
}
],
"surcharge": 0,
"tax": 0,
"terms": [
"DDU"
],
"transit_min": 4,
"transit_max": 9,
"volumetric_weight": 0.053
},
{
"carrier": "USPS",
"chargeable_weight": 0.34,
"exit_point": "CVG",
"gross_weight": 0.34,
"insurance": {
"coverage": 100,
"fee": 1.23
},
"oversize_fee": 0,
"service": "BoxC Priority",
"shipping_methods": [
{
"code": "",
"cost": 6.76,
"method": "Standard",
"total_cost": 6.76
}
],
"surcharge": 0.75,
"tax": 0,
"terms": [
"DDU"
],
"transit_min": 3,
"transit_max": 6,
"volumetric_weight": 0.053
}
]
}
}
request
GET /estimate
entry_point=SZX002&weight=0.3&country=CN&dg_code[]=0967&dg_code[]=0970 \ &value=50¤cy=USD&exit_point=SZX&is_return=false
response
HTTP/1.1 200 OK
{
"estimate": {
"currency": "USD",
"entry_point": "SZX002",
"services": [
{
"carrier": "SFC",
"chargeable_weight": 0.3,
"exit_point": "SZX",
"gross_weight": 0.3,
"insurance": {
"coverage": 0,
"fee": 0
},
"oversize_fee": 0,
"service": "BoxC Post",
"shipping_methods": [
{
"code": "",
"cost": 2.98,
"method": "Standard",
"total_cost": 2.98
}
],
"surcharge": 0,
"tax": 0,
"terms": [
"DDU"
],
"transit_min": 3,
"transit_max": 7,
"volumetric_weight": 0.125
}
]
}
}