属性
| フィールド↕ | 備考↕ |
|---|---|
id STRING | オブジェクトの一意の識別子。rating objectのidは常に ship で始まります。 |
currency HASH | リクエストで送信され、レスポンスで提供される基準通貨に関する情報を提供するハッシュ。 |
currency.id STRING | 通貨オブジェクトの一意の識別子。 |
currency.base STRING | ratingリクエストで送信された基準通貨。3文字のISOコードで表されます。rating object内のすべての金額は基準通貨で表示されます。 |
currency.date TIMESTAMP | 通貨レートが取得された日付。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 | エラーを返したservice levelの詳細を含むハッシュ。 |
errors.details.id STRING | service levelの一意の識別子。 |
errors.details.service_level STRING | キャリアのservice level。例:standard。 |
errors.details.display_name STRING | service levelの表示名。 |
quotes LIST | service level別の配送見積もりリスト。 |
quotes.id STRING | オブジェクトの一意の識別子。quotes objectのidは常に rtqt で始まります。 |
quotes.amount_subtotal DECIMAL | service levelの合計配送コスト。 |
quotes.weight HASH | 見積もり配送コストに使用された重量に関する情報を提供するハッシュ。 |
quotes.weight.billable DECIMAL | 配送見積もりに使用されたパッケージの請求重量。 |
quotes.weight.unit STRING | 重量の計量単位。可能な値:pound、ounce、kilogram、null。null の場合は pound が使用されます。 |
quotes.mode HASH | service levelの詳細情報を含むハッシュ。 |
quotes.mode.service_level STRING | キャリアのservice_level。例: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。キャリアドキュメントでキャリア別の利用可能なservice levelの完全なリストを確認してください。 |
quotes.mode.display_name STRING | service levelの表示名。 |
quotes.mode.delivery_date_estimate TIMESTAMP | service levelの推定配送日。ISO 8601形式 YYYY-MM-DDTHH:mm:ss.sssZ。キャリアAPIから利用可能な場合に返されます。 |
quotes.mode.transit_business_days INTEGER | service levelの推定輸送日数(営業日のみを輸送日としてカウント)。キャリアAPIから利用可能な場合に返されます。 |
quotes.mode.transit_days INTEGER | service levelの推定輸送日数。キャリアAPIから利用可能な場合に返されます。 |
quotes.mode.rates HASH | 配送料金額の内訳に関する詳細情報を含むハッシュ。 |
quotes.mode.rates.amount DECIMAL | 特定の料金項目の金額。 |
quotes.mode.rates.note STRING | 料金項目の金額が何を表すかの追加詳細。 |
quotes.mode.rates.type STRING | 料金項目のタイプ。可能な値:retail_shipping fuel_surcharge carrier_fee negotiated_discount。 |
quotes.packages LIST | 配送されるパッケージの詳細リスト。 |
quotes.packages.id STRING | packages objectの一意の識別子。 |
quotes.packages.weight HASH | パッケージの重量詳細を含むハッシュ。 |
quotes.packages.weight.billable DEMICAL | パッケージの請求重量。 |
quotes.packages.weight.dimensional DECIMAL | パッケージの容積重量。 |
quotes.packages.weight.factor INTEGER | パッケージの容積重量を計算するために使用される国際重量係数。 |
quotes.packages.weight.weight_unit STRING | 重量の計量単位を示す文字列。可能な値:pound ounce kilogram null。null の場合は 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
}
Rating object
Rating objectの機能と役割を確認します。
Rating objectは、service level別の配送見積もりと、見積もりを構成する追加料金、手数料、交渉済み料金割引の内訳を提供します。