查询价格
该接口用于查询渠道报价。如果不传 serviceCodes
,系统将默认返回账号下已开放的所有可用渠道报价。
接口URL
/shipment/rates
请求方式
POST
请求Body参数
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
sellerOrderNumber | TESTORDER-001 | String | 否 | 销售订单号 |
serviceCodes | [] | Array | 否 | 服务渠道数组,如为空则返回账号下所有可用渠道 |
shipFrom(发件人信息对象) | ||||
code | – | String | 否 | 发件地址代码 |
name | TEST | String | 是 | 公司名或发件人 |
attentionName | TEST | String | 否 | 发件人名称 |
countryCode | US | String | 是 | 国家二位简码 |
stateCode | CA | String | 是 | 州二位简码 |
city | rowland height | String | 是 | 城市 |
addressLine1 | test | String | 是 | 地址1 |
addressLine2 | – | String | 否 | 地址2 |
postalCode | 91748 | String | 是 | 邮编 |
phone | 0000000000 | String | 是 | 电话号码 |
phoneExtension | 0000 | String | 否 | 电话号码分机号 |
isResidential | false | Boolean | 是 | 是否为住宅地址 |
shipTo(收件人信息对象) | ||||
name | TEST | String | 是 | 公司名或收件人 |
attentionName | TEST | String | 否 | 收件人名称 |
countryCode | US | String | 是 | 国家二位简码 |
stateCode | CA | String | 是 | 州二位简码 |
city | rowland height | String | 是 | 城市 |
addressLine1 | test | String | 是 | 地址1 |
addressLine2 | – | String | 是 | 地址2 |
postalCode | 91748 | String | 是 | 邮编 |
phone | 0000000000 | String | 是 | 电话号码 |
phoneExtension | 0000000000 | String | 否 | 电话号码分机号 |
isResidential | true | Boolean | 是 | 是否为住宅地址 |
packages(包裹信息数组) | ||||
length | 10 | Number | 是 | 包裹长度 |
width | 10 | Number | 是 | 包裹宽度 |
height | 10 | Number | 是 | 包裹高度 |
weight | 14 | Number | 是 | 包裹重量 |
quantity | 1 | Number | 是 | 包裹数量 |
declaredValue | 100 | Number | 否 | 保价金额(美元) |
reference1 | REF01 | String | 否 | 参考号1 |
reference2 | – | String | 否 | 参考号2 |
options(订单服务选项) | ||||
dimensionUnitCode | IN | String | 是 | 尺寸单位,IN = 英寸 |
weightUnitCode | LBS | String | 是 | 重量单位,LBS = 磅 |
packageType | customPackage | String | 否 | 包装类型(默认自有包装) |
shipDate | 2022-05-14 | String | 否 | 发货日期(YYYY-MM-DD) |
deliveryConfirmation | signature | String | 否 | 签收服务:none / signature / adultSignature |
请求示例
{ "sellerOrderNumber": "TESTORDER-001", "serviceCodes": [], "shipFrom": { "code": "", "name": "TEST", "attentionName": "TEST", "countryCode": "US", "stateCode": "CA", "city": "rowland height", "addressLine1": "test", "addressLine2": "", "postalCode": "91748", "phone": "0000000000", "phoneExtension": "0000", "isResidential": false }, "shipTo": { "name": "TEST", "attentionName": "TEST", "countryCode": "US", "stateCode": "CA", "city": "rowland height", "addressLine1": "test", "addressLine2": "", "postalCode": "91748", "phone": "0000000000", "phoneExtension": "0000000000", "isResidential": true }, "packages": [ { "length": 10, "width": 10, "height": 10, "weight": 14, "quantity": 1, "declaredValue": 100, "reference1": "REF01", "reference2": "" } ], "options": { "dimensionUnitCode": "IN", "weightUnitCode": "LBS", "packageType": "customPackage", "shipDate": "2022-05-14", "deliveryConfirmation": "signature" } }
返回示例
{ "code": 200, "data": { "rates": [ { "rateId": "rate_clrt0d0o2hotek12v7u0", "rate": 13.06, "chargeItems": null, "currencyCode": "USD", "carrierCode": "FedEx", "carrierName": "FedEx", "serviceCode": "FedExGround", "accountCode": "FedEx", "isCubic": false } ], "messages": null }, "message": "success" }