rate_shoppers

Get rate shopper by ID

Changed on

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}

Request

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

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

  • 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

    • 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

      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