| Field | Type | Required | Description | Example |
|---|---|---|---|---|
amount |
str | ✔️ | Final Rate price, expressed in the currency used in the sender's country. | 5.5 |
amount_local |
str | ✔️ | Final Rate price, expressed in the currency used in the recipient's country. | 5.5 |
currency |
str | ✔️ | Currency used in the sender's country, refers to amount. The official ISO 4217 currency codes are used, e.g. USD or EUR. |
USD |
currency_local |
str | ✔️ | Currency used in the recipient's country, refers to amount_local. The official ISO 4217 currency codes are used, e.g. USD or "EUR". |
USD |
attributes |
List[components.Attributes] | ✔️ | An array containing specific attributes of this Rate in context of the entire shipment. Attributes can be assigned CHEAPEST, FASTEST, or BESTVALUE. |
|
carrier_account |
str | ✔️ | Object ID of the carrier account that has been used to retrieve the rate. | 078870331023437cb917f5187429b093 |
object_created |
date | ✔️ | Date and time of Rate creation. | |
object_id |
str | ✔️ | Unique identifier of the given Rate object. | adcfdddf8ec64b84ad22772bce3ea37a |
object_owner |
str | ✔️ | Username of the user who created the rate object. | [email protected] |
provider |
str | ✔️ | Carrier offering the rate, e.g., FedEx or Deutsche Post DHL. |
USPS |
servicelevel |
components.ServiceLevelWithParent | ✔️ | N/A | |
shipment |
str | ✔️ | N/A | adcfdddf8ec64b84ad22772bce3ea37a |
arrives_by |
Optional[str] | ➖ | Predicted time the carrier will deliver the package in the destination's local time zone. In the format HH:MM:SS. |
08:30:00 |
duration_terms |
Optional[str] | ➖ | 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. |
Delivery in 1 to 3 business days |
estimated_days |
Optional[int] | ➖ | 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. |
2 |
included_insurance_price |
Optional[str] | ➖ | 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. |
1.05 |
messages |
List[components.ResponseMessage] | ➖ | N/A | |
provider_image_75 |
Optional[str] | ➖ | URL to the provider logo with max. dimensions of 75*75px. Please refer to the provider's Logo Usage Guidelines before using the logo. |
https://cdn2.goshippo.com/providers/75/USPS.png |
provider_image_200 |
Optional[str] | ➖ | URL to the provider logo with max. dimensions of 200*200px. Please refer to the provider's Logo Usage Guidelines before using the logo. |
https://cdn2.goshippo.com/providers/200/USPS.png |
test |
Optional[bool] | ➖ | Indicates whether the object has been created in test mode. | |
zone |
Optional[str] | ➖ | The parcel's transit zone token. These tokens can vary depending on the provider. | 1 |
