DOCS

Rating-object

Verken de mogelijkheden en functies van het Rating-object.

Het Rating-object levert verzendoffertes per serviceniveau met een uitsplitsing van toeslagen, kosten en onderhandelde tariefkortingen die de offerte vormen.

Attributen 

VeldNotities
id STRINGDe unieke identifier voor het object. De id voor het Rating-object heeft altijd het voorvoegsel ship.
currency HASHHash met informatie over de basisvaluta die in de aanvraag is verzonden en in het antwoord wordt geleverd.
currency.id STRINGDe unieke identifier voor het currency-object.
currency.base STRINGDe basisvaluta zoals verzonden in de rating-aanvraag, weergegeven door een ISO-code van drie letters. Alle bedragen in het Rating-object worden weergegeven in de basisvaluta.
currency.date TIMESTAMPDe datum waarop de wisselkoers is opgehaald, in het ISO 8601-formaat YYYY-MM-DDTHH:mm:ss.sssZ.
currency.rates HASHHash met de valuta's en wisselkoersen die nodig zijn voor conversie vanuit de basisvaluta.
errors HASHHash met de details van eventuele fouten in de aanvraag.
errors.type STRINGDe oorsprong van de fout. Mogelijke waarden zijn onder andere fedex_api ups_api dhl_api usps_api internal_error zonos_configuration.
errors.message STRINGDe beschrijvende reden voor de fout, afkomstig van de betreffende vervoerder.
errors.details HASHHash met details over het serviceniveau dat een fout heeft geretourneerd.
errors.details.id STRINGDe unieke identifier voor het serviceniveau.
errors.details.service_level STRINGHet serviceniveau bij de vervoerder, bijv. standard.
errors.details.display_name STRINGDe weergavenaam voor het serviceniveau.
quotes LISTDe lijst met verzendoffertes per serviceniveau.
quotes.id STRINGDe unieke identifier voor het object. De id voor het quotes-object heeft altijd het voorvoegsel rtqt.
quotes.amount_subtotal DECIMALDe totale berekende verzendkosten voor het serviceniveau.
quotes.weight HASHHash met informatie over het gewicht dat is gebruikt voor de verzendofferte.
quotes.weight.billable DECIMALHet factureerbare gewicht van het pakket dat is gebruikt voor de verzendofferte.
quotes.weight.unit STRINGDe maateenheid voor het gewicht.Mogelijke waarden zijn pound, ounce, kilogram en null.Wanneer null, wordt pound gebruikt.
quotes.mode HASHHash met gedetailleerde informatie over het serviceniveau.
quotes.mode.service_level STRINGHet service_level bij de vervoerder, bijv. standard. Veelvoorkomende voorbeelden zijn: 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 en fedex_international_ground. Zie de documentatie van de vervoerder voor de volledige lijst met beschikbare service levels per vervoerder.
quotes.mode.display_name STRINGDe weergavenaam voor het serviceniveau.
quotes.mode.delivery_date_estimate TIMESTAMPDe geschatte leverdatum voor het serviceniveau, in het ISO 8601-formaat YYYY-MM-DDTHH:mm:ss.sssZ. Dit wordt geretourneerd indien beschikbaar via de API van de vervoerder.
quotes.mode.transit_business_days INTEGERHet geschatte aantal transitdagen voor het serviceniveau, waarbij alleen werkdagen worden meegeteld als transitdagen. Dit wordt geretourneerd indien beschikbaar via de API van de vervoerder.
quotes.mode.transit_days INTEGERHet geschatte aantal transitdagen voor het serviceniveau. Dit wordt geretourneerd indien beschikbaar via de API van de vervoerder.
quotes.mode.rates HASHHash met gedetailleerde informatie over de uitsplitsing van het verzendtariefbedrag.
quotes.mode.rates.amount DECIMALHet bedrag van het specifieke tariefonderdeel.
quotes.mode.rates.note STRINGExtra details over waar het bedrag van het tariefonderdeel voor staat.
quotes.mode.rates.type STRINGHet type tariefonderdeel. Mogelijke waarden zijn onder andere retail_shipping fuel_surcharge carrier_fee negotiated_discount.
quotes.packages LISTEen lijst met details over de verzonden pakketten.
quotes.packages.id STRINGDe unieke identifier voor het packages-object.
quotes.packages.weight HASHHash met details over het gewicht van het pakket.
quotes.packages.weight.billable DEMICALHet factureerbare gewicht van het pakket.
quotes.packages.weight.dimensional DECIMALHet volumegewicht van het pakket.
quotes.packages.weight.factor INTEGERDe internationale gewichtsfactor die wordt gebruikt om het volumegewicht van het pakket te berekenen.
quotes.packages.weight.weight_unit STRINGEen tekenreeks met de maateenheid voor het gewicht.Mogelijke waarden zijn pound ounce kilogram null.Wanneer null, wordt pound gebruikt.
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}
Boek een demo

Was deze pagina nuttig?