Get shipment rates
Changed onGet Rates for the shipment information associated with the shipment ID
Request
- Base URL: https://api.shipengine.com
- URL: https://api.shipengine.com/v1/shipments/{shipment_id}/rates
- Auth: API key in header API-Key
Query parameters
Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
Response
The request was a success.
Example response
{
"rates": [
{
"rate_id": "se-28529731",
"carrier_id": "se-28529731",
"shipping_amount": {
"currency": "USD"
},
"insurance_amount": {
"currency": "USD"
},
"confirmation_amount": {
"currency": "USD"
},
"other_amount": {
"currency": "USD"
},
"requested_comparison_amount": {
"currency": "USD"
},
"tax_amount": {
"currency": "USD"
},
"rate_details": [
{
"carrier_description": "Shipping",
"carrier_billing_code": "BaseServiceCharge",
"amount": {
"currency": "USD"
},
"rate_detail_attributes": {
"tax_type": "vat"
},
"billing_source": "carrier"
}
],
"zone": 6,
"package_type": "package",
"delivery_days": 5,
"estimated_delivery_date": "2018-09-23T00:00:00.000Z",
"delivery_prediction": {
"delivery_date": "2026-07-04",
"confidence_level": "high"
}
}
],
"invalid_rates": [
{
"rate_id": "se-28529731",
"carrier_id": "se-28529731",
"shipping_amount": {
"currency": "USD"
},
"insurance_amount": {
"currency": "USD"
},
"confirmation_amount": {
"currency": "USD"
},
"other_amount": {
"currency": "USD"
},
"requested_comparison_amount": {
"currency": "USD"
},
"tax_amount": {
"currency": "USD"
},
"rate_details": [
{
"carrier_description": "Shipping",
"carrier_billing_code": "BaseServiceCharge",
"amount": {
"currency": "USD"
},
"rate_detail_attributes": {
"tax_type": "vat"
},
"billing_source": "carrier"
}
],
"zone": 6,
"package_type": "package",
"delivery_days": 5,
"estimated_delivery_date": "2018-09-23T00:00:00.000Z",
"delivery_prediction": {
"delivery_date": "2026-07-04",
"confidence_level": "high"
}
}
],
"rate_request_id": "se-28529731",
"shipment_id": "se-28529731",
"created_at": "2018-09-23T15:00:00.000Z",
"errors": [
{
"error_source": "shipengine",
"error_type": "validation",
"error_code": "invalid_field_value",
"message": "Body of request cannot be null.",
"carrier_id": "se-28529731",
"carrier_code": "dhl_express",
"field_name": "shipment.ship_to.phone_number"
}
]
}Changes
- warning
added the new
bring_your_own_label_not_supportedenum value to the///response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the///response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the///response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status
- warning
- breaking
the
//response's property type changed from no type toobjectfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
/////response's property type changed from no type toobjectfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
/////response's property type changed from no type toobjectfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
//////response's property type changed from no type tostringfor status - breaking
the
/////response's property type changed from no type tostringfor status - breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
/response's property type changed from no type toobjectfor status - warning
added the new
best_valueenum value to the/////response property for the response status - warning
added the new
cheapestenum value to the/////response property for the response status - warning
added the new
fastestenum value to the/////response property for the response status - warning
added the new
gramenum value to the//////response property for the response status - warning
added the new
gramenum value to the//////response property for the response status - warning
added the new
kilogramenum value to the//////response property for the response status - warning
added the new
kilogramenum value to the//////response property for the response status - warning
added the new
ounceenum value to the//////response property for the response status - warning
added the new
ounceenum value to the//////response property for the response status - warning
added the new
poundenum value to the//////response property for the response status - warning
added the new
poundenum value to the//////response property for the response status - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
/////response propertyallOflist for the response status - info
removed from the
/////response propertyallOflist for the response status - info
removed from the
/////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
removed from the
//////response propertyallOflist for the response status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status
- breaking