v1

latestOpenAPI 3.1.02026-07-1270243932.3 KB

Rates

Retrieve a rate

Returns an existing rate using a rate object ID. Rates older than 390 days are not returned.

get/rates/{RateId}

Path parameters

RateIdstring required

Object ID of the rate

Headers

SHIPPO-API-VERSIONstring

Example:2018-02-08

Optional string used to pick a non-default API version to use. See our <a href="https://docs.goshippo.com/docs/api_concepts/apiversioning/">API version</a> guide.

Response

Rate

amountstring required

Final Rate price, expressed in the currency used in the sender's country.

amount_localstring required

Final Rate price, expressed in the currency used in the recipient's country.

currencystring required

Currency used in the sender's country, refers to amount. The <a href="http://www.xe.com/iso4217.php">official ISO 4217</a> currency codes are used, e.g. USD or EUR.

currency_localstring required

Currency used in the recipient's country, refers to amount_local. The <a href="http://www.xe.com/iso4217.php">official ISO 4217</a> currency codes are used, e.g. USD or "EUR".

arrives_bystring

Predicted time the carrier will deliver the package in the destination's local time zone. In the format HH:MM:SS.

attributesstring[] required

An array containing specific attributes of this Rate in context of the entire shipment. Attributes can be assigned CHEAPEST, FASTEST, or BESTVALUE.

carrier_accountstring required

Object ID of the carrier account that has been used to retrieve the rate.

duration_termsstring

Further clarification of the transit times. Often, this includes notes that the transit time as given in "days" is only an average, not a guaranteed time.

estimated_daysinteger

Estimated transit time (duration) in days of the Parcel at the given servicelevel. Please note that this is not binding, but only an average value as given by the provider. Shippo is not able to guarantee any transit times.

included_insurance_pricestring

Cost to the user to insure the Rate for the requested amount of coverage, if insurance coverage was requested. Expressed in the currency used in the sender's country. Will be null if no insurance coverage was requested, or if insurance is requested from a non-standard insurance provider. Please note this price is already included in the amount and amount_local fields on the Rate. Do not add this field to them.

object_createdstring date-time required

Date and time of Rate creation.

object_idstring required

Unique identifier of the given Rate object.

object_ownerstring required

Username of the user who created the rate object.

providerstring required

Carrier offering the rate, e.g., FedEx or Deutsche Post DHL.

provider_image_75string

URL to the provider logo with max. dimensions of 75*75px. Please refer to the provider's Logo Usage Guidelines before using the logo.

provider_image_200string

URL to the provider logo with max. dimensions of 200*200px. Please refer to the provider's Logo Usage Guidelines before using the logo.

shipmentstring required

testboolean

Indicates whether the object has been created in test mode.

zonestring

The parcel's transit zone token. These tokens can vary depending on the provider.

Example response

{
  "amount": "5.5",
  "amount_local": "5.5",
  "currency": "USD",
  "currency_local": "USD",
  "arrives_by": "08:30:00",
  "carrier_account": "078870331023437cb917f5187429b093",
  "duration_terms": "Delivery in 1 to 3 business days",
  "estimated_days": 2,
  "included_insurance_price": "1.05",
  "messages": [
    {
      "source": "UPS",
      "code": "carrier_timeout",
      "text": "UPS API did not respond. Please try again in a few minutes."
    }
  ],
  "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
  "object_owner": "pp@gmail.com",
  "provider": "USPS",
  "provider_image_75": "https://cdn2.goshippo.com/providers/75/USPS.png",
  "provider_image_200": "https://cdn2.goshippo.com/providers/200/USPS.png",
  "servicelevel": {
    "name": "Priority Mail Express",
    "token": "usps_priority_express",
    "parent_servicelevel": {
      "name": "Priority Mail Express",
      "token": "usps_priority_express"
    }
  },
  "shipment": "adcfdddf8ec64b84ad22772bce3ea37a",
  "zone": "1"
}