評級物件

探索評級物件的功能和特性。

評級物件將按服務等級提供運費報價,並提供附加費、費用及協商折扣的詳細分解。

屬性 

欄位備註
id STRING該物件的唯一識別碼。評級物件的 ID 始終以 ship 開頭。
currency HASH雜湊表,提供在請求中發送的基礎貨幣資訊,以及為回應提供的資訊。
currency.id STRING貨幣物件的唯一識別碼。
currency.base STRING評級請求中發送的基礎貨幣,由三字母 ISO 代碼表示。評級物件中的所有金額都以基礎貨幣列出。
currency.date TIMESTAMP提取貨幣匯率的日期,採用 ISO 8601 格式 YYYY-MM-DDTHH:mm:ss.sssZ
currency.rates HASH雜湊表,包含從基礎貨幣進行轉換所需的貨幣及匯率。
errors HASH雜湊表,包含請求上任何錯誤的詳細資訊。
errors.type STRING錯誤的來源。可能的值包括 fedex_api ups_api dhl_api usps_api internal_error zonos_configuration
errors.message STRING來自相應承運商的錯誤描述性原因。
errors.details HASH雜湊表,包含返回錯誤的服務等級的詳細資訊。
errors.details.id STRING服務等級的唯一識別碼。
errors.details.service_level STRING承運商的服務等級,例如 standard
errors.details.display_name STRING服務等級的顯示名稱。
quotes LIST按服務等級提供的運費報價清單。
quotes.id STRING該物件的唯一識別碼。報價物件的 ID 始終以 rtqt 開頭。
quotes.amount_subtotal DECIMAL服務等級的計算運費成本總額。
quotes.weight HASH雜湊表,提供用於報價運費成本的重量資訊。
quotes.weight.billable DECIMAL用於運費報價的包裹可計費重量。
quotes.weight.unit STRING重量的測量單位。可能的值為 poundouncekilogramnull。當為 null 時,將使用 pound
quotes.mode HASH雜湊表,包含服務等級的詳細資訊。
quotes.mode.service_level STRING承運商的服務等級,例如 standard。常見的例子包括:ups_expressups_express_saverups_expeditedups_economyups_standardups_mail_innovations_economyups_mail_innovations_prioritydhl_expressdhl_ecommerce_parcel_directfedex_priorityfedex_economyusps_first_class_mail_internationalusps_priority_mail_internationallandmark_parcelapc_parcelpoint2point_standardpoint2point_directpoint2point_packet,以及 fedex_international_ground。請參閱承運商文件以取得按承運商劃分的完整服務等級清單。
quotes.mode.display_name STRING服務等級的顯示名稱。
quotes.mode.delivery_date_estimate TIMESTAMP服務等級的預計配送日期,採用 ISO 8601 格式 YYYY-MM-DDTHH:mm:ss.sssZ。如承運商 API 有提供,將返回此值。
quotes.mode.transit_business_days INTEGER服務等級的預計轉運天數,僅計算營業日作為轉運日。如承運商 API 有提供,將返回此值。
quotes.mode.transit_days INTEGER服務等級的預計轉運天數。如承運商 API 有提供,將返回此值。
quotes.mode.rates HASH雜湊表,包含運費金額分解的詳細資訊。
quotes.mode.rates.amount DECIMAL特定費率項目的金額。
quotes.mode.rates.note STRING費率項目金額所代表內容的額外詳細資訊。
quotes.mode.rates.type STRING費率項目的類型。可能的值包括 retail_shipping fuel_surcharge carrier_fee negotiated_discount
quotes.packages LIST有關所運送包裹的詳細資訊清單。
quotes.packages.id STRING包裹物件的唯一識別碼。
quotes.packages.weight HASH雜湊表,包含包裹重量的詳細資訊。
quotes.packages.weight.billable DEMICAL包裹的可計費重量。
quotes.packages.weight.dimensional DECIMAL包裹的體積重量。
quotes.packages.weight.factor INTEGER用於計算包裹體積重量的國際重量係數。
quotes.packages.weight.weight_unit STRING包含重量測量單位的字串。可能的值為 pound ounce kilogram null。當為 null 時,將使用 pound
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": null
52 },
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": null
100 },
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}