rates

Get rate by id

Retrieve a previously queried rate by its ID

get/v2/rates/{rate_id}

Request

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

Response

The request was a success.

rate_idstring required

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

rate_type'check' | 'shipment' 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 required

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

package_typestring required

package type that this rate was estimated for

delivery_daysinteger

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

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

carrier code

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

{
  "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-23",
  "carrier_delivery_days": "22",
  "ship_date": "10/22/2024z00:00",
  "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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.