海外仓对外接口

接口头统一说明


当前线上域名:
国内使用:https://kjhwc.net/
国外使用:https://kjhwc.com/
测试账号:sz2082636    密码:xsp2082636

获取Token

  • URL:tokens/getTmsToken.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded

Body参数

参数 类型 说明
username String 我司平台登录账号
password String 我司平台登录密码

Token返回参数

            
                {
                    "obj": "504zain%3F%21*%28%23%23%231749458853957869",
                    "errorMsg": null,
                    "errorCode": null,
                    "ok": true
                }
            
        

注意:Token有效期30分钟,如需要具体过期时间,请以当前时间加上25分钟。

一、出库模块相关接口


1-1、保存一件代发出库单

  • URL:wmom/syncOmNoticeOrderYJ.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    binStoreCode String 仓库编码 必填,请去查询可使用的仓库信息里查看
    channelCode String 渠道编码 必填,请去仓库编码查询渠道列表里查看
    delvCountry String 国家 必填
    delvState String 必填
    delvCity String 城市 必填
    delvMember String 收件人 必填
    delvMobile String 收件人电话 必填
    delvAddr String 收件人地址 必填
    delvAddr2 String 收件人地址2 选填
    delvZipcode String 邮编 必填
    csRefNo String 客户参考号 选填
    trackingNo String 跟踪号 选填
    fuJianBase64 String 附件base64 选填
    otherService String 其它服务描述 选填
    isGmyd Integer 是否仓库代购运单 选填 (0:否,1:是)默认是
    tailShippingMode Integer 尾程模式 选填 (0:仓配一体,1:仓配分离),注:TEMU订单为必填
    carrierName String 承运商名称 选填,注:TEMU订单为必填
    orderSource String 订单来源 选填,ERP名称,方便客户管理订单
    JsonProductInfo Array<Object> 列表 [ {...} ]
        sku String sku 必填
        outNum String 出库数量 必填
        sku_id String sku_id 选填
        piClass String PO单号 选填,注:TEMU订单为必填
        piMaster String O单号 选填,注:TEMU订单为必填

错误状态码

说明
0001 用户账号不能为空
0000 token校验失败
0002 jsonData参数格式有误
0003 客户编号不存在
0004 仓库编码不存在
0005 渠道编码为空
0006 sku不在库里
0007 sku重量或长宽高信息缺失
0008 sku库库存不足
0011 收货地址不全
0012 保存订单失败,出现网络问题,请联系相关人员
0013 保存订单失败,出现不明原因,请联系相关人员

服务器响应格式

同步失败:
              
                {
                  "obj":null,
                  "errorMsg":"如下sku在库里不存在! CESHICXXXI01、 ",
                  "errorCode":"0006",
                  "ok":false
                }
              
            
同步成功:
              
                {
                  "obj":{"msg":"操作成功","CusId":"客户编号","OrderId":"出库单号"},
                  "errorMsg":null,
                  "errorCode":null,
                  "ok":true
                }
              
            

1-2、保存FBA退货换标出库单

  • URL:wmom/syncOmNoticeOrderFBA.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

注意:渠道编码为"检修",出库类型为"检修转大货"时,地址信息参数可为空或不传。

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    binStoreCode String 仓库编码 必填,请去查询可使用的仓库信息里查看
    channelCode String 渠道编码 必填,请去仓库编码查询渠道列表里查看
    isYjdf String 出库类型 必填,请去我司系统-[新建出库订单]里查看
    delvCountry String 国家 必填
    delvState String 必填
    delvCity String 城市 必填
    delvMember String 收件人 必填
    delvMobile String 收件人电话 必填
    delvAddr String 收件人地址 必填
    delvAddr2 String 收件人地址2 选填
    delvZipcode String 邮编 必填
    csRefNo String 客户参考号 选填
    fuJianBase64 String 附件base64 选填
    otherService String 其它服务描述 选填
    trackingNo String 跟踪号 选填
    isGmyd Integer 是否仓库代购运单 选填 (0:否,1:是)默认是
    JsonProductInfo Array<Object> 列表 [ {...} ]
        sku String sku 必填
        outNum String 出库数量 必填
        newFnSku String 新FNSKU 必填 (无则填0)

错误状态码

说明
0001 用户账号不能为空
0000 token校验失败
0002 jsonData参数格式有误
0003 客户编号不存在
0004 仓库编码不存在
0005 渠道编码为空
0006 sku不在库里
0007 sku重量或长宽高信息缺失
0008 sku库库存不足
0011 收货地址不全
0012 保存订单失败,出现网络问题,请联系相关人员
0013 保存订单失败,出现不明原因,请联系相关人员

服务器响应格式

同步失败:
              
                {
                  "obj":null,
                  "errorMsg":"如下sku在库里不存在! CESHICXXXI01、 ",
                  "errorCode":"0006",
                  "ok":false
                }
              
            
同步成功:
              
                {
                  "obj":{"msg":"操作成功","CusId":"客户编号","OrderId":"出库单号"},
                  "errorMsg":null,
                  "errorCode":null,
                  "ok":true
                }
              
            

1-3、保存大货出库单

  • URL:wmom/syncOmNoticeOrderDH.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    binStoreCode String 仓库编码 必填,请去查询可使用的仓库信息里查看
    channelCode String 渠道编码 必填,请去仓库编码查询渠道列表里查看
    isYjdf String 出库类型 必填,请去我司系统-[新建出库订单]里查看
    hfnsku Integer 整箱换标 默认0 0/1(0:不更换FNSKU/1:更换FNSKU,默认请传0)
    delvCountry String 国家 必填
    delvState String 必填
    delvCity String 城市 必填
    delvMember String 收件人 必填
    delvMobile String 收件人电话 必填
    delvAddr String 收件人地址 必填
    delvAddr2 String 收件人地址2 选填
    delvZipcode String 邮编 必填
    csRefNo String 客户参考号 选填
    fuJianBase64 String FBA箱唛 / UPS面单 + 选填
    otherService String 其它服务描述 选填
    JsonProductInfo Array<Object> 列表 [ {...} ]
        sku String 箱号 必填
        outNum String 出库箱数 必填
        omBeizhu String 子箱号 选填
        trackingNo String 跟踪号 必填
        boxMai String FBA箱唛 必填

错误状态码

说明
0001 用户账号不能为空
0000 token校验失败
0002 jsonData参数格式有误
0003 客户编号不存在
0004 仓库编码不存在
0005 渠道编码为空
0006 出库类型为空
0007 sku库库存不足
0011 收货地址不全
0012 保存订单失败,出现网络问题,请联系相关人员
0013 保存订单失败,出现不明原因,请联系相关人员

服务器响应格式

同步失败:
              
                {
                  "obj":null,
                  "errorMsg":"如下sku在库里不存在! CESHICXXXI01、 ,
                  "errorCode":"0006",
                  "ok":false
                }
              
            
同步成功:
              
                {
                  "obj":{"msg":"操作成功","CusId":"客户编号","OrderId":"出库单号"},
                  "errorMsg":null,
                  "errorCode":null,
                  "ok":true
                }
              
            

1-4、取消出库单

  • URL:wmom/interceptOmNoticeOrder.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明
username String 我司平台登录账号
omNoticeId String 订单号

错误状态码

说明
0001 用户账号不能为空
0000 token校验失败
1001 出库单号不能为空
1002 出库单号不存在
1003 订单已发货不可取消
1004 订单正在拣货,请联系管理员处理
1005 订单已有运单号和费用,请联系管理员退回

服务器响应格式

同步失败:
              
                {
                  "obj":null,
                  "errorMsg":"找不到出库单号所对应的订单,请先确认出库单号是否有误,或联系管理员处理!",
                  "errorCode":"1002",
                  "ok":false
                }
              
            
同步成功:
              
                {
                  "obj":null,
                  "errorMsg":null,
                  "errorCode":null,
                  "ok":true
                }
              
            

1-5、出库单退回申请

  • URL:wmom/orderBackApply.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明
username String 我司平台登录账号
omNoticeId String 订单号
backNote String 退回说明

错误状态码

说明
0001 用户账号不能为空
0000 token校验失败
1001 出库单号不能为空/退回说明不能为空
1002 出库单号不存在

服务器响应格式

同步失败:
              
                {
                  "obj":null,
                  "errorMsg":"找不到出库单号所对应的订单,请先确认出库单号是否有误,或联系管理员处理!",
                  "errorCode":"1002",
                  "ok":false
                }
              
            
同步成功:
              
                {
                  "obj":null,
                  "errorMsg":null,
                  "errorCode":null,
                  "ok":true
                }
              
            

二、入库模块相关接口


2-1、同步FBA预报单

  • URL:wmim/syncInOrderFBA.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    binStoreCode String 仓库编码 必填,请去查询可使用的仓库信息里查看
    JsonProductInfo Array<Object> 列表 [ {...} ]
        sku String sku 必填
        trackingNo String 运单号 必填
        inNum Integer 入库数量 必填

错误状态码

说明
0001 用户账号不能为空
0000 token校验失败
0002 jsonData参数格式有误
0003 客户编号不存在
0004 仓库编码不存在
0005 入库明细不可为空
0010 其它错误

服务器响应格式

同步失败:
              
                {
                  "obj":null,
                  "errorMsg":"保存订单失败!注意:同步数据为空,或为重复同步数据。【同步的数据中SKU和运单号不可为空,运单号不可是为000000后缀",
                  "errorCode":"0010",
                  "ok":false
                }
              
            
同步成功:
              
                {
                  "obj":{"CusId":"客户编号","OrderId":"入库单号"},
                  "errorMsg":null,
                  "errorCode":null,
                  "ok":true
                }
              
            

2-2、删除FBA预报单

  • URL:wmim/delInOrderFBA.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明
username String 我司平台登录账号
imNoticeId String 预报单号

错误状态码

说明
0001 用户账号不能为空
0000 token校验失败
1001 预报单号不能为空
1002 预报单号不存在
0010 其它错误

服务器响应格式

同步失败:
              
                {
                  "obj":null,
                  "errorMsg":"找不到FBA预报单号所对应的预报单,请先确认预报单号是否有误,或联系管理员处理!",
                  "errorCode":"1002",
                  "ok":false
                }
              
            
同步成功:
              
                {
                  "obj":null,
                  "errorMsg":null,
                  "errorCode":null,
                  "ok":true
                }
              
            

2-3、同步一件代发头程预报批次

  • URL:wmim/syncInOrderYJDF.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    binStoreCode String 仓库编码 必填,请去查询可使用的仓库信息里查看
    batchRefNo String 批次参考号 必填
    batchOrderType String 订单类型 必填(散箱入库/整柜入库)
    omPresetTime String 预计入仓时间 选填 散箱入库,PS:整柜入库必填 格式:(2025-04-08)
    batchBoxFvol String 总体积(m³ 立方米) 选填
    cabinetNo String 柜号 选填
    beizhu String 批次备注 选填
    JsonBoxInfo Array<Object> 列表 [ {...} ]
        referenceId String 箱参考号 必填
        binL Float 必填,保留两位小数
        binW Float 必填,保留两位小数
        binH Float 必填,保留两位小数
        boxKgM Float 单箱毛重(kg) 必填
        boxCount Integer 总箱数 必填
        isCheck String 是否清点 Y/N 默认N
        JsonProductInfo Array<Object> 列表 [ {...} ]
            goodsCode String 商品编码
            goodsCount Integer 每箱数量
            binHs String 海关编号

错误状态码

说明
0001 用户账号不能为空
0000 token校验失败
0002 jsonData参数格式有误
0003 客户编号不存在
0004 仓库编码不存在
0005 批次参考号已存在
0010 其它错误

服务器响应格式

同步失败:
              
                {
                  "obj":null,
                  "errorMsg":"仓库编码:null不存在!",
                  "errorCode":"0004",
                  "ok":false
                }
              
            
同步成功:
              
                {
                  "obj":{"CusId":"ZZ01","批次号":"PCMGZZ01250114F-003"},
                  "errorMsg":null,
                  "errorCode":null,
                  "ok":true
                }
              
            

三、基础数据相关接口


3-1、新增/修改商品信息

  • URL:wmim/syncSkuInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    JsonProductInfo Array<Object> 列表 [ {...} ]
        FNSKU String FNSKU 必填
        cnName String 中文名称 必填
        enName String enName 必填
        weight Float 重量(kg) 必填
        binL Float 长(cm) 必填,保留两位小数
        binW Float 宽(cm) 必填,保留两位小数
        binH Float 高(cm) 必填,保留两位小数
        priceVal Float 价值(RMB) 必填
        lpnSku String LPN对应原标SKU 选填,可为空
        wareSku String 仓库SKU 选填,可为空
        guiGe String 规格型号 选填,可为空

错误状态码

说明
0001 用户账号不能为空
0000 token校验失败
0002 jsonData参数格式有误
0003 客户编号不存在
0004 仓库编码不存在
0005 商品明细不可为空
0010 其它错误

服务器响应格式

同步失败:
            
              {
                "obj":["FNSkU004@@@sku字母必须为大写"],
                "errorMsg":"存在错误信息,请查看返回的数据明细!",
                "errorCode":"00010",
                "ok":false
              }
            
          
同步成功:
            
              {
                "obj":null,
                "errorMsg":null,
                "errorCode":null,
                "ok":true
              }
            
          

3-2、删除商品信息

  • URL:wmim/delSkuInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    JsonProductInfo Array<String> 数组 ['FNSKU01','FNSKU02']

错误状态码

说明
0001 用户账号不能为空
0000 token校验失败
0002 jsonData参数格式有误
0003 客户编号不存在
0005 商品明细不可为空
0010 其它错误

服务器响应格式

同步失败:
            
              {
                "obj":["yiwhdcsk@@@还有库存","FNSKU001@@@不存在库里"],
                "errorMsg":"存在错误信息,请查看返回的数据明细!",
                "errorCode":"00010",
                "ok":false
              }
            
          
同步成功:
            
              {
                "obj":null,
                "errorMsg":null,
                "errorCode":null,
                "ok":true
              }
            
          

四、获取数据(返回列為中文,返回格式固定,可直接調用接口查看数据)


4-1、查看出库明细数据

  • URL:wmom/getOutOrderDetailInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    binStoreCode String 仓库编码 必填,请去查询可使用的仓库信息里查看
    orderTypeCode String 模块编码 必填,01 02 03 (01:一件代发;02:FBA退换货;03:大货)
    orderNo String 订单号 可为空,查询用
    queryDateBegin String 开始时间 可为空,查询用 格式:2024-08-22 07:57:10
    queryDateEnd String 开始时间 可为空,查询用 格式:2024-08-28 07:57:10
  • 订单状态:未确认-待发货-待拣货-待出库-已发货
  • 默认只返回近一个月的数据
一件代发返回示例:
            
            {
              "obj": [{
                "出库单号": "YCMGZZ01240810O-0003",
                "sku": "ZAIN002",
                "商品名称": "ZAIN002",
                "出库数量": "1",
                "订单状态": "已发货",
                "运单号": "",
                "运费(外币)": null,
                "出库类型": "一件代发",
                "长": "2",
                "宽": "2",
                "高": "2",
                "SKU重量 (KG)": "0.015",
                "新FnSku": null
              }],
              "errorMsg": null,
              "errorCode": null,
              "ok": true
            }
            
          
FBA返回示例:
            
              {
                "obj": [{
                  "出库单号": "FCMGZZ01240810O-0005",
                  "sku": "asdasdasd",
                  "商品名称": "222",
                  "出库数量": "1",
                  "订单状态": "待拣货",
                  "运单号": "",
                  "运费(外币)": null,
                  "出库类型": "检修转大货",
                  "长": "56",
                  "宽": "20",
                  "高": "30",
                  "SKU重量 (KG)": "15",
                  "新FnSku": "0"
                }],
                "errorMsg": null,
                "errorCode": null,
                "ok": true
              }
            
          
大货返回示例:
            
              {
                "obj": [{
                  "出库单号": "DCMGZZ01240810O-0003",
                  "sku": "ZZZZ0120230911-003",
                  "商品名称": null,
                  "出库数量": "1",
                  "订单状态": "已发货",
                  "运单号": "2222.0",
                  "运费(外币)": null,
                  "出库类型": "按箱发FBA",
                  "子箱号": "ZZZZ0120230911-003",
                  "长": "10",
                  "宽": "10",
                  "高": "10",
                  "单箱重量(kg)": "5",
                  "箱规": "10*10*10",
                  "箱唛": "22225.0",
                  "skuInfoList": [{
                    "入库单号": "DRMGZZ01230911D-0003",
                    "箱号": "ZZZZ0120230911-003",
                    "sku": "CESHICESHI02",
                    "条码": "CESHICESHI02",
                    "中文名称": "测试02",
                    "英文名称": "ceshi02",
                    "每箱数量": "50"
                  }]
                }],
                "errorMsg": null,
                "errorCode": null,
                "ok": true
              }
            
          

4-2、查询库存明细

4-2-1、查询库存明细-全部

  • URL:wmom/getStoreInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    binStoreCode String 仓库编码 必填,请去查询可使用的仓库信息里查看
    orderTypeCode String 模块编码 必填,01 02 03 (01:一件代发;02:FBA退换货;03:大货)
    sku String sku 选填,可为空,查询用
一件代发,FBA返回数据示例:
            
              {
                "obj": [{
                  "sku": "CESHICESHI01",
                  "仓库SKU": "",
                  "商品名称": "测试01",
                  "待下架": null,
                  "已下架": null,
                  "已上架": 435,
                  "上年结余": 220,
                  "参考号": null,
                  "剩余库存": 655.0000
                },],
                "errorMsg": null,
                "errorCode": null,
                "ok": true
              }
            
          
大货返回示例:
            
              {
                "obj": [{
                  "sku": "ZZSNG02291720240426-012",
                  "仓库SKU": null,
                  "商品名称": null,
                  "待下架": null,
                  "已下架": -6,
                  "已上架": 6,
                  "上年结余": null,
                  "参考号": "",
                  "剩余库存": 0.0000,
                  "skuInfoList": [{
                    "入库单号": "DRMGSNG022917240426S-0007",
                    "箱号": "ZZSNG02291720240426-012",
                    "sku": "W3AYCEL-B",
                    "条码": "W3AYCEL-B",
                    "中文名称": "xcel黑色按压-1000",
                    "英文名称": "Filter fitting",
                    "每箱数量": "6"
                  }]
                }],
                "errorMsg": null,
                "errorCode": null,
                "ok": true
              }
            
          

4-2-2、查询库存明细-分页

  • URL:wmom/getStoreInfoPage.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    binStoreCode String 仓库编码 必填,请去查询可使用的仓库信息里查看
    orderTypeCode String 模块编码 必填,01 02 03 (01:一件代发;02:FBA退换货;03:大货)
    sku String sku 选填,可为空,查询用
    curPage String 1 必填
    pageSize String 10 必填

4-3、查看扫描入库明细数据

  • URL:wmim/getSmOrderDetailInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    binStoreCode String 仓库编码 必填,请去查询可使用的仓库信息里查看
    orderTypeCode String 模块编码 必填,01 02 03 (01:一件代发;02:FBA退换货;03:大货)
    orderNo String 订单号 可为空,查询用
    batchNo String 批次号 可为空,查询用
    queryDateBegin String 开始时间 可为空,查询用 格式:2024-08-22 07:57:10
    queryDateEnd String 开始时间 可为空,查询用 格式:2024-08-28 07:57:10

默认只返回近一个月的数据

一件代发返回数据示例:
            
              {
                "obj": [{
                  "扫描日期": "2024-08-21",
                  "入库单号": "YRMGZZ01240821P-0001",
                  "订单状态": "已完成",
                  "箱号": "YJZZ0120240821-001",
                  "发货箱数": "1",
                  "扫描的子箱号": "YJZZ0120240821-001",
                  "sku": "ZAIN001",
                  "每箱数量": "100",
                  "入库数量": "100"
                }, {
                  "扫描日期": "2024-08-10",
                  "入库单号": "YRMGZZ01240810E-0001",
                  "订单状态": "操作中",
                  "箱号": "YJZZ0120240810-199",
                  "发货箱数": "1",
                  "扫描的子箱号": "YJZZ0120240810-199-1",
                  "sku": "ceshiX00381HNPJX",
                  "每箱数量": "2",
                  "入库数量": "2"
                }],
                "errorMsg": null,
                "errorCode": null,
                "ok": true
              }
            
          
FBA返回示例:
            
              {
                "obj": [{
                  "扫描日期": "2023-12-07",
                  "入库单号": "",
                  "sku": "CS001",
                  "sku条码": "CS001",
                  "sku名称": "CS001",
                  "运单号": "TEST0004",
                  "参考号": "CS001",
                  "入库数量": "1"
                }],
                "errorMsg": null,
                "errorCode": null,
                "ok": true
              }
            
          
DH返回示例:
            
              {
                "obj": [{
                  "扫描日期": "2024-08-10",
                  "入库单号": "DRMGZZ01240810I-0003",
                  "箱号": "ZZZZ0120240810-031",
                  "子箱号": "ZZZZ0120240810-031",
                  "参考号": "",
                  "总箱数": "1",
                  "入库数量": "1",
                  "skuInfoList": [{
                    "入库单号": "DRMGZZ01240810I-0003",
                    "箱号": "ZZZZ0120240810-031",
                    "sku": "sadasdasd",
                    "条码": "sadasdasd",
                    "中文名称": null,
                    "英文名称": null,
                    "数量": "20"
                  }]
                }],
                "errorMsg": null,
                "errorCode": null,
                "ok": true
              }
            
          

4-4、根据出库单号获取订单相关跟踪号、运费

  • 单个查询接口URL:wmom/getOutOrderTracking.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    orderNo String 出库单号

错误编码:

说明
0000 token校验失败
0001 用户账号不能为空
0004 jsonData参数格式有误,请检测json字符串格式是否正确!
0005 客户编号不存在 | 出库单号不可为空 | 出库单号不存在库里。

示例:

请求数据:
            
              {
                username:SNOTEST,
                jsonData:{"cusId":"W8888","orderNo":”出库单号”}
              }
            
          
返回数据:
            
              {
                "obj": {
                  "Base64": "XXX",//面单base64
                  "Total": "6.96",//运费
                  "Currency": "US$美元",//币别
                  "OrderNo": "XXX",//出库单号
                  "TrunNo": "XXX",//运单号
                  "OmSta": "XXX"//订单状态
                },
                "errorMsg": "获取运单号成功。",
                "errorCode": null,
                "ok": true
              }
            
          
  • 批量查询接口URL:wmom/batchGetOutOrderTracking.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
    cusId String 客户编号 必填
    orderNos String 出库单号1,出库单号2,出库单号3

4-5、根据客户编号查询商品信息

4-5-1、商品信息-全部

  • URL:wmim/getProductInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
返回示例:
            
            {
                "obj": [
                {
                "商品名称": "1",
                "商品编码": "sdasddas3123",
                "商品条码": "sdasddas3123",
                "英文名称": "2",
                "商品规格": "",
                "长(cm)": "1",
                "宽(cm)": "1",
                "高(cm)": "1",
                "重量(kg)": "",
                "价值(RMB)": "1"
                },
                {
                "商品名称": null,
                "商品编码": "ceshiX00381HNPJX",
                "商品条码": "ceshiX00381HNPJX",
                "英文名称": null,
                "商品规格": null,
                "长(cm)": null,
                "宽(cm)": null,
                "高(cm)": null,
                "重量(kg)": null,
                "价值(RMB)": null
                }
                ],
                "errorMsg": null,
                "errorCode": null,
                "ok": true
            }
            
          

4-5-2、商品信息-分页

  • URL:wmim/getProductInfoPage.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    curPage String 1 选填
    pageSize String 10 选填
返回示例:
            
            {
                "obj": {
                    "totalSize": 22,
                    "resultList": [
                        {
                            "商品名称": "1",
                            "商品编码": "sdasddas3123",
                            "商品条码": "sdasddas3123",
                            "英文名称": "2",
                            "商品规格": "",
                            "长(cm)": "1",
                            "宽(cm)": "1",
                            "高(cm)": "1",
                            "重量(kg)": "",
                            "价值(RMB)": "1"
                        },
                        {
                            "商品名称": null,
                            "商品编码": "ceshiX00381HNPJX",
                            "商品条码": "ceshiX00381HNPJX",
                            "英文名称": null,
                            "商品规格": null,
                            "长(cm)": null,
                            "宽(cm)": null,
                            "高(cm)": null,
                            "重量(kg)": null,
                            "价值(RMB)": null
                        }
                    ]
                },
                "errorMsg": null,
                "errorCode": null,
                "ok": true
            }
            
          

4-6、根据仓库编码查询渠道列表

  • URL:wmim/getChannelInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    binStoreCode String 仓库编码 必填,请去查询可使用的仓库信息里查看

示例:

请求数据:
              
                username:SNOTEST,
                jsonData:{"binStoreCode":"MG"}
              
            

返回数据参数

参数 类型 说明 备注
ok Boolean 请求是否成功
errorCode String 错误编码
errorMsg String 错误信息
obj Array<Object> 返回数据
    portCode String 渠道编码 对接方忽略
    portZhName String 渠道名称 我方使用code,对应接口参数中的channelCode
返回数据:
              
                {
                  "obj": [
                      {
                        "portCode": "mg001",
                        "portZhName": "UPS Ground"
                      }, {
                        "portCode": "mg003",
                        "portZhName": "亚马逊自提"
                      }, {
                        "portCode": "mg008",
                        "portZhName": "检修"
                      }, {
                        "portCode": "mg011",
                        "portZhName": "Fedex Ground"
                      }, {
                        "portCode": "mg0111",
                        "portZhName": "Fedex自提"
                      }, {
                        "portCode": "mg014",
                        "portZhName": "USPS--GA02"
                      }
                  ],
                  "errorMsg": null,
                  "errorCode": null,
                  "ok": true
                }
              
            

4-7、根据FBA出库单号查询大货相关的出库单箱唛

  • URL:wmom/getBoxMaiByFbaOrder.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    orderNo String FBA出库单号

4-8、根据仓库SKU查找FNSKU

  • URL:wmom/getFNSKUByInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    storeSkus Array<String> ['SKU01','SKU02']

示例:

请求数据:
              
                username:SNOTEST,
                jsonData:{
                  "cusId":"W8888",
                  "storeSkus":['SKU01','SKU02']
                }
              
            
返回数据:
              
                {
                  "obj":{"SKU01":"不存在","SKU02":"XXXXXXX"},
                  "errorMsg":null,
                  "errorCode":null,
                  "ok":true
                }
              
            

4-9、查询可使用的仓库信息

  • URL:wmim/getUseStoreInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号

示例:

请求数据:
              
                username:SNOTEST
              
            
返回数据:
              
                {
                  "obj":[{"仓库编码":"CA","仓库名称":"加拿大"},
                  {"仓库编码":"JP","仓库名称":"日本"},
                  {"仓库编码":"DG","仓库名称":"德国"},
                  {"仓库编码":"ITTWO","仓库名称":"意大利二仓"},
                  {"仓库编码":"LATWO","仓库名称":"美国西部二仓"},
                  {"仓库编码":"USTX","仓库名称":"美中休斯顿"},
                  {"仓库编码":"YGTWO","仓库名称":"英国二仓"},
                  {"仓库编码":"MG","仓库名称":"美国东部NJ"},
                  {"仓库编码":"YG","仓库名称":"英国"}],
                  "errorMsg":null,
                  "errorCode":null,
                  "ok":true
                }
              
            

4-10、根据批次号查询预报批次状态

  • URL:wmim/getBatahStatusInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    batchNos String 1111,2222,3333 可传单个,多个用逗号隔开

示例:

请求数据:
              
                username:SNOTEST
              
            
返回数据:
              
                {
                  "obj":{"PCMGZZ01250410W-001":"已完成入库","2222":"无批次信息","3333":"无批次信息"},
                        "errorMsg":null,
                        "errorCode":null,
                        "ok":true
                }
              
            

备注:批次状态: 未确认->已确认提交->操作中->已完成入库

五、Y2模块相关接口


5-1、Y2商品信息-分页

  • URL:api/wmy2/getY2ProductInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    curPage String 1 选填
    pageSize String 10 选填
返回示例:
            
            {
            "obj": {
                "totalSize": 1,
                "resultList": [
                    {
                        "商品名称": "套装",
                        "商品编码": "GZCNFS-PINK-M",
                        "商品条码": "GZCNFS-PINK-M",
                        "英文名称": "SUIT",
                        "商品规格": "",
                        "长(cm)": "32.0",
                        "宽(cm)": "20.0",
                        "高(cm)": "1.0",
                        "重量(kg)": "0.44",
                        "价值(RMB)": "50.0"
                    }
                ]
            },
            "errorMsg": null,
            "errorCode": null,
            "ok": true
            }
            
          

5-2、新增/修改Y2商品信息

  • URL:api/wmy2/syncY2SkuInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    JsonProductInfo Array<Object> 列表 [ {...} ]
        FNSKU String FNSKU 必填
        cnName String 中文名称 必填
        enName String enName 必填
        weight Float 重量(kg) 必填
        binL Float 长(cm) 必填,保留两位小数
        binW Float 宽(cm) 必填,保留两位小数
        binH Float 高(cm) 必填,保留两位小数
        priceVal Float 价值(RMB) 必填
        picAddr String 图片地址(可直接访问的) 必填
        lpnSku String LPN对应原标SKU 选填,可为空
        wareSku String 仓库SKU 选填,可为空
        guiGe String 规格型号 选填,可为空

状态定义:

说明
0000 token校验失败
0001 用户账号不能为空
0002 jsonData参数格式有误
0003 客户编号不存在
0005 商品明细不可为空
0010 其它错误

服务器响应格式

同步失败:
            
              {
                "obj": [
                "FNSkU004@@@sku字母必须为大写"
                ],
                "errorMsg": "存在错误信息,请查看返回的数据明细!",
                "errorCode": "00010",
                "ok": false
            }
            
          
同步成功:
            
              {
                "obj": null,
                "errorMsg": null,
                "errorCode": null,
                "ok": true
             }
            
          

5-3、删除Y2商品信息

  • URL:api/wmy2/delY2SkuInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    JsonProductInfo Array<String> 数组 ['FNSKU01','FNSKU02']

状态定义:

说明
0000 token校验失败
0001 用户账号不能为空
0002 jsonData参数格式有误
0003 客户编号不存在
0005 商品明细不可为空
0010 其它错误

服务器响应格式

同步失败:
            
              {
                "obj": [
                "yiwhdcsk@@@还有库存",
                "FNSKU001@@@不存在库里"
                ],
                "errorMsg": "存在错误信息,请查看返回的数据明细!",
                "errorCode": "00010",
                "ok": false
              }
            
          
同步成功:
            
              {
                "obj": null,
                "errorMsg": null,
                "errorCode": null,
                "ok": true
             }
            
          

5-4、保存Y2出库单

  • URL:api/wmy2/syncY2NoticeOrderYJ.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    delvCountry String 国家 必填,可传 ****** 以下涉及地址都是如此
    delvState String 必填
    delvCity String 城市 必填
    delvMember String 收件人 必填
    delvMobile String 收件人电话 必填
    delvAddr String 收件人地址 必填
    delvAddr2 String 收件人地址2 选填
    delvZipcode String 邮编 必填
    csRefNo String 客户参考号 选填
    trackingNo String 跟踪号 选填
    fuJianBase64 String 附件base64 选填
    otherService String 其它服务描述 选填
    delvType String 头程渠道 必填 (1:散件发前置仓,2:整箱发前置仓,3:整箱发海外仓)
    JsonProductInfo Array<Object> 列表 [ {...} ]
        sku String sku 必填
        outNum String 出库数量 必填

状态定义:

说明
0000 token校验失败
0001 用户账号不能为空
0002 jsonData参数格式有误
0003 客户编号不存在
0006 sku不在库里
0007 sku重量或长宽高信息缺失
0011 收货地址不全
0012 保存订单失败,出现网络问题,请联系相关人员
0013 保存订单失败,出现不明原因,请联系相关人员

服务器响应格式

同步失败:
            
              {
                "obj": null,
                "errorMsg": "如下sku在库里不存在! CESHICXXXI01、 ",
                "errorCode": "0006",
                "ok": false
            }
            
          
同步成功:
            
              {
                "obj": {
                    "msg": "操作成功",
                    "CusId": "客户编号",
                    "OrderId": "出库单号"
                },
                "errorMsg": null,
                "errorCode": null,
                "ok": true
              }
            
          

5-5、查看Y2出库单明细记录

  • URL:api/wmy2/getY2OutOrderDetailInfo.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
jsonData String<Json> JSON字符串
    cusId String 客户编号 必填
    orderNo String 订单号 可为空,查询用
    queryDateBegin String 开始时间 可为空,查询用 格式:2025-05-01 07:57:10
    queryDateEnd String 结束时间 可为空,查询用 格式:2024-05-31 07:57:10
  • 订单状态:未确认--待配货--前置仓待收货-前置仓已收货-海外仓待收货-海外仓已收货-订单完成-已废弃
  • 默认只返回近一个月的数据
返回示例:
            
            {
                "obj": [
                    {
                        "出库单号": "Y2CY2SNG04151625062699-0014",
                        "参考号": "PO-211-04783295637111840",
                        "头程渠道": null,
                        "尾程渠道": "TEMU自提",
                        "商品SKU": "BSQ6449HEIM",
                        "商品条码": "BSQ6449HEIM",
                        "商品名称": "BSQ6449黑色M",
                        "英文名称": "BSQ6449HEIM",
                        "出库数量": "1",
                        "订单状态": "待配货",
                        "重量(KG)": "0.2"
                    }
                ],
                "errorMsg": null,
                "errorCode": null,
                "ok": true
            }
            
          

5-6、取消出库单

  • URL:api/wmy2/interceptY2OmNoticeOrder.do
  • Method:POST

Headers参数

参数 类型 说明
Content-Type String application/x-www-form-urlencoded
Token String token接口获取

Body参数

参数 类型 说明 备注
username String 我司平台登录账号
omNoticeId String 订单号

状态定义:

说明
0000 token校验失败
0001 用户账号不能为空
1001 出库单号不能为空
1002 出库单号不存在
1003 订单完成或废弃不可取消

服务器响应格式

同步失败:
            
              {
                    "obj": null,
                    "errorMsg": "找不到出库单号所对应的订单,请先确认出库单号是否有误,或联系管理员处理!",
                    "errorCode": "1002",
                    "ok": false
                }
            
          
同步成功:
            
              {
                "obj": null,
                "errorMsg": null,
                "errorCode": null,
                "ok": true
             }
            
          

更新记录

时间 内容
2025-03-13 保存一件代发出库单,添加数据来源参数
2025-04-02 查看扫描入库明细数据,一件代发返回数据新增更改订单状态
2025-04-09 同步一件代发头程预报批次,新增:订单类型、预计入仓时间、总体积(CM3)等参数
2025-04-10 查看扫描入库明细数据,新增:批次号参数
2025-04-11 新增:(4-10)根据批次号查询预报批次状态模块内容
2025-07-17 新增修改:(4-5)根据客户编号查询商品信息模块,将其细分为2个模块,去除3-1模块中的仓库编码参数
2025-07-30 新增:(4-2-2)添加查询库存明细模块的分页接口
2025-08-18 新增:Y2模块相关接口