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. There may be additional shipping methods for each service depending on the service, entry point, and destination. The "Standard" shipping method will be selected by default when creating a shipment.

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 estimate. Set by the system.
entry_point

{"entry_point": "SZXI01"}

String - The drop off location for the shipment. By default your application's entry point settings are inherited by the shipment. Not required. See Entry Points for a list of codes.
services

{
    "services": [
        {
            "oversize_fee": 0,
            "service": "BoxC",
            "shipping_methods": [
                [
                    {
                        "code": "",
                        "cost": 3.55,
                        "method": "Standard",
                        "total_cost": 3.55
                    }
                ]
            ],
            "transit_min": 5,
            "transit_max": 10
        }
    ]
}

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.

oversize_fee: Decimal - The oversize fee for this service if applicable.
service: String - The shipping service.
shipping_methods: 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.
  • 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.
transit_min: Integer - Estimated minimum transit time in days.
transit_max: Integer - Estimated maximum transit time in days.
GET
/estimate
Retrieves an estimate
city The destination city. Not required.
country The destined country in ISO 3166-1 alpha-2 format. Required.
dg_code 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. Not required.
height The height of the shipment in CM. Default is 1.
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.
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=5&province=CA \
&postal_code=94041&country=US&signature_confirmation=false
response

HTTP/1.1 200 OK

{
    "estimate": {
        "currency": "USD",
        "entry_point": "CVGD01",
        "services": [
            {
                "oversize_fee": 0,
                "service": "BoxC",
                "shipping_methods": [
                    {
                        "code": "",
                        "cost": 5.66,
                        "method": "Standard",
                        "total_cost": 5.66
                    }
                ],
                "transit_min": 5,
                "transit_max": 10
            },
            {
                "oversize_fee": 0,
                "service": "BoxC Plus",
                "shipping_methods": [
                    {
                        "code": "",
                        "cost": 5.98,
                        "method": "Standard",
                        "total_cost": 5.98
                    }
                ],
                "transit_min": 4,
                "transit_max": 9
            },
            {
                "oversize_fee": 0,
                "service": "BoxC Priority",
                "shipping_methods": [
                    {
                        "code": "",
                        "cost": 6.76,
                        "method": "Standard",
                        "total_cost": 6.76
                    },
                    {
                        "code": "FR-FE",
                        "cost": 7.5,
                        "method": "Flat Rate Envelope",
                        "total_cost": 7.5
                    },
                    {
                        "...": "..."
                    }
                ],
                "transit_min": 3,
                "transit_max": 6
            }
        ]
    }
}
request
GET /estimate
entry_point=SZXD01&weight=0.3&country=CN&dg_code[]=0967&dg_code[]=0970
response

HTTP/1.1 200 OK

{
    "estimate": {
        "currency": "USD",
        "entry_point": "SZXD01",
        "services": [
            {
                "oversize_fee": 0,
                "service": "BoxC",
                "shipping_methods": [
                    {
                        "code": "",
                        "cost": 2.98,
                        "method": "Standard",
                        "total_cost": 2.98
                    }
                ],
                "transit_min": 3,
                "transit_max": 7
            }
        ]
    }
}