checkout_rates

Calculate checkout rates

Changed on

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

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/checkout_rates/{config_id}/quotes
  • Auth: API key in header API-Key

Request body

currencystring

The currency to return rates in.

Example request

{
  "ship_from": {
    "address_type": "commercial",
    "address_line1": "500 Warehouse Rd",
    "address_line2": "Dock 4",
    "address_line3": "Bay 9",
    "city_locality": "Austin",
    "state_province": "TX",
    "postal_code": "78702",
    "country_code": "US"
  },
  "ship_to": {
    "address_type": "residential",
    "address_line1": "525 S Winchester Blvd",
    "address_line2": "Suite 200",
    "address_line3": "Apt 12",
    "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",
      "delivery_prediction": {
        "delivery_date": "2026-07-04",
        "confidence_level": "high"
      }
    }
  ],
  "created_at": "2026-06-24T10:00:00Z"
}

Changes

  • e998dffc42beRevision changes
    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

  • ebc167d776b5Revision changes
    • info

      added the optional property // to the response with the status