checkout_rates

Get a checkout rates configuration

Changed on

Retrieve a single checkout rates configuration, including all of its delivery options and shared settings.

get/v1/checkout_rates/{config_id}

Request

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

Response

The requested checkout rates configuration.

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

  • 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

  • 020f57d6f5b8Revision changes
    • 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

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