rates

Estimate rates

Changed on
<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 Rate Estimates

post/v2/rates/estimate

Request

  • Base URL
    https://api.shipstation.com
  • URL
    https://api.shipstation.com/v2/rates/estimate
  • Auth
    API key in header api-key

Request body

OR

Example request

{
  "from_country_code": "CA",
  "from_postal_code": "78756-3717",
  "from_city_locality": "Austin",
  "from_state_province": "Austin",
  "to_country_code": "CA",
  "to_postal_code": "78756-3717",
  "to_city_locality": "Austin",
  "to_state_province": "Houston",
  "weight": {
    "value": 3
  },
  "dimensions": {
    "length": 2,
    "width": 2,
    "height": 1
  },
  "ship_date": "2018-09-23T15:00:00.000Z",
  "carrier_ids": [
    "se-28529731"
  ]
}

Response

The request was a success.

rate_type'check' | 'shipment' | 'quick' required

The possible rate type values

carrier_idstring required

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

zoneinteger nullable required

Certain carriers base their rates off of custom zones that vary depending upon the ship_to and ship_from location

package_typestring nullable required

package type that this rate was estimated for

delivery_daysinteger nullable

The number of days estimated for delivery, this will show the actual delivery time if for example, the package gets shipped on a Friday

guaranteed_serviceboolean required

Indicates if the rate is guaranteed.

estimated_delivery_datestring date-time

An ISO 8601 string that represents a date, but not a specific time. The value may contain a time component, but it will be set to 00:00:00 UTC by ShipStation .

carrier_delivery_daysstring nullable

The carrier delivery days

ship_datestring date-time

ship date

negotiated_rateboolean required

Indicates if the rates been negotiated

service_typestring required

service type

service_codestring required

service code for the rate

trackableboolean required

Indicates if rate is trackable

carrier_codestring required

A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.

carrier_nicknamestring required

carrier nickname

carrier_friendly_namestring required

carrier friendly name

validation_status'valid' | 'invalid' | 'has_warnings' | 'unknown' required

The possible validation status values

warning_messagesstring[] required

The warning messages

error_messagesstring[] required

The error messages

Example response

[
  {
    "carrier_id": "se-28529731",
    "shipping_amount": {
      "amount": 12
    },
    "insurance_amount": {
      "amount": 12
    },
    "confirmation_amount": {
      "amount": 12
    },
    "other_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",
    "delivery_prediction": {
      "delivery_date": "2026-07-04",
      "confidence_level": "high"
    },
    "ship_date": "2024-12-23T00:00:00.000Z",
    "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",
    "warning_messages": [
      "warning"
    ],
    "error_messages": [
      "error"
    ]
  }
]

Changes

  • 4e29670aa28dRevision 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 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

  • bf3618aaf7e1Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      added subschema #2 to the / response property oneOf list for the response status

    • info

      removed from the / response property allOf list for the response status