rate_shoppers

Get rate shopper by ID

Retrieve a single rate shopper by its identifier. Accepts both default strategy names (cheapest, fastest, best_value) and custom rate shopper UUIDs.

get/v1/rate_shoppers/{rate_shopper_id}

Response

The request was a success.

rate_shopper_idstring required

Identifier for the rate shopper. For default rate shoppers this is a strategy name (cheapest, fastest, best_value). For custom rate shoppers this is a UUID.

namestring required

Display name of the rate shopper.

is_activeboolean required

Whether the rate shopper is currently active.

created_atstring date-time required

Timestamp when the rate shopper was created.

updated_atstring date-time required

Timestamp when the rate shopper was last updated.

Example response

{
  "rate_shopper_id": "cheapest",
  "name": "Cheapest",
  "services": [
    {
      "service_code": "usps_priority_mail",
      "carrier_id": "se-28529731"
    }
  ],
  "transit_time": {
    "max_days": 5,
    "max_days_international": 14
  },
  "service_preference": {
    "service": {
      "service_code": "usps_priority_mail",
      "carrier_id": "se-28529731"
    },
    "price_tolerance": {
      "amount": 2.5,
      "percentage": 10
    }
  },
  "is_active": true,
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-03-20T14:45:00Z"
}

Changes

Changed in 1 of the 6 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