latestOpenAPI 3.1.0MIT2026-08-221643491.4 MB

d3d8c21cd227

checkout_rates

Calculate checkout rates

<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

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/v2/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,
      "weight": {
        "value": 23
      },
      "dimensions": {
        "length": 2,
        "width": 2,
        "height": 1
      }
    }
  ],
  "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"
}