List rate shoppers

<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

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.

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"
    }
  ]
}

d3d8c21cd227

List rate shoppers

Query parameters

Response

Example response