Sign in
latestOpenAPI 3.1.0MIT2026-08-221643491.4 MB

d3d8c21cd227

shipments

Get shipment rates

<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>

Get Rates for the shipment information associated with the shipment ID

get/v2/shipments/{shipment_id}/rates

Query parameters

created_at_startstring date-time

Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)

Response

The request was a success.

rate_request_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

shipment_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

created_atstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

status'working' | 'completed' | 'partial' | 'error'

The possible rate response status values

Example response

{
  "rates": [
    {
      "rate_id": "se-28529731",
      "carrier_id": "se-28529731",
      "shipping_amount": {
        "amount": 12
      },
      "insurance_amount": {
        "amount": 12
      },
      "confirmation_amount": {
        "amount": 12
      },
      "other_amount": {
        "amount": 12
      },
      "requested_comparison_amount": {
        "amount": 12
      },
      "tax_amount": {
        "amount": 12
      },
      "zone": 6,
      "package_type": "package",
      "delivery_days": 5,
      "guaranteed_service": true,
      "estimated_delivery_date": "2018-09-23T00:00:00Z",
      "carrier_delivery_days": "22",
      "ship_date": "2024-10-22T00:00:00Z",
      "negotiated_rate": true,
      "service_type": "next_day",
      "service_code": "usps_priority_mail_express",
      "trackable": true,
      "carrier_code": "stamps_com",
      "carrier_nickname": "Free",
      "carrier_friendly_name": "free",
      "rate_details": [
        {
          "rate_detail_type": "shipping",
          "carrier_description": "Shipping",
          "carrier_billing_code": "BaseServiceCharge",
          "amount": {
            "amount": 12
          },
          "billing_source": "carrier"
        }
      ]
    }
  ],
  "invalid_rates": [
    {
      "rate_id": "se-28529731",
      "carrier_id": "se-28529731",
      "shipping_amount": {
        "amount": 12
      },
      "insurance_amount": {
        "amount": 12
      },
      "confirmation_amount": {
        "amount": 12
      },
      "other_amount": {
        "amount": 12
      },
      "requested_comparison_amount": {
        "amount": 12
      },
      "tax_amount": {
        "amount": 12
      },
      "zone": 6,
      "package_type": "package",
      "delivery_days": 5,
      "guaranteed_service": true,
      "estimated_delivery_date": "2018-09-23T00:00:00Z",
      "carrier_delivery_days": "22",
      "ship_date": "2024-10-22T00:00:00Z",
      "negotiated_rate": true,
      "service_type": "next_day",
      "service_code": "usps_priority_mail_express",
      "trackable": true,
      "carrier_code": "stamps_com",
      "carrier_nickname": "Free",
      "carrier_friendly_name": "free",
      "rate_details": [
        {
          "rate_detail_type": "shipping",
          "carrier_description": "Shipping",
          "carrier_billing_code": "BaseServiceCharge",
          "amount": {
            "amount": 12
          },
          "billing_source": "carrier"
        }
      ]
    }
  ],
  "rate_request_id": "se-28529731",
  "shipment_id": "se-28529731",
  "created_at": "se-28529731",
  "errors": [
    {
      "message": "Body of request cannot be null.",
      "field_name": "inventory_warehouse_id",
      "field_value": "invalid-id"
    }
  ]
}