API文档
使用手册
API文档
使用手册
  • 简介
  • 使用说明
  • 订单API

    • 创建订单
    • 取消订单
    • 生成ScanForm单据
    • 获取Fba仓
    • 获取用户信息
    • 获取订单信息列表数据
    • 获取面单
    • 费用试算
    • 推送订单物流轨迹协议
    • 根据物流单号获取面单信息
  • 运营API

    • 运营
    • 运营api

费用试算

场景说明

提交订单预报参数进行费用试算。

接口名

{域名}/api/svc/rates

请求方式

POST

Header请求头

参数名是否必填类型说明
Authorization是string授权码:访问授权 Token

请求参数

参数名二级参数名是否必填类型说明
reference_no-是string参考号(客户单号),长度不得超过35位
sm_code-是string物流产品代码, 可咨询服务商或使用getUserInfo查询
remark否string订单备注信息 长度不得超过35位
oa_firstname是string收件人姓名 长度不能小于3位,并且长度不能大于35位
oa_company否string收件人公司 长度不得超过35位
oa_street_address1是string收件人地址1 长度不得超过35位
oa_street_address2否string收件人地址2 长度不得超过35位
oa_postcode是string收件人邮编 5-4格式邮编,邮编长度最短5位数,最长10位数
oa_state是string收件人州 需要填写两位简称,只能为大写二字编码
oa_city是string收件人城市 长度最短1位数,最长30位数
oa_country是string收件人国家 要求固定值US
oa_telphone是string收件人电话 10-15位之间
is_more_box是integer包裹类型:固定值,请传1
signature_service否string签名服务:是否需要签名服务:ASS为 成人签名 ,SSF为 普通签名,不需要可以不传该字段
weight_unit_type否integer包裹单位类型: 1-英制(INCH/LBS) 2-公制(CM/KG) 默认为2
box_list是array包裹信息
-box_listbox_length是number长
-box_listbox_width是number宽
-box_listbox_height是number高
-box_listbox_actual_weight是number重量
shipper_address是object发件人信息, 发件人信息必须与我司备案信息完全一致, 发件人信息与发件人编码同时存在时,以发件人信息为准
-shipper_addressshipper_name是string发件人姓名,长度最短3位数,最长35位数
-shipper_addressshipper_company否string发件人公司, 长度最长35位数
-shipper_addressshipper_telphone是string发件人电话, 10-15位之间
-shipper_addressshipper_country是string发件人国家, 要求固定值US
-shipper_addressshipper_state_province是string发件人州, 只能为大写二字编码
-shipper_addressshipper_city是string发件人城市, 长度最短1位数,最长30位数
-shipper_addressshipper_address1是string发件人地址1,长度不得超过35位
-shipper_addressshipper_address2否string发件人地址2,长度不得超过35位
-shipper_addressshipper_postal_code是string发件人邮编, 长度最短5位数,最长10位数
shipper_code是string发件人编码, 发件人信息与发件人编码同时存在时,以发件人信息为准

输入示例(body)


{
    "reference_no": "string",
    "sm_code": "string",
    "remark": "string",
    "oa_firstname": "string",
    "oa_company": "string",
    "oa_street_address1": "string",
    "oa_street_address2": "string",
    "oa_postcode": "string",
    "oa_state": "string",
    "oa_city": "string",
    "oa_country": "string",
    "oa_telphone": "string",
    "is_more_box": 1,
    "signature_service": "string",
    "weight_unit_type": 2,
    "box_list": [
        {
            "box_length": 0,
            "box_width": 0,
            "box_height": 0,
            "box_actual_weight": 0
        }
    ],
    "`shipper_address`": {
        "shipper_name": "string",
        "shipper_company": "string",
        "shipper_telphone": "string",
        "shipper_country": "string",
        "shipper_state_province": "string",
        "shipper_city": "string",
        "shipper_address1": "string",
        "shipper_address2": "string",
        "shipper_postal_code": "string"
    },
    "shipper_code": "string"
}


返回参数

参数名二级参数名是否必填类型说明
code-是string响应码,200-成功
result-是object响应结果
msg-是string响应消息
-resultsm_code是string物流产品
-resultaddress_type_text是string地址类型描述
-resultaddress_type是integer地址类型
-resultamount是string金额
-resultcurrency_code是string币种
-resulttotal_charge是string总金额
-resultshipping_charge是string基础运费
-resultcharge_detail是array费用明细
-result.charge_detailcharge_desc是string费用描述
-result.ft_codeft_code是string费用英文名称
-result.fee_type_codefee_type_code是string费用编码

| -result.charge_detail | amount | 是 | string | 金额 |

输出示例

{
  "code": 200,
  "result": {
    "sm_code": "FedEx",
    "address_type_text": "Residential",
    "address_type": 1,
    "currency_code": "USD",
    "total_charge": "4",
    "shipping_charge": "1",
    "charge_detail": [
      {
        "charge_desc": "运费",
        "amount": "1"
      },
      {
        "charge_desc": "成人签名签收服务",
        "amount": "1"
      },
      {
        "charge_desc": "住宅地址附加费",
        "amount": "1"
      },
      {
        "charge_desc": "燃油附加费",
        "amount": "1"
      }
    ]
  },
  "msg": "Success"
}
最近更新:: 2025/8/1 17:55
Contributors: lizhi
上一页
获取面单
下一页
推送订单物流轨迹协议