checkout_rates

Get a checkout rate quote

Changed on

Retrieve a previously calculated rate quote, including the destination it was calculated for and the rates that were returned.

Note: Quotes are retained for a limited time. A request for an expired or unknown quote_id returns 404 Not Found.

get/v1/checkout_rates/quotes/{quote_id}

Request

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

Response

The requested rate quote.

config_idstring

The configuration the rate was calculated against.

created_atstring date-time

When the quote was calculated.

Example response

{
  "config_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "quote": {
    "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 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

  • ebc167d776b5Revision changes
    • info

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