rate_shoppers

List rate shoppers

Changed on

Retrieve rate shoppers for the authenticated seller. By default this returns both the default rate shoppers (cheapest, fastest, best_value) and any custom rate shoppers. Use the type parameter to filter.

get/v1/rate_shoppers

Request

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

Query parameters

type'custom'

Filter rate shoppers by type. When set to custom, only seller-created rate shoppers are returned (excludes defaults). When omitted, both default and custom rate shoppers are returned.

sort_by'name' | 'created_at'

Field to sort results by. Sorting only applies to custom rate shoppers; default rate shoppers are always listed first.

sort_dir'asc' | 'desc'

Sort direction.

Response

The request was a success.

Example response

{
  "rate_shoppers": [
    {
      "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