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

currencystring

The currency to return rates in.

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.

config_idstring

The configuration the rates were calculated against.

created_atstring date-time

When the quote was calculated.

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"
}

Changes

Changed in 1 of the 6 revisions of this API.18

Aug 15, 2026f3a66d20456518See the full diff
- ●
  added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history