Sign in
latestOpenAPI 3.1.0MIT2026-08-221643491.4 MB

d3d8c21cd227

rate_shoppers

Get rate shopper by ID

<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 a single rate shopper by its identifier. Accepts both default strategy names (cheapest, fastest, best_value) and custom rate shopper UUIDs.

get/v2/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"
}