DOCS

Rating object

/
ДомойСправочник API API оценки REST Объект рейтинга

Объект рейтинга

Изучите возможности и функции объекта рейтинга.

Объект рейтинга предоставит расценки на доставку по уровням обслуживания с разбивкой по надбавкам, сборам и согласованным rate скидкам, которые составляют расценку.

Атрибуты 

ПолеЗаметки
id STRINGУникальный идентификатор объекта. Идентификатор для объекта рейтинга всегда будет начинаться с ship.
currency HASHХэш, предоставляющий информацию о базовой валюте, отправленной в запросе и предоставленной в ответе.
currency.id STRINGУникальный идентификатор для объекта валюты.
currency.base STRINGБазовая валюта, отправленная в запросе на рейтинг, представлена трехбуквенным ISO кодом. Все суммы в объекте рейтинга указаны в базовой валюте.
currency.date TIMESTAMPДата, когда валюта rate была получена, в формате ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ.
currency.rates HASHХэш, содержащий валюты и обменные курсы, необходимые для конвертации из базовой валюты.
errors HASHХэш, содержащий детали любых ошибок в запросе.
errors.type STRINGПроисхождение ошибки. Возможные значения включают fedex_api ups_api dhl_api usps_api internal_error zonos_configuration.
errors.message STRINGОписательная причина ошибки от соответствующего перевозчика.
errors.details HASHХэш, содержащий детали уровня обслуживания, который вернул ошибку.
errors.details.id STRINGУникальный идентификатор для уровня обслуживания.
errors.details.service_level STRINGУровень обслуживания у перевозчика, например, standard.
errors.details.display_name STRINGОтображаемое имя для уровня обслуживания.
quotes LISTСписок предложений по доставке по уровням обслуживания.
quotes.id STRINGУникальный идентификатор для объекта. Идентификатор для объекта предложений всегда будет начинаться с rtqt.
quotes.amount_subtotal DECIMALОбщая рассчитанная стоимость доставки для уровня обслуживания.
quotes.weight HASHХэш, предоставляющий информацию о весе, использованном для расчетной стоимости доставки.
quotes.weight.billable DECIMALОплачиваемый вес пакета, использованный для расчета стоимости доставки.
quotes.weight.unit STRINGЕдиница измерения для веса. Возможные значения: pound, ounce, kilogram и null. При null будет использоваться pound.
quotes.mode HASHХэш, содержащий подробную информацию о уровне обслуживания.
quotes.mode.service_level STRINGУровень обслуживания у перевозчика, например, standard. Общие примеры включают: 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 и fedex_international_ground. См. документацию перевозчиков для полного списка доступных уровней обслуживания по перевозчику.
quotes.mode.display_name STRINGОтображаемое имя для уровня обслуживания.
quotes.mode.delivery_date_estimate TIMESTAMPОжидаемая дата доставки для уровня сервиса в формате ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ. Это будет возвращено, если доступно из API перевозчика.
quotes.mode.transit_business_days INTEGERОжидаемое количество дней транзита для уровня сервиса, учитывая только рабочие дни как дни транзита. Это будет возвращено, если доступно из API перевозчика.
quotes.mode.transit_days INTEGERОжидаемое количество дней транзита для уровня сервиса. Это будет возвращено, если доступно из API перевозчика.
quotes.mode.rates HASHХэш, содержащий подробную информацию о разбивке суммы доставки rate.
quotes.mode.rates.amount DECIMALСумма конкретного элемента rate.
quotes.mode.rates.note STRINGДополнительные детали о том, что представляет собой сумма элемента rate.
quotes.mode.rates.type STRINGТип элемента rate. Возможные значения включают retail_shipping fuel_surcharge carrier_fee negotiated_discount.
quotes.packages LISTСписок деталей о посылках, которые отправляются.
quotes.packages.id STRINGУникальный идентификатор для объекта посылки.
quotes.packages.weight HASHХэш, содержащий детали веса для посылки.
quotes.packages.weight.billable DECIMALОплачиваемый вес посылки.
quotes.packages.weight.dimensional DECIMALОбъемный вес посылки.
quotes.packages.weight.factor INTEGERМеждународный вес, используемый для расчета объемного веса для посылки.
quotes.packages.weight.weight_unit STRINGСтрока с единицей измерения для веса. Возможные значения: pound ounce kilogram null. Когда null, будет использоваться pound.

Пример ответа

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

Была ли эта страница полезной?

© 2024 Zonoszonos.com
На этой странице: