Get a checkout rates configuration

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

get/v1/checkout_rates/{config_id}

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

Changed in 1 of the 5 revisions of this API.12

Aug 15, 2026f3a66d20456512See the full diff
- ●
  added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history