查询价格


该接口用于查询渠道报价。如果不传 serviceCodes,系统将默认返回账号下已开放的所有可用渠道报价。

接口URL

/shipment/rates

请求方式

POST

请求Body参数

参数名示例值参数类型是否必填参数描述
sellerOrderNumberTESTORDER-001String销售订单号
serviceCodes[]Array服务渠道数组,如为空则返回账号下所有可用渠道
shipFrom(发件人信息对象)
codeString发件地址代码
nameTESTString公司名或发件人
attentionNameTESTString发件人名称
countryCodeUSString国家二位简码
stateCodeCAString州二位简码
cityrowland heightString城市
addressLine1testString地址1
addressLine2String地址2
postalCode91748String邮编
phone0000000000String电话号码
phoneExtension0000String电话号码分机号
isResidentialfalseBoolean是否为住宅地址
shipTo(收件人信息对象)
nameTESTString公司名或收件人
attentionNameTESTString收件人名称
countryCodeUSString国家二位简码
stateCodeCAString州二位简码
cityrowland heightString城市
addressLine1testString地址1
addressLine2String地址2
postalCode91748String邮编
phone0000000000String电话号码
phoneExtension0000000000String电话号码分机号
isResidentialtrueBoolean是否为住宅地址
packages(包裹信息数组)
length10Number包裹长度
width10Number包裹宽度
height10Number包裹高度
weight14Number包裹重量
quantity1Number包裹数量
declaredValue100Number保价金额(美元)
reference1REF01String参考号1
reference2String参考号2
options(订单服务选项)
dimensionUnitCodeINString尺寸单位,IN = 英寸
weightUnitCodeLBSString重量单位,LBS = 磅
packageTypecustomPackageString包装类型(默认自有包装)
shipDate2022-05-14String发货日期(YYYY-MM-DD)
deliveryConfirmationsignatureString签收服务: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"
}