checkout_rates
Calculate checkout rates
Calculate the shipping rates a buyer should see at checkout for the given destination and cart, using the delivery options defined on the configuration. The response contains one rate per delivery option that produced a price, and each rate carries its own quote_id that can be retrieved later with Get a checkout rate quote.
post/v1/checkout_rates/{config_id}/quotes
Request body
Example request
{
"ship_to": {
"address_type": "residential",
"address_line1": "525 S Winchester Blvd",
"address_line2": "Suite 200",
"city_locality": "San Jose",
"state_province": "CA",
"postal_code": "95128",
"country_code": "US"
},
"items": [
{
"name": "T-Shirt",
"quantity": 2,
"sku": "SKU-1234",
"price": 19.99
}
],
"currency": "USD"
}Response
The calculated rates for the cart.
Example response
{
"config_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"rates": [
{
"quote_id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
"option_id": 100001,
"option_name": "Standard Shipping",
"type": "live_rate",
"carrier_id": "se-1234567",
"service_code": "usps_priority_mail",
"final_amount": 10.69,
"currency": "USD",
"estimated_delivery_days": 2,
"estimated_delivery_date": "2026-06-26T00:00:00Z"
}
],
"created_at": "2026-06-24T10:00:00Z"
}