The Estimate resource allows a user to retrieve the estimated cost of shipping a single package based on weight, dimensions, entry point, and destination. Shipments to states and territories outside the non-contiguous 48 states are charged more. 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

{"currency": "USD"}

String - The currency code of the rates and fees returned by the estimate resource. Always "USD".
entry_point

{"entry_point": "SZXI01"}

String - The drop off location for the shipment. See Entry Points for a list of codes.
services

{
    "services": [
        {
            "chargeable_weight": 0.412,
            "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.

chargeable_weight: Decimal - The greater of the gross weight and volumetric weight.
gross_weight: Decimal - The greater of the requested weight and minimum gross weight for the route.
insurance: Object - Insurance details for this service.

  • coverage: Decimal - The dollar amount covered by the insurance policy.
  • fee: Decimal - The cost of coverage if insured.
oversize_fee: Decimal - The oversize fee for this service if applicable.
service: String - The shipping service.
shipping_methods: Deprecated Array - The shipping methods available for this service.
  • code: String - The unique code for the given service used for selecting the shipping method when creating a shipment. "Standard" methods have an empty string for the code (default).
  • cost: Decimal - The estimated shipping cost for the shipping method.
  • method: String - The name of the shipping method.
  • total_cost: Decimal - The total estimated shipping cost for the shipping method including applicable fees.
surcharge: Decimal - Additional cost for this shipment based on the route and chargeable weight.
tax: Decimal - Tax due for this route.
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
country The destined country in ISO 3166-1 alpha-2 format. Required.
currency The ISO 4217 currency code for the supplied value. 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.
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.
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=CVDI01&weight=0.345&height=10.5&width=2&length=15&province=CA \
&postal_code=94041&country=US&signature_confirmation=false&value=100 \
&currency=USD&irregular=0&insurance=true
response

HTTP/1.1 200 OK

{
    "estimate": {
        "currency": "USD",
        "entry_point": "CVGD01",
        "services": [
            {
                "chargeable_weight": 0.34,
                "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
            },
            {
                "chargeable_weight": 0.34,
                "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
            },
            {
                "chargeable_weight": 0.34,
                "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
response

HTTP/1.1 200 OK

{
    "estimate": {
        "currency": "USD",
        "entry_point": "SZX002",
        "services": [
            {
                "chargeable_weight": 0.3,
                "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
            }
        ]
    }
}