DOCS

Rating object

/
InícioReferência da API API de classificação REST Objeto de Avaliação

Objeto de Avaliação

Explore as capacidades e funções do objeto de avaliação.

O objeto de avaliação fornecerá cotações de envio por nível de serviço com uma quebra de sobretaxas, taxas e descontos negociados de rate que compõem a cotação.

Atributos 

CampoNotas
id STRINGO identificador único para o objeto. O id para o objeto de classificação sempre será prefixado com ship.
currency HASHHash fornecendo informações sobre a moeda base enviada na solicitação e fornecida para a resposta.
currency.id STRINGO identificador único para o objeto de moeda.
currency.base STRINGA moeda base conforme enviada na solicitação de classificação, representada por um código ISO de três letras. Todos os valores no objeto de classificação estão listados na moeda base.
currency.date TIMESTAMPA data em que a rate da moeda foi obtida, no formato ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ.
currency.rates HASHHash contendo as moedas e taxas de câmbio necessárias para conversão da moeda base.
errors HASHHash contendo os detalhes de quaisquer erros na solicitação.
errors.type STRINGA origem do erro. Valores possíveis incluem fedex_api ups_api dhl_api usps_api internal_error zonos_configuration.
errors.message STRINGA razão descritiva para o erro do transportador correspondente.
errors.details HASHHash contendo detalhes sobre o nível de serviço que retornou um erro.
errors.details.id STRINGO identificador único para o nível de serviço.
errors.details.service_level STRINGO nível de serviço com o transportador, por exemplo, standard.
errors.details.display_name STRINGO nome de exibição para o nível de serviço.
quotes LISTA lista de cotações de envio por nível de serviço.
quotes.id STRINGO identificador único para o objeto. O id para o objeto de cotações sempre será prefixado com rtqt.
quotes.amount_subtotal DECIMALO custo total de envio calculado para o nível de serviço.
quotes.weight HASHHash fornecendo informações sobre o peso usado para o custo de envio cotado.
quotes.weight.billable DECIMALO peso faturável do pacote usado para a cotação de envio.
quotes.weight.unit STRINGA unidade de medida para o peso. Valores possíveis são pound, ounce, kilogram, e null. Quando null, pound será usado.
quotes.mode HASHHash contendo informações detalhadas sobre o nível de serviço.
quotes.mode.service_level STRINGO nível de serviço com o transportador, por exemplo, standard. Exemplos comuns incluem: 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, e fedex_international_ground. Veja os documentos do transportador para a lista completa de níveis de serviço disponíveis por transportador.
quotes.mode.display_name STRINGO nome de exibição para o nível de serviço.
quotes.mode.delivery_date_estimate TIMESTAMPA data estimada de entrega para o nível de serviço, no formato ISO 8601 AAAA-MM-DDTHH:mm:ss.sssZ. Isso será retornado se estiver disponível na API da transportadora.
quotes.mode.transit_business_days INTEGERO número estimado de dias de trânsito para o nível de serviço contando apenas os dias úteis como dias de trânsito. Isso será retornado se estiver disponível na API da transportadora.
quotes.mode.transit_days INTEGERO número estimado de dias de trânsito para o nível de serviço. Isso será retornado se estiver disponível na API da transportadora.
quotes.mode.rates HASHHash contendo informações detalhadas sobre a divisão do valor da rate de envio.
quotes.mode.rates.amount DECIMALO valor específico do item de rate.
quotes.mode.rates.note STRINGDetalhes adicionais sobre o que o valor do item de rate representa.
quotes.mode.rates.type STRINGO tipo do item de rate. Os valores possíveis incluem retail_shipping, fuel_surcharge, carrier_fee, negotiated_discount.
quotes.packages LISTUma lista de detalhes sobre os pacotes sendo enviados.
quotes.packages.id STRINGO identificador único para o objeto de pacotes.
quotes.packages.weight HASHHash contendo detalhes do peso do pacote.
quotes.packages.weight.billable DECIMALO peso faturável do pacote.
quotes.packages.weight.dimensional DECIMALO peso dimensional do pacote.
quotes.packages.weight.factor INTEGERO fator de peso internacional usado para calcular o peso dimensional do pacote.
quotes.packages.weight.weight_unit STRINGUma string com a unidade de medida para o peso. Os valores possíveis são libra, onça, quilograma, nulo. Quando nulo, libra será usado.

Exemplo de resposta

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

Esta página foi útil?

© 2024 Zonoszonos.com
Nesta página:
  • Objeto de Avaliação
  • Atributos