checkout_rates

Create a checkout rates configuration

Changed on Oct 22, 2026

Create a checkout rates configuration together with its initial delivery options and shared settings. The configuration is returned with a generated config_id and, for each option, a generated option_id.

For live_rate and local_delivery options, each service's carrier_id and service_code are validated and resolved against the carriers connected to your account.

post/v1/checkout_rates

Request

Base URL: https://api.shipengine.com
URL: https://api.shipengine.com/v1/checkout_rates
Auth: API key in header API-Key

Request body

Example request

{
  "options": [
    {
      "name": "Standard Shipping",
      "type": "live_rate",
      "services": [
        {
          "carrier_id": "se-1234567",
          "service_code": "usps_priority_mail"
        }
      ],
      "fee_mode": "add",
      "fee_percentage": 10,
      "fallback_mode": "flat_rate",
      "fallback_rate_amount": 5,
      "fallback_rate_currency": "USD",
      "fallback_percentage": 5,
      "amount": 4.99,
      "currency": "USD"
    }
  ],
  "shared_settings": {
    "calculation_method": "by_volume"
  }
}

Response

The checkout rates configuration was created.

config_idstring

The unique identifier of the configuration.

created_atstring date-time

When the configuration was created.

Example response

{
  "config_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "options": [
    {
      "option_id": 100001,
      "config_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Standard Shipping",
      "type": "live_rate",
      "services": [
        {
          "carrier_id": "se-1234567",
          "service_code": "usps_priority_mail"
        }
      ],
      "fee_mode": "add",
      "fee_percentage": 10,
      "fallback_mode": "flat_rate",
      "fallback_rate_amount": 5,
      "fallback_rate_currency": "USD",
      "fallback_percentage": 5,
      "currency": "USD",
      "is_active": true,
      "created_at": "2026-05-15T18:30:00Z"
    }
  ],
  "shared_settings": {
    "calculation_method": "by_volume"
  },
  "created_at": "2026-05-15T18:30:00Z"
}

Changes

Oct 22, 2026e998dffc42be Revision 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
Oct 9, 2026020f57d6f5b8 Revision changes
- breaking
  request property ////// was restricted to a list of enum values
- breaking
  the ////// request property type changed from no type to string
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the ////// response's property type changed from no type to string for status
- warning
  removed from the ////// request property allOf list
- warning
  added the new gram enum value to the ////// response property for the response status
- warning
  added the new kilogram enum value to the ////// response property for the response status
- warning
  added the new ounce enum value to the ////// response property for the response status
- warning
  added the new pound enum value to the ////// response property for the response status
- info
  added the new gram enum value to the request property //////
- info
  added the new kilogram enum value to the request property //////
- info
  added the new ounce enum value to the request property //////
- info
  added the new pound enum value to the request property //////
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  removed from the / response property allOf list for the response status
- info
  removed from the / response property allOf list for the response status
- info
  removed from the ////// response property allOf list for the response status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status

Operation history (4 revisions)