Attributs
| Field↕ | Notes↕ |
|---|---|
id STRING | The unique identifier for the object. The id for the rating object will always be prefixed with ship. |
currency HASH | Hash providing information on the base currency sent in the request and provided for the response. |
currency.id STRING | The unique identifier for the currency object. |
currency.base STRING | The base currency as sent in the rating request, represented by a three-letter ISO code. All amounts in the rating object are listed in the base currency. |
currency.date TIMESTAMP | The date in which the currency rate was pulled, in the ISO 8601 format YYYY-MM-DDTHH:mm:ss.sssZ. |
currency.rates HASH | Hash containing the currencies and exchange rates needed for conversion from the base currency. |
errors HASH | Hash containing the details of any errors on the request. |
errors.type STRING | The origin of the error. Possible values include fedex_api ups_api dhl_api usps_api internal_error zonos_configuration. |
errors.message STRING | The descriptive reason for the error from the corresponding carrier. |
errors.details HASH | Hash containing details on the service level that returned an error. |
errors.details.id STRING | The unique identifier for the service level. |
errors.details.service_level STRING | The service level with the carrier, e.g., standard. |
errors.details.display_name STRING | The display name for the service level. |
quotes LIST | The list of shipping quotes by service level. |
quotes.id STRING | The unique identifier for the object. The id for the quotes object will always be prefixed with rtqt. |
quotes.amount_subtotal DECIMAL | The total calculated shipping cost for the service level. |
quotes.weight HASH | Hash providing information about the weight used for the quoted shipping cost. |
quotes.weight.billable DECIMAL | The billable weight of the package used for the shipping quote. |
quotes.weight.unit STRING | The unit of measurement for the weight.Possible values are pound, ounce, kilogram, and null.When null, pound will be used. |
quotes.mode HASH | Hash containing detailed information on the service level. |
quotes.mode.service_level STRING | The service_level with the carrier, e.g., standard. Common examples include: ups_express, ups_express_saver, ups_expedited, ups_economy, ups_standard, ups_mail_innovations_economy, ups_mail_innovations_priority, dhl_express, dhl_ecommerce_parcel_direct, fedex_priority, fedex_economy, usps_first_class_mail_international, usps_priority_mail_international, landmark_parcel, apc_parcel, point2point_standard, point2point_direct, point2point_packet, and fedex_international_ground. See the carrier docs for the full list of available service levels by carrier. |
quotes.mode.display_name STRING | The display name for the service level. |
quotes.mode.delivery_date_estimate TIMESTAMP | The estimated delivery date for the service level, in the ISO 8601 format YYYY-MM-DDTHH:mm:ss.sssZ. This will be returned if available from the carrier API. |
quotes.mode.transit_business_days INTEGER | The estimated number of transit days for the service level only counting business days as transit days. This will be returned if available from the carrier API. |
quotes.mode.transit_days INTEGER | The estimated number of transit days for the service level. This will be returned if available from the carrier API. |
quotes.mode.rates HASH | Hash containing detailed information on the breakdown of the shipping rate amount. |
quotes.mode.rates.amount DECIMAL | The amount of the specific rate item. |
quotes.mode.rates.note STRING | Additional details on what the rate item amount represents. |
quotes.mode.rates.type STRING | The type of the rate item. Possible values include retail_shipping fuel_surcharge carrier_fee negotiated_discount. |
quotes.packages LIST | A list of details on the packages being shipped. |
quotes.packages.id STRING | The unique identifier for the packages object. |
quotes.packages.weight HASH | Hash containing details of the weight for the package. |
quotes.packages.weight.billable DEMICAL | The billable weight of the package. |
quotes.packages.weight.dimensional DECIMAL | The dimension weight of the package. |
quotes.packages.weight.factor INTEGER | The international weight factored use to calculate the dimensional weight for the package. |
quotes.packages.weight.weight_unit STRING | A string with the unit of measurement for the weight.Possible values are pound ounce kilogram null.When null, pound will be used. |
1
{2
"id": "ship_5p67angIDnS91CyfpW55YZ",3
"currency": {4
"id": "curr_1Rp9lhXSRXvEWVs97k2PHE",5
"base": "USD",6
"date": "2020-02-04T18:47:04.629+0000",7
"rates": []8
},9
"errors": [10
{11
"details": {12
"id": "rtqt_7cz80Ny8dToSqoWlHTJJnP",13
"display_name": "FedEx Express Saver",14
"service_level": "FEDEX_EXPRESS_SAVER",15
"message": "[868] Service is not allowed. ",16
"type": "fedex_api"17
}18
}19
],20
"quotes": [21
{22
"id": "rtqt_4BUyxLEUeoU6zDdprCRoUV",23
"amount_subtotal": 943.18,24
"mode": {25
"delivery_date_estimate": null,26
"display_name": "UPS Expedited ",27
"rates": [28
{29
"amount": 848.31,30
"note": "UPS api: standard rate",31
"type": "retail_shipping"32
},33
{34
"amount": 64.4,35
"note": "UPS api: fuel surcharge",36
"type": "fuel_surcharge"37
},38
{39
"amount": 40,40
"note": "UPS api: extended area",41
"type": "carrier_fee"42
},43
{44
"amount": -9.53,45
"note": "UPS negotiated discount",46
"type": "negotiated_discount"47
}48
],49
"service_level": "UPS_WORLDWIDE_EXPEDITED",50
"transit_business_days": null,51
"transit_days": null52
},53
"packages": [54
{55
"id": "1",56
"weight": {57
"billable": 32,58
"dimensional": 30.7554,59
"factor": 139,60
"weight_unit": "pound"61
}62
}63
],64
"weight": {65
"billable": 32,66
"unit": "pound"67
}68
},69
{70
"id": "rtqt_1jyuPdiE5uIBcYzhO54DAb",71
"amount_subtotal": 1058.86,72
"mode": {73
"delivery_date_estimate": null,74
"display_name": "UPS Saver ",75
"rates": [76
{77
"amount": 957.26,78
"note": "UPS api: standard rate",79
"type": "retail_shipping"80
},81
{82
"amount": 72.3,83
"note": "UPS api: fuel surcharge",84
"type": "fuel_surcharge"85
},86
{87
"amount": 40,88
"note": "UPS api: extended area",89
"type": "carrier_fee"90
},91
{92
"amount": -10.7,93
"note": "UPS negotiated discount",94
"type": "negotiated_discount"95
}96
],97
"service_level": "UPS_SAVER",98
"transit_business_days": null,99
"transit_days": null100
},101
"packages": [102
{103
"id": "1",104
"weight": {105
"billable": 32,106
"dimensional": 30.7554,107
"factor": 139,108
"weight_unit": "pound"109
}110
}111
],112
"weight": {113
"billable": 32,114
"unit": "pound"115
}116
}117
]118
}
Objet Rating
Explorez les capacités et fonctions de l'objet Rating.
L'objet Rating fournit des devis d'expédition par niveau de service avec une ventilation des surcharges, frais et remises tarifaires négociées qui composent le devis.