DOCS

Objeto Rating

Objeto Rating

Explore las capacidades y funciones del objeto Rating.

El objeto Rating proporcionará cotizaciones de envío por nivel de servicio con un desglose de recargos, tasas y descuentos de tarifa negociada que componen la cotización.

Atributos 

CampoNotas
id STRINGEl identificador único del objeto. El id del objeto rating siempre tendrá el prefijo ship.
currency HASHHash que proporciona información sobre la moneda base enviada en la solicitud y proporcionada para la respuesta.
currency.id STRINGEl identificador único del objeto currency.
currency.base STRINGLa moneda base enviada en la solicitud de rating, representada por un código ISO de tres letras. Todos los montos en el objeto rating se indican en la moneda base.
currency.date TIMESTAMPLa fecha en la que se obtuvo la tasa de cambio, en formato ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ.
currency.rates HASHHash que contiene las monedas y los tipos de cambio necesarios para la conversión desde la moneda base.
errors HASHHash que contiene los detalles de cualquier error en la solicitud.
errors.type STRINGEl origen del error. Los valores posibles incluyen fedex_api ups_api dhl_api usps_api internal_error zonos_configuration.
errors.message STRINGLa razón descriptiva del error del transportista correspondiente.
errors.details HASHHash que contiene detalles sobre el nivel de servicio que devolvió un error.
errors.details.id STRINGEl identificador único del nivel de servicio.
errors.details.service_level STRINGEl nivel de servicio con el transportista, p. ej., standard.
errors.details.display_name STRINGEl nombre para mostrar del nivel de servicio.
quotes LISTLa lista de cotizaciones de envío por nivel de servicio.
quotes.id STRINGEl identificador único del objeto. El id del objeto quotes siempre tendrá el prefijo rtqt.
quotes.amount_subtotal DECIMALEl costo total de envío calculado para el nivel de servicio.
quotes.weight HASHHash que proporciona información sobre el peso utilizado para el costo de envío cotizado.
quotes.weight.billable DECIMALEl peso facturable del paquete utilizado para la cotización de envío.
quotes.weight.unit STRINGLa unidad de medida para el peso. Valores posibles: pound, ounce, kilogram y null. Cuando es null, se utilizará pound.
quotes.mode HASHHash que contiene información detallada sobre el nivel de servicio.
quotes.mode.service_level STRINGEl service_level con el transportista, p. ej., standard. Ejemplos comunes incluyen: 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 y fedex_international_ground. Consulte la documentación de transportistas para obtener la lista completa de niveles de servicio disponibles por transportista.
quotes.mode.display_name STRINGEl nombre para mostrar del nivel de servicio.
quotes.mode.delivery_date_estimate TIMESTAMPLa fecha estimada de entrega para el nivel de servicio, en formato ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ. Se devolverá si está disponible desde la API del transportista.
quotes.mode.transit_business_days INTEGEREl número estimado de días de tránsito para el nivel de servicio, contando solo los días hábiles como días de tránsito. Se devolverá si está disponible desde la API del transportista.
quotes.mode.transit_days INTEGEREl número estimado de días de tránsito para el nivel de servicio. Se devolverá si está disponible desde la API del transportista.
quotes.mode.rates HASHHash que contiene información detallada sobre el desglose del monto de la tarifa de envío.
quotes.mode.rates.amount DECIMALEl monto del elemento de tarifa específico.
quotes.mode.rates.note STRINGDetalles adicionales sobre lo que representa el monto del elemento de tarifa.
quotes.mode.rates.type STRINGEl tipo del elemento de tarifa. Los valores posibles incluyen retail_shipping fuel_surcharge carrier_fee negotiated_discount.
quotes.packages LISTUna lista de detalles sobre los paquetes que se envían.
quotes.packages.id STRINGEl identificador único del objeto packages.
quotes.packages.weight HASHHash que contiene detalles del peso del paquete.
quotes.packages.weight.billable DEMICALEl peso facturable del paquete.
quotes.packages.weight.dimensional DECIMALEl peso dimensional del paquete.
quotes.packages.weight.factor INTEGEREl factor de peso internacional utilizado para calcular el peso dimensional del paquete.
quotes.packages.weight.weight_unit STRINGUna cadena con la unidad de medida para el peso. Valores posibles: pound ounce kilogram null. Cuando es null, se utilizará 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}

¿Fue útil esta página?


En esta página: