DOCS

Rating object

/

Objet de notation

Explorez les capacités et fonctions de l'objet de notation.

L'objet de notation fournira des devis d'expédition par niveau de service avec un détail des suppléments, des frais et des remises négociées sur le rate qui composent le devis.

Attributs 

ChampNotes
id CHAÎNE DE CARACTÈRESL'identifiant unique de l'objet. L'identifiant de l'objet de notation sera toujours précédé de ship.
currency HACHAGEHachage fournissant des informations sur la devise de base envoyée dans la demande et fournie pour la réponse.
currency.id CHAÎNE DE CARACTÈRESL'identifiant unique de l'objet de devise.
currency.base CHAÎNE DE CARACTÈRESLa devise de base telle qu'envoyée dans la demande de notation, représentée par un code ISO à trois lettres. Tous les montants dans l'objet de notation sont répertoriés dans la devise de base.
currency.date TIMESTAMPLa date à laquelle le taux de change de la devise rate a été extrait, au format ISO 8601 AAAA-MM-JJTHH:mm:ss.sssZ.
currency.rates HACHAGEHachage contenant les devises et les taux de change nécessaires pour la conversion à partir de la devise de base.
errors HACHAGEHachage contenant les détails de toutes les erreurs sur la demande.
errors.type CHAÎNE DE CARACTÈRESL'origine de l'erreur. Les valeurs possibles incluent fedex_api, ups_api, dhl_api, usps_api, internal_error, zonos_configuration.
errors.message CHAÎNE DE CARACTÈRESLa raison descriptive de l'erreur provenant du transporteur correspondant.
errors.details HACHAGEHachage contenant des détails sur le niveau de service qui a renvoyé une erreur.
errors.details.id CHAÎNE DE CARACTÈRESL'identifiant unique du niveau de service.
errors.details.service_level CHAÎNE DE CARACTÈRESLe niveau de service avec le transporteur, par exemple standard.
errors.details.display_name CHAÎNE DE CARACTÈRESLe nom d'affichage pour le niveau de service.
quotes LISTELa liste des devis d'expédition par niveau de service.
quotes.id CHAÎNE DE CARACTÈRESL'identifiant unique de l'objet. L'identifiant de l'objet de devis sera toujours précédé de rtqt.
quotes.amount_subtotal DÉCIMALLe coût total calculé de l'expédition pour le niveau de service.
quotes.weight HACHAGEHachage fournissant des informations sur le poids utilisé pour le coût d'expédition indiqué.
quotes.weight.billable DÉCIMALLe poids facturable du colis utilisé pour le devis d'expédition.
quotes.weight.unit CHAÎNE DE CARACTÈRESL'unité de mesure du poids. Les valeurs possibles sont pound, ounce, kilogram et null. Lorsque null, pound sera utilisé.
quotes.mode HACHAGEHachage contenant des informations détaillées sur le niveau de service.
quotes.mode.service_level CHAÎNE DE CARACTÈRESLe niveau de service avec le transporteur, par exemple standard. Les exemples courants incluent : 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 du transporteur pour la liste complète des niveaux de service disponibles par transporteur.
quotes.mode.display_name CHAÎNE DE CARACTÈRESLe nom d'affichage pour le niveau de service.
quotes.mode.delivery_date_estimate TIMESTAMPLa date estimée de livraison pour le niveau de service, au format ISO 8601 AAAA-MM-JJTHH:mm:ss.sssZ. Cela sera retourné si disponible depuis 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 ouvrables comme jours de transit. Cela sera retourné si disponible depuis l'API du transporteur.
quotes.mode.transit_days INTEGERLe nombre estimé de jours de transit pour le niveau de service. Cela sera retourné si disponible depuis l'API du transporteur.
quotes.mode.rates HASHHash contenant des informations détaillées sur la répartition du montant du rate d'expédition.
quotes.mode.rates.amount DECIMALLe montant spécifique de l'élément de rate.
quotes.mode.rates.note STRINGDétails supplémentaires sur ce que représente le montant de l'élément de rate.
quotes.mode.rates.type STRINGLe type de l'élément de rate. 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 colis.
quotes.packages.weight HASHHash contenant les détails du poids du colis.
quotes.packages.weight.billable DECIMALLe 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 avec l'unité de mesure du poids. Les valeurs possibles sont pound, ounce, kilogram, null. Lorsque null, pound sera utilisé.

Exemple de réponse

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"
      }
    }
  ]
}

Cette page était-elle utile?


Des questions ?

Contactez-nous.