跨境物流TMS API 文档 跨境物流TMS API 文档
首页
  • 获取token
  • 下单
  • 取消预报
  • 查询运单轨迹
  • 查询运单详情
  • 系统标签下载
首页
  • 获取token
  • 下单
  • 取消预报
  • 查询运单轨迹
  • 查询运单详情
  • 系统标签下载
  • 接口定义

    • 获取token
    • 下单
      • 请求头
      • 请求参数
      • 请求示例
      • 返回结果
    • 取消预报单
    • 查询运单轨迹
    • 查询运单详情
    • 系统标签下载
目录

下单

  • 接口说明: 预报下单
  • 接口地址: http://oms-api.szylyn.net/externalApi/orderCommit
  • 请求方式: POST

# 请求头

参数名称 类型 是否必填 描述
Header 请求报文头
  token String TRUE token
  appKey String TRUE AppKey

# 请求参数

参数名称 类型 是否必填 描述
  customerNumber String TRUE 客户单号
  productCode String TRUE 产品代码
  insured Integer FALSE 是否投保(0-否 1-是)
  insuredRate BigDecimal FALSE 投保比例
  customsDocUrl String FALSE 报关文件URL(需支持外网访问链接)
  insuranceDocUrl String FALSE 投保文件URL(需支持外网访问链接)
  receivingOutletsCode String FALSE 收货网点编码
  separateCustomsDeclaration Integer FALSE 是否单独报关(0-否 1-是)
  telephone String TRUE 收件人固定电话
  streetNumber String TRUE 收件门牌号
  isFba Integer TRUE 是否亚马逊仓库(0-否 1-是)
  warehouseCode String FALSE 系统仓库编码(与收件人信息二选一,如是否亚马逊仓库为是则必填)
  city String TRUE 收件城市 (与系统仓库编码二选一)
  receiver String TRUE 收件人 (与系统仓库编码二选一)
  receiverPhone String TRUE 收件人手机 (与系统仓库编码二选一)
  province String TRUE 收件省 (与系统仓库编码二选一)
  postcode String TRUE 收件邮编 (与系统仓库编码二选一)
  address1 String TRUE 地址1 (与系统仓库编码二选一)
  address2 String FALSE 地址2 (与系统仓库编码二选一)
  address3 String FALSE 地址3 (与系统仓库编码二选一)
  nationCode String TRUE 国家二字码
  receiveCompany String TRUE 收件公司
  fbaCode String TRUE FBA单号
  details List TRUE 细单集合
    packWeight BigDecimal TRUE 货箱重量
    boxLength BigDecimal TRUE 长
    boxWidth BigDecimal TRUE 宽
    boxHight BigDecimal TRUE 高
    box String TRUE 箱号(FBA单号传参 规则 XXXXU000001)
    referenceId String TRUE referenceId
  goods List 货物明细集合
    goodsCnName String TRUE 中文名
    goodsEnName String TRUE 英文名
    goodsUnitPrice BigDecimal TRUE 申报单价
    goodsDeclareNumber BigDecimal TRUE 申报数量
    goodsCustomsCode String TRUE 海关编码
    goodsPhoto String FALSE 商品主图(需支持外网访问链接)
    goodsMaterial String TRUE 商品材质
    goodsUseMethod String TRUE 商品用途
    goodsIsCharged Integer TRUE 是否带电(0-否 1-是)
    goodsBrand String FALSE 商品品牌
    goodsBrandType String FALSE 品牌类型
    goodsPattern String FALSE 型号

# 请求示例

Header:

appkey : 填您使用用户密钥 
token  : 填您获取到的token值

RequestBody:

{
  "productCode": "L-WK"
  "insuredRate": "",
  "customerNumber": "532211125132",
  "separateCustomsDeclaration": 1,
  "receiver": "ONT8",
  "receiverPhone": "6268618266",
  "warehouseCode": "",
  "isFba":0,
  "postcode": "92551-9534",
  "receiveCompany": "Amazon.com Services, Inc",
  "nationCode": "US",
  "province": "CA",
  "city": "Moreno Valley",
  "streetNumber": "",
  "receiverAddress": "",
  "address1": "24300 Nandina Ave",
  "address2": "",
  "address3": "",
  "details": [
    {
      "box": "1325151U001",
      "boxHight": "30",
      "boxLength": "20",
      "boxWidth": "20",
      "packWeight": "3",
      "referenceId": "111"
    },
    {
      "box": "1325151U002",
      "boxHight": "30",
      "boxLength": "20",
      "boxWidth": "20",
      "packWeight": "3",
      "referenceId": "111"
    },
    {
      "box": "1325151U003",
      "boxHight": "30",
      "boxLength": "20",
      "boxWidth": "20",
      "packWeight": "3",
      "referenceId": "111"
    },
    {
      "box": "1325151U004",
      "boxHight": "30",
      "boxLength": "20",
      "boxWidth": "20",
      "packWeight": "3",
      "referenceId": "111"
    },
    {
      "box": "1325151U005",
      "boxHight": "30",
      "boxLength": "20",
      "boxWidth": "20",
      "packWeight": "3",
      "referenceId": "111"
    }
  ],
  "goods": [
    {
      "goodsBrand": "无",
      "goodsBrandType": "无",
      "goodsCnName": "充气泳池",
      "goodsCustomsCode": "9506990000",
      "goodsDeclareNumber": 1,
      "goodsDeclareTotalPrice": "",
      "goodsEnName": "Inflatable Pools",
      "goodsIsCharged": 0,
      "goodsMaterial": "塑料",
      "goodsPattern": "22",
      "goodsPhoto": "",
      "goodsSoldUrl": "",
      "goodsUnitPrice": 8.23,
      "goodsUseMethod": "休闲娱乐",
      "goodsTotalPrice": "8.23"
    },
    {
      "goodsBrand": "无",
      "goodsBrandType": "无",
      "goodsCnName": "充气泳池",
      "goodsCustomsCode": "9506990000",
      "goodsDeclareNumber": 1,
      "goodsDeclareTotalPrice": "",
      "goodsEnName": "Inflatable Pools",
      "goodsIsCharged": 0,
      "goodsMaterial": "塑料",
      "goodsPattern": "22",
      "goodsPhoto": "",
      "goodsSoldUrl": "",
      "goodsUnitPrice": 8.23,
      "goodsUseMethod": "休闲娱乐",
      "goodsTotalPrice": "8.23"
    },
    {
      "goodsBrand": "无",
      "goodsBrandType": "无",
      "goodsCnName": "充气泳池",
      "goodsCustomsCode": "9506990000",
      "goodsDeclareNumber": 1,
      "goodsDeclareTotalPrice": "",
      "goodsEnName": "Inflatable Pools",
      "goodsIsCharged": 0,
      "goodsMaterial": "塑料",
      "goodsPattern": "22",
      "goodsPhoto": "",
      "goodsSoldUrl": "",
      "goodsUnitPrice": 8.23,
      "goodsUseMethod": "休闲娱乐",
      "goodsTotalPrice": "8.23"
    }
  ],
  "insuranceDocUrl": "",
  "customsDocUrl": "",
  "goodsNum": "11",
  "insured": 0,
  "fbaCode": "1325151",
}

# 返回结果

参数名称 类型 描述
data
 orderNumber String 订单号
code int 状态码
err string 错误信息
msg String 结果描述

返回示例:

{
  "code": 200,
  "data": {
    "orderNumber": "XXXXXXXX"
  },
  "err": "",
  "msg": "数据请求成功!"
}

错误提示:

//图片链接地址非空且非正常可访问链接时
{
  "code": 1126,
  "data": null,
  "err": "",
  "msg": "所传链接并非正确访问地址! 请核实后重试!"
}
上次更新: 2024/07/16, 11:08:37
获取token
取消预报单

← 获取token 取消预报单→

Theme by Vdoing | Copyright © 2022-2025 hnfsu
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式