API Docs
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

查询价格

接口URL

/shipment/rates

请求方式

POST

请求Body参数

参数名 示例值 参数类型 是否必填 参数描述
sellerOrderNumber TESTORDER-001 String 销售订单号
orderType 1 Number 订单类型, 1.快递单,2.LTL Freight订单。默认值为1 快递可不传,LTL Freight订单需传
serviceCodes - Array 服务渠道数组列表,不传默认为账号开放的所有渠道
shipFrom - Object 发件地址信息
shipFrom.code - String 发件地址代码
shipFrom.name TEST String 公司名或发件人
shipFrom.attentionName TEST String 发件人名称
shipFrom.countryCode US String 国家2位简写代码
shipFrom.stateCode CA String 州2位简写代码
shipFrom.city rowland height String 城市
shipFrom.addressLine1 test String 地址1
shipFrom.addressLine2 - Object 地址2
shipFrom.postalCode 91748 String 邮编
shipFrom.phone 0000000000 String 电话号码
shipFrom.phoneExtension 0000 String 电话号码分机号
shipFrom.isResidential - - 是否住宅地址,true或者false
shipTo - Object -
shipTo.name TEST String 公司名或收件人
shipTo.attentionName TEST String 收件人名称
shipTo.countryCode US String 国家2位简写代码
shipTo.stateCode CA String 州2位简写代码
shipTo.city rowland height String 城市
shipTo.addressLine1 test String 地址1
shipTo.addressLine2 - Object 地址2
shipTo.postalCode 91748 String 邮编
shipTo.phone 0000000000 String 电话号码
shipTo.phoneExtension 0000000000 String 电话号码分机号
shipTo.isResidential true Boolean 是否住宅地址,true或者false
packages - Object 包裹列表
packages.length 10 Number 包裹长
packages.width 10 Number 包裹宽
packages.height 10 Number 包裹高
packages.weight 14 Number 包裹重量(单个包裹)
packages.quantity 1 Number 包裹数量,LTL Freight单时为托数
packages.quantityUnitPcs 1 Number LTL单每托箱数,仅对LTL Freight单有效
packages.declaredValue 100 Number 包裹保险价值USD(单个包裹)
packages.reference1 REF01 String 包裹参考号1
packages.reference2 - Object 包裹参考号2
options - Object 订单服务选项
options.dimensionUnitCode IN String 包裹尺寸单位, 值为IN (英寸)
options.weightUnitCode LBS String 包裹重量单位,值为LBS (磅)
options.packageType customPackage String 包装类型,默认为自有包裹包装,暂无其它值
options.shipDate 2022-05-14 String 快递单发货日期,LTL Freight单提货日期必填,格式:2022-01-01
options.deliveryConfirmation signature String 签名服务方式,无签收:none,普通签收:signature ,成人签收:adultSignature
orderInsurance 订单保险 Object 渠道按订单购买保险,仅支持可按订单总购买保险时有效,请咨询客户经理
orderInsurance.amount 1000 Number 订单保险总额
orderInsurance.currencyCode EUR String 币种,如EUR,USD等,不同渠道支持可能不同,请咨询客户经理

请求示例

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