Attributen
| Veld | Notities |
|---|---|
id STRING | De unieke identificatie voor het object. De id voor het beoordelingsobject zal altijd beginnen met ship. |
currency HASH | Hash die informatie biedt over de basisvaluta die in de aanvraag is verzonden en die voor de reactie is verstrekt. |
currency.id STRING | De unieke identificatie voor het valutacontainer. |
currency.base STRING | De basisvaluta zoals verzonden in de beoordelingsaanvraag, weergegeven door een drieletterige ISO-code. Alle bedragen in het beoordelingsobject zijn vermeld in de basisvaluta. |
currency.date TIMESTAMP | De datum waarop de valuta rate is opgehaald, in het ISO 8601-formaat YYYY-MM-DDTHH:mm:ss.sssZ. |
currency.rates HASH | Hash die de valuta's en wisselkoersen bevat die nodig zijn voor conversie van de basisvaluta. |
errors HASH | Hash die de details van eventuele fouten in de aanvraag bevat. |
errors.type STRING | De oorsprong van de fout. Mogelijke waarden zijn fedex_api ups_api dhl_api usps_api internal_error zonos_configuratie. |
errors.message STRING | De beschrijvende reden voor de fout van de bijbehorende vervoerder. |
errors.details HASH | Hash die details bevat over het serviceniveau dat een fout heeft geretourneerd. |
errors.details.id STRING | De unieke identificatie voor het serviceniveau. |
errors.details.service_level STRING | Het serviceniveau bij de vervoerder, bijv. standaard. |
errors.details.display_name STRING | De weergavenaam voor het serviceniveau. |
quotes LIST | De lijst van verzendoffertes per serviceniveau. |
quotes.id STRING | De unieke identificatie voor het object. De id voor het offertesobject zal altijd beginnen met rtqt. |
quotes.amount_subtotal DECIMAL | De totaal berekende verzendkosten voor het serviceniveau. |
quotes.weight HASH | Hash die informatie biedt over het gewicht dat is gebruikt voor de gequote verzendkosten. |
quotes.weight.billable DECIMAL | Het factureerbare gewicht van het pakket dat is gebruikt voor de verzendofferte. |
quotes.weight.unit STRING | De meeteenheid voor het gewicht. Mogelijke waarden zijn pound, ounce, kilogram, en null. Wanneer null, zal pound worden gebruikt. |
quotes.mode HASH | Hash die gedetailleerde informatie bevat over het serviceniveau. |
quotes.mode.service_level STRING | Het serviceniveau bij de vervoerder, bijv. standaard. 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 vervoerdersdocumentatie voor de volledige lijst van beschikbare serviceniveaus per vervoerder. |
quotes.mode.display_name STRING | De weergavenaam voor het serviceniveau. |
quotes.mode.delivery_date_estimate TIMESTAMP | De geschatte leverdatum voor het serviceniveau, in het ISO 8601-formaat YYYY-MM-DDTHH:mm:ss.sssZ. Dit zal worden geretourneerd als het beschikbaar is van de carrier API. |
quotes.mode.transit_business_days INTEGER | Het geschatte aantal transitdagen voor het serviceniveau, waarbij alleen werkdagen als transitdagen worden geteld. Dit zal worden geretourneerd als het beschikbaar is van de carrier API. |
quotes.mode.transit_days INTEGER | Het geschatte aantal transitdagen voor het serviceniveau. Dit zal worden geretourneerd als het beschikbaar is van de carrier API. |
quotes.mode.rates HASH | Hash met gedetailleerde informatie over de uitsplitsing van het verzend-rate-bedrag. |
quotes.mode.rates.amount DECIMAL | Het bedrag van het specifieke rate-item. |
quotes.mode.rates.note STRING | Aanvullende details over wat het bedrag van het rate-item vertegenwoordigt. |
quotes.mode.rates.type STRING | Het type van het rate-item. Mogelijke waarden zijn retail_shipping fuel_surcharge carrier_fee negotiated_discount. |
quotes.packages LIST | Een lijst met details over de te verzenden pakketten. |
quotes.packages.id STRING | De unieke identificatie voor het pakkettenobject. |
quotes.packages.weight HASH | Hash met details over het gewicht van het pakket. |
quotes.packages.weight.billable DECIMAL | Het factureerbare gewicht van het pakket. |
quotes.packages.weight.dimensional DECIMAL | Het dimensionale gewicht van het pakket. |
quotes.packages.weight.factor INTEGER | De internationale gewichtsfactor die wordt gebruikt om het dimensionale gewicht voor het pakket te berekenen. |
quotes.packages.weight.weight_unit STRING | Een string met de meeteenheid voor het gewicht. Mogelijke waarden zijn pound ounce kilogram null. Wanneer null, zal pound worden gebruikt. |
Voorbeeldreactie
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
{
"id": "ship_5p67angIDnS91CyfpW55YZ",
"currency": {
"id": "curr_1Rp9lhXSRXvEWVs97k2PHE",
"base": "USD",
"date": "2020-02-04T18:47:04.629+0000",
"rates": []
},
"errors": [
{
"details": {
"id": "rtqt_7cz80Ny8dToSqoWlHTJJnP",
"display_name": "FedEx Express Saver",
"service_level": "FEDEX_EXPRESS_SAVER",
"message": "[868] Service is not allowed. ",
"type": "fedex_api"
}
}
],
"quotes": [
{
"id": "rtqt_4BUyxLEUeoU6zDdprCRoUV",
"amount_subtotal": 943.18,
"mode": {
"delivery_date_estimate": null,
"display_name": "UPS Expedited ",
"rates": [
{
"amount": 848.31,
"note": "UPS api: standard rate",
"type": "retail_shipping"
},
{
"amount": 64.4,
"note": "UPS api: fuel surcharge",
"type": "fuel_surcharge"
},
{
"amount": 40.0,
"note": "UPS api: extended area",
"type": "carrier_fee"
},
{
"amount": -9.53,
"note": "UPS negotiated discount",
"type": "negotiated_discount"
}
],
"service_level": "UPS_WORLDWIDE_EXPEDITED",
"transit_business_days": null,
"transit_days": null
},
"packages": [
{
"id": "1",
"weight": {
"billable": 32.0,
"dimensional": 30.7554,
"factor": 139,
"weight_unit": "pound"
}
}
],
"weight": {
"billable": 32.0,
"unit": "pound"
}
},
{
"id": "rtqt_1jyuPdiE5uIBcYzhO54DAb",
"amount_subtotal": 1058.86,
"mode": {
"delivery_date_estimate": null,
"display_name": "UPS Saver ",
"rates": [
{
"amount": 957.26,
"note": "UPS api: standard rate",
"type": "retail_shipping"
},
{
"amount": 72.3,
"note": "UPS api: fuel surcharge",
"type": "fuel_surcharge"
},
{
"amount": 40.0,
"note": "UPS api: extended area",
"type": "carrier_fee"
},
{
"amount": -10.7,
"note": "UPS negotiated discount",
"type": "negotiated_discount"
}
],
"service_level": "UPS_SAVER",
"transit_business_days": null,
"transit_days": null
},
"packages": [
{
"id": "1",
"weight": {
"billable": 32.0,
"dimensional": 30.7554,
"factor": 139,
"weight_unit": "pound"
}
}
],
"weight": {
"billable": 32.0,
"unit": "pound"
}
}
]
}
Beoordelingsobject
Verken de mogelijkheden en functies van het beoordelingsobject.
Het beoordelingsobject biedt verzendoffertes per serviceniveau met een uitsplitsing van toeslagen, kosten en onderhandelde rate kortingen die de offerte samenstellen.