DOCS

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.

Attributs 

ChampRemarques
id STRINGL'identifiant unique de l'objet. L'id de l'objet rating sera toujours préfixé par ship.
currency HASHHash fournissant des informations sur la devise de base envoyée dans la requête et fournie dans la réponse.
currency.id STRINGL'identifiant unique de l'objet currency.
currency.base STRINGLa devise de base telle qu'envoyée dans la requête rating, représentée par un code ISO à trois lettres. Tous les montants de l'objet rating sont indiqués dans la devise de base.
currency.date TIMESTAMPLa date à laquelle le taux de change a été récupéré, au format ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ.
currency.rates HASHHash contenant les devises et les taux de change nécessaires à la conversion depuis la devise de base.
errors HASHHash contenant les détails de toute erreur sur la requête.
errors.type STRINGL'origine de l'erreur. Les valeurs possibles incluent fedex_api ups_api dhl_api usps_api internal_error zonos_configuration.
errors.message STRINGLa raison descriptive de l'erreur fournie par le transporteur correspondant.
errors.details HASHHash contenant des détails sur le niveau de service ayant généré une erreur.
errors.details.id STRINGL'identifiant unique du niveau de service.
errors.details.service_level STRINGLe niveau de service auprès du transporteur, par exemple standard.
errors.details.display_name STRINGLe nom d'affichage du niveau de service.
quotes LISTLa liste des devis d'expédition par niveau de service.
quotes.id STRINGL'identifiant unique de l'objet. L'id de l'objet quotes sera toujours préfixé par rtqt.
quotes.amount_subtotal DECIMALLe coût d'expédition total calculé pour le niveau de service.
quotes.weight HASHHash fournissant des informations sur le poids utilisé pour le coût d'expédition indiqué.
quotes.weight.billable DECIMALLe poids facturable du colis utilisé pour le devis d'expédition.
quotes.weight.unit STRINGL'unité de mesure du poids.Les valeurs possibles sont pound, ounce, kilogram, et null.Lorsque null, pound sera utilisé.
quotes.mode HASHHash contenant des informations détaillées sur le niveau de service.
quotes.mode.service_level STRINGLe service_level auprès du transporteur, par exemple standard. Voici quelques exemples courants : 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, et fedex_international_ground. Consultez la documentation des transporteurs pour la liste complète des niveaux de service disponibles par transporteur.
quotes.mode.display_name STRINGLe nom d'affichage du niveau de service.
quotes.mode.delivery_date_estimate TIMESTAMPLa date de livraison estimée pour le niveau de service, au format ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ. Cette valeur sera renvoyée si elle est disponible via l'API du transporteur.
quotes.mode.transit_business_days INTEGERLe nombre estimé de jours de transit pour le niveau de service, en ne comptant que les jours ouvrés comme jours de transit. Cette valeur sera renvoyée si elle est disponible via l'API du transporteur.
quotes.mode.transit_days INTEGERLe nombre estimé de jours de transit pour le niveau de service. Cette valeur sera renvoyée si elle est disponible via l'API du transporteur.
quotes.mode.rates HASHHash contenant des informations détaillées sur la ventilation du montant du tarif d'expédition.
quotes.mode.rates.amount DECIMALLe montant de l'élément de tarif spécifique.
quotes.mode.rates.note STRINGDétails supplémentaires sur ce que représente le montant de l'élément de tarif.
quotes.mode.rates.type STRINGLe type de l'élément de tarif. Les valeurs possibles incluent retail_shipping fuel_surcharge carrier_fee negotiated_discount.
quotes.packages LISTUne liste de détails sur les colis expédiés.
quotes.packages.id STRINGL'identifiant unique de l'objet packages.
quotes.packages.weight HASHHash contenant les détails du poids du colis.
quotes.packages.weight.billable DEMICALLe poids facturable du colis.
quotes.packages.weight.dimensional DECIMALLe poids dimensionnel du colis.
quotes.packages.weight.factor INTEGERLe facteur de poids international utilisé pour calculer le poids dimensionnel du colis.
quotes.packages.weight.weight_unit STRINGUne chaîne indiquant l'unité de mesure du poids.Les valeurs possibles sont pound ounce kilogram null.Lorsque null, pound sera utilisé.
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}

Cette page a-t-elle été utile?


Sur cette page :