DOCS

Rating-objekt

Rating-objekt

Utforska möjligheterna och funktionerna i Rating-objektet.

Rating-objektet ger fraktofferer per service level med en uppdelning av tilläggsavgifter, avgifter och rabatter på förhandlade priser som utgör offerten.

Attribut 

FältAnteckningar
id STRINGDen unika identifieraren för objektet. ID:t för rating-objektet har alltid prefixet ship.
currency HASHHash med information om basvalutan som skickades i begäran och anges i svaret.
currency.id STRINGDen unika identifieraren för valutaobjektet.
currency.base STRINGBasvalutan som skickades i rating-begäran, representerad av en trebokstavs ISO-kod. Alla belopp i rating-objektet anges i basvalutan.
currency.date TIMESTAMPDatumet då valutakursen hämtades, i ISO 8601-formatet YYYY-MM-DDTHH:mm:ss.sssZ.
currency.rates HASHHash som innehåller valutorna och växelkurserna som behövs för konvertering från basvalutan.
errors HASHHash som innehåller detaljer om eventuella fel i begäran.
errors.type STRINGFelets ursprung. Möjliga värden är fedex_api ups_api dhl_api usps_api internal_error zonos_configuration.
errors.message STRINGDen beskrivande orsaken till felet från motsvarande transportör.
errors.details HASHHash som innehåller detaljer om det service level som returnerade ett fel.
errors.details.id STRINGDen unika identifieraren för service level.
errors.details.service_level STRINGService level hos transportören, t.ex. standard.
errors.details.display_name STRINGVisningsnamnet för service level.
quotes LISTListan över fraktofferer per service level.
quotes.id STRINGDen unika identifieraren för objektet. ID:t för quotes-objektet har alltid prefixet rtqt.
quotes.amount_subtotal DECIMALDen totala beräknade fraktkostnaden för service level.
quotes.weight HASHHash med information om vikten som användes för den offertsatta fraktkostnaden.
quotes.weight.billable DECIMALDen debiterbara vikten för paketet som användes för fraktofferten.
quotes.weight.unit STRINGMåttenheten för vikten. Möjliga värden är pound, ounce, kilogram och null. När värdet är null används pound.
quotes.mode HASHHash med detaljerad information om service level.
quotes.mode.service_level STRINGService level hos transportören, t.ex. standard. Vanliga exempel är: 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 och fedex_international_ground. Se transportörsdokumentationen för den fullständiga listan över tillgängliga service levels per transportör.
quotes.mode.display_name STRINGVisningsnamnet för service level.
quotes.mode.delivery_date_estimate TIMESTAMPDet uppskattade leveransdatumet för service level, i ISO 8601-formatet YYYY-MM-DDTHH:mm:ss.sssZ. Returneras om det finns tillgängligt från transportörens API.
quotes.mode.transit_business_days INTEGERDet uppskattade antalet transitdagar för service level där endast arbetsdagar räknas som transitdagar. Returneras om det finns tillgängligt från transportörens API.
quotes.mode.transit_days INTEGERDet uppskattade antalet transitdagar för service level. Returneras om det finns tillgängligt från transportörens API.
quotes.mode.rates HASHHash med detaljerad information om uppdelningen av fraktprisbeloppet.
quotes.mode.rates.amount DECIMALBeloppet för den specifika prisposten.
quotes.mode.rates.note STRINGYtterligare detaljer om vad prispostens belopp representerar.
quotes.mode.rates.type STRINGTypen av prispost. Möjliga värden är retail_shipping fuel_surcharge carrier_fee negotiated_discount.
quotes.packages LISTEn lista med detaljer om paketen som skickas.
quotes.packages.id STRINGDen unika identifieraren för packages-objektet.
quotes.packages.weight HASHHash med detaljer om paketets vikt.
quotes.packages.weight.billable DEMICALDen debiterbara vikten för paketet.
quotes.packages.weight.dimensional DECIMALPaketets volymvikt.
quotes.packages.weight.factor INTEGERDen internationella viktfaktorn som används för att beräkna volymvikten för paketet.
quotes.packages.weight.weight_unit STRINGEn sträng med måttenheten för vikten. Möjliga värden är pound ounce kilogram null. När värdet är null används 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}
Boka en demo

Var den här sidan till hjälp?


På den här sidan: