Get shipment rates
Changed onGet Rates for the shipment information associated with the shipment ID
Request
- Base URLhttps://api.shipstation.com
- URLhttps://api.shipstation.com/v2/shipments/{shipment_id}/rates
- AuthAPI 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": {
"amount": 12
},
"insurance_amount": {
"amount": 12
},
"confirmation_amount": {
"amount": 12
},
"other_amount": {
"amount": 12
},
"requested_comparison_amount": {
"amount": 12
},
"tax_amount": {
"amount": 12
},
"zone": 6,
"package_type": "package",
"delivery_days": 5,
"guaranteed_service": true,
"estimated_delivery_date": "2018-09-23T00:00:00Z",
"carrier_delivery_days": "22",
"delivery_prediction": {
"delivery_date": "2026-07-04",
"confidence_level": "high"
},
"ship_date": "2024-10-22T00:00:00Z",
"negotiated_rate": true,
"service_type": "next_day",
"service_code": "usps_priority_mail_express",
"trackable": true,
"carrier_code": "stamps_com",
"carrier_nickname": "Free",
"carrier_friendly_name": "free",
"rate_details": [
{
"rate_detail_type": "shipping",
"carrier_description": "Shipping",
"carrier_billing_code": "BaseServiceCharge",
"amount": {
"amount": 12
},
"billing_source": "carrier"
}
],
"carrier_weight": {
"value": 23
}
}
],
"invalid_rates": [
{
"rate_id": "se-28529731",
"carrier_id": "se-28529731",
"shipping_amount": {
"amount": 12
},
"insurance_amount": {
"amount": 12
},
"confirmation_amount": {
"amount": 12
},
"other_amount": {
"amount": 12
},
"requested_comparison_amount": {
"amount": 12
},
"tax_amount": {
"amount": 12
},
"zone": 6,
"package_type": "package",
"delivery_days": 5,
"guaranteed_service": true,
"estimated_delivery_date": "2018-09-23T00:00:00Z",
"carrier_delivery_days": "22",
"delivery_prediction": {
"delivery_date": "2026-07-04",
"confidence_level": "high"
},
"ship_date": "2024-10-22T00:00:00Z",
"negotiated_rate": true,
"service_type": "next_day",
"service_code": "usps_priority_mail_express",
"trackable": true,
"carrier_code": "stamps_com",
"carrier_nickname": "Free",
"carrier_friendly_name": "free",
"rate_details": [
{
"rate_detail_type": "shipping",
"carrier_description": "Shipping",
"carrier_billing_code": "BaseServiceCharge",
"amount": {
"amount": 12
},
"billing_source": "carrier"
}
],
"carrier_weight": {
"value": 23
}
}
],
"rate_request_id": "se-28529731",
"shipment_id": "se-28529731",
"created_at": "2018-09-23T15:00:00.000Z",
"errors": [
{
"message": "Body of request cannot be null.",
"field_name": "inventory_warehouse_id",
"field_value": "invalid-id"
}
]
}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
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
- breaking
the response property
////became nullable for the status - breaking
the response property
////became nullable for the status - breaking
the response property
////became nullable for the status - breaking
the response property
////became nullable for the status - breaking
the response property
////became nullable for the status - breaking
the response property
////became nullable for the status - breaking
the response property
////became nullable for the status - breaking
the response property
////became nullable for the status - breaking
added
subschema #2to the////response propertyoneOflist for the response status - breaking
added
subschema #2to the////response propertyoneOflist for the response status - info
removed from the
////response propertyallOflist for the response status - info
removed from the
////response propertyallOflist for the response status
- breaking