Atributos
| Campo↕ | Notas↕ |
|---|---|
id STRING | O identificador exclusivo do objeto. O id do objeto rating sempre terá o prefixo ship. |
currency HASH | Hash que fornece informações sobre a moeda base enviada na solicitação e fornecida na resposta. |
currency.id STRING | O identificador exclusivo do objeto currency. |
currency.base STRING | A moeda base enviada na solicitação de rating, representada por um código ISO de três letras. Todos os valores no objeto rating são exibidos na moeda base. |
currency.date TIMESTAMP | A data em que a taxa de câmbio foi obtida, no formato ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ. |
currency.rates HASH | Hash que contém as moedas e as taxas de câmbio necessárias para a conversão a partir da moeda base. |
errors HASH | Hash que contém os detalhes de qualquer erro na solicitação. |
errors.type STRING | A origem do erro. Os valores possíveis incluem fedex_api ups_api dhl_api usps_api internal_error zonos_configuration. |
errors.message STRING | O motivo descritivo do erro da transportadora correspondente. |
errors.details HASH | Hash que contém detalhes sobre o nível de serviço que retornou um erro. |
errors.details.id STRING | O identificador exclusivo do nível de serviço. |
errors.details.service_level STRING | O nível de serviço com a transportadora, por exemplo, standard. |
errors.details.display_name STRING | O nome de exibição do nível de serviço. |
quotes LIST | A lista de cotações de frete por nível de serviço. |
quotes.id STRING | O identificador exclusivo do objeto. O id do objeto quotes sempre terá o prefixo rtqt. |
quotes.amount_subtotal DECIMAL | O custo total de frete calculado para o nível de serviço. |
quotes.weight HASH | Hash que fornece informações sobre o peso utilizado para o custo de frete cotado. |
quotes.weight.billable DECIMAL | O peso tarifável do pacote utilizado para a cotação de frete. |
quotes.weight.unit STRING | A unidade de medida do peso. Os valores possíveis são pound, ounce, kilogram e null. Quando null, será utilizado pound. |
quotes.mode HASH | Hash que contém informações detalhadas sobre o nível de serviço. |
quotes.mode.service_level STRING | O service_level com a transportadora, 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. Consulte a documentação de transportadoras para a lista completa de níveis de serviço disponíveis por transportadora. |
quotes.mode.display_name STRING | O nome de exibição do nível de serviço. |
quotes.mode.delivery_date_estimate TIMESTAMP | A data estimada de entrega para o nível de serviço, no formato ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ. Será retornada se disponível na API da transportadora. |
quotes.mode.transit_business_days INTEGER | O 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. Será retornado se disponível na API da transportadora. |
quotes.mode.transit_days INTEGER | O número estimado de dias de trânsito para o nível de serviço. Será retornado se disponível na API da transportadora. |
quotes.mode.rates HASH | Hash que contém informações detalhadas sobre o detalhamento do valor da tarifa de frete. |
quotes.mode.rates.amount DECIMAL | O valor do item de tarifa específico. |
quotes.mode.rates.note STRING | Detalhes adicionais sobre o que o valor do item de tarifa representa. |
quotes.mode.rates.type STRING | O tipo do item de tarifa. Os valores possíveis incluem retail_shipping fuel_surcharge carrier_fee negotiated_discount. |
quotes.packages LIST | Uma lista de detalhes sobre os pacotes que estão sendo enviados. |
quotes.packages.id STRING | O identificador exclusivo do objeto packages. |
quotes.packages.weight HASH | Hash que contém detalhes do peso do pacote. |
quotes.packages.weight.billable DEMICAL | O peso tarifável do pacote. |
quotes.packages.weight.dimensional DECIMAL | O peso dimensional do pacote. |
quotes.packages.weight.factor INTEGER | O fator de peso internacional utilizado para calcular o peso dimensional do pacote. |
quotes.packages.weight.weight_unit STRING | Uma string com a unidade de medida do peso. Os valores possíveis são pound ounce kilogram null. Quando null, será utilizado 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": null52
},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": null100
},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
}
Objeto Rating
Explore as capacidades e funções do objeto Rating.
O objeto Rating fornecerá cotações de frete por nível de serviço com um detalhamento de sobretaxas, taxas e descontos de tarifa negociada que compõem a cotação.