logo资料库

奇门白皮书2019最新版.pdf（对接原理+奇门平台使用）

发布时间：2022-05-30 发布人：admin 分类：说明书 资料大小：1.38M 资料格式：pdf 举报 版权申诉
第1页 / 共133页
第2页 / 共133页
第3页 / 共133页
第4页 / 共133页
第5页 / 共133页
第6页 / 共133页
第7页 / 共133页
第8页 / 共133页
资料共133页，剩余部分请下载后查看
    1 版本记录
    2 目录
    3 前言
    3.1 业务背景
    3.2 名词解释
    4 奇门对接方案
    4.1 奇门对接方式
    4.2 奇门标准化对接构架
    4.3 系统调用流程
    4.4 联调、测试方式
    4.4.1 ERP端
    4.4.2 WMS端
    5 接口规范
    5.1 ERP与奇门的通信协议
    5.1.1 协议描述
    5.1.2 访问授权
    5.1.3 请求参数说明
    5.1.4 响应参数
    5.2 奇门与WMS的通信协议
    5.2.1 协议描述
    5.2.2 请求参数
    5.2.3 响应参数
    6 接口说明
    6.1 商品查询接口
    6.1.1 接口介绍
    6.1.2 入参规范
    6.1.3 出参规范
    6.2 商品同步接口
    6.2.1 接口介绍
    6.2.2 入参规范
    6.2.3 出参规范
    6.3 商品同步接口 (批量)
    6.3.1 接口介绍
    6.3.2 入参规范
    6.3.3 出参规范
    6.4 组合商品接口
    6.4.1 接口介绍
    6.4.2 入参规范
    6.4.3 出参规范
    6.5 创建前后端商品映射接口
    6.5.1 接口介绍
    6.5.2 入参规范
    6.5.3 出参规范
    6.6 前后端商品映射查询接口
    6.6.1 接口介绍
    6.6.2 入参规范
    6.6.3 出参规范
    6.7 入库单创建接口
    6.7.1 接口介绍
    6.7.2 入参规范
    6.7.3 出参规范
    6.8 入库单确认接口
    6.8.1 接口介绍
    6.8.2 入参规范
    6.8.3 出参规范
    6.9 入库单查询接口
    6.9.1 接口介绍
    6.9.2 入参规范
    6.9.3 出参规范
    6.10 退货入库单创建接口
    6.10.1 接口介绍
    6.10.2 入参规范
    6.10.3 出参规范
    6.11 退货入库单确认接口
    6.11.1 接口介绍
    6.11.2 入参规范
    6.11.3 出参规范
    6.12 退货入库单查询接口
    6.12.1 接口介绍
    6.12.2 入参规范
    6.12.3 出参规范
    6.13 出库单创建接口
    6.13.1 接口介绍
    6.13.2 入参规范
    6.13.3 出参规范
    6.14 出库单确认接口
    6.14.1 接口介绍
    6.14.2 入参规范
    6.14.3 出参规范
    6.15 出库单查询接口
    6.15.1 接口介绍
    6.15.2 入参规范
    6.15.3 出参规范
    6.16 发货单创建接口
    6.16.1 接口介绍
    6.16.2 入参规范
    6.16.3 出参规范
    6.17 发货单创建接口 （批量）
    6.17.1 接口介绍
    6.17.2 入参规范
    6.17.3 出参规范
    6.18 发货单创建结果通知接口 （批量）
    6.18.1 接口介绍
    6.18.2 入参规范
    6.18.3 出参规范
    6.19 发货单确认接口
    6.19.1 接口介绍
    6.19.2 入参规范
    6.19.3 出参规范
    6.20 发货单确认接口 (批量)
    6.20.1 接口介绍
    6.20.2 入参规范
    6.20.3 出参规范
    6.21 发货单查询接口
    6.21.1 接口介绍
    6.21.2 入参规范
    6.21.3 出参规范
    6.22 订单SN通知接口
    6.22.1 接口介绍
    6.22.2 入参规范
    6.22.3 出参规范
    6.23 发货单SN通知接口
    6.23.1 接口介绍
    6.23.2 入参规范
    6.23.3 出参规范
    6.24 订单流水查询接口
    6.24.1 接口介绍
    6.24.2 入参规范
    6.24.3 出参规范
    6.25 订单状态查询接口 （批量）
    6.25.1 接口介绍
    6.25.2 入参规范
    6.25.3 出参规范
    6.26 订单流水通知接口
    6.26.1 接口介绍
    6.26.2 入参规范
    6.26.3 出参规范
    6.27 订单异常通知接口
    6.27.1 接口介绍
    6.27.2 入参规范
    6.27.3 出参规范
    6.28 退货异常包裹单通知接口
    6.28.1 接口介绍
    6.28.2 入参规范
    6.28.3 出参规范
    6.29 退货包裹状态通知接口
    6.29.1 接口介绍
    6.29.2 入参规范
    6.29.1 出参规范
    6.30 发货单缺货通知接口
    6.30.1 接口介绍
    6.30.2 入参规范
    6.30.3 出参规范
    6.31 发货单缺货查询接口
    6.31.1 接口介绍
    6.31.2 入参规范
    6.31.3 出参规范
    6.32 单据取消接口
    6.32.1 接口介绍
    6.32.2 入参规范
    6.32.3 出参规范
    6.33 单据挂起（恢复）接口
    6.33.1 接口介绍
    6.33.2 入参规范
    6.33.3 出参规范
    6.34 库存查询接口（多商品）
    6.34.1 接口介绍
    6.34.2 入参规范
    6.34.3 出参规范
    6.35 库存查询接口（多条件）
    6.35.1 接口介绍
    6.35.2 入参规范
    6.35.3 出参规范
    6.36 仓库查询接口
    6.36.1 接口介绍
    6.36.2 入参规范
    6.36.3 出参规范
    6.37 仓库同步接口
    6.37.1 接口介绍
    6.37.2 入参规范
    6.37.3 出参规范
    6.38 库存盘点通知接口
    6.38.1 接口介绍
    6.38.2 入参规范
    6.38.3 出参规范
    6.39 库存盘点查询接口
    6.39.1 接口介绍
    6.39.2 入参规范
    6.39.3 出参规范
    6.40 仓内加工单创建接口
    6.40.1 接口介绍
    6.40.2 入参规范
    6.40.3 出参规范
    6.41 仓内加工单确认接口
    6.41.1 接口介绍
    6.41.2 入参规范
    6.41.3 出参规范
    6.42 库存异动通知接口
    6.42.1 接口介绍
    6.42.2 入参规范
    6.42.3 出参规范
    6.43 店铺同步接口
    6.43.1 接口介绍
    6.43.2 入参规范
    6.43.3 出参规范
    6.44 发货单波次通知接口
    6.44.1 接口介绍
    6.44.2 入参规范
    6.44.3 出参规范
    6.45 调拨单创建接口
    6.45.1 接口介绍
    6.45.2 入参规范
    6.45.3 出参规范
    6.46 调拨单查询接口
    6.46.1 接口介绍
    6.46.2 入参规范
    6.46.3 出参规范
    6.47 调拨单通知接口
    6.47.1 接口介绍
    6.47.2 入参规范
    6.47.3 出参规范
    6.48 渠道间库存规则设置接口
    6.48.1 接口介绍
    6.48.2 入参规范
    6.48.3 出参规范
    6.49 库存汇总报表查询接口
    6.49.1 接口介绍
    6.49.2 入参规范
    6.49.3 出参规范
    6.50 订单出库统计查询接口
    6.50.1 接口介绍
    6.50.2 入参规范
    6.50.3 出参规范
    6.51 心跳接口
    6.51.1 接口介绍
    6.51.2 入参规范
    6.51.3 出参规范
    6.52 供应商信息同步接口
    6.52.1 入参规范
    6.52.2 出参规范
    7 附录
    7.1 sign签名算法：
    7.1.1 输入参数为
    7.1.2 按首字母升序排列
    7.1.3 连接字符串
    7.1.4 生成签名 sign
    7.1.5 拼装URL请求
    奇门接入白皮书 奇门标准化协议白皮书 V3.7 阿里巴巴集团 2019 1
    奇门接入白皮书 1 版本记录 Date Version Description 2015.03.27 1.0 1、奇门标准化协议 v1.0 发布 1、增加入库单更新，出库单更新，库存异动更新等 3 个 2015.03.31 1.2 接口 2、API 名称区分了 erp 和 wms 3、优化部分字段命名 2015.04.07 1.3 1、将 auditor 相关的字段统一成 operator 1、更新接口规范，新增“奇门与 wms 的通信协议”等 2015.04.09 1.4 相关内容 2、新增入库单，去掉一个重复的入库单编码 1、加入奇门项目服务商解决方案章节 2、增加通信协议里的反向协议标准 2015.04.14 1.5 3 、 更 新 个 别 字 段 名 ， 如 Quantity 更 新 为 Qty ， stockSelectedQty 等 字 段名 中 将 stock 去 掉， 变为 selectedQty。 1、加入菜鸟仓业务接口支持 2015.5.6 2.0 2、接口整体改动较大，主要增加业务接口和原有接口内 增加字段 1、出入库单据增加 ERP 行号的概念 2、出库单流水接口升级为订单流水接口 3、仓内加工单更名为 storeprocess 4、发货单确认接口的生产日期 produceDate 变更为 productDate 5 、 退 货 入 库 单 创 建 接 口 orderLine 节 点 中 增 加 ownerCode 字段；入库单创建接口中 ownerCode 移到 orderLine 节点中 1、取消订单，订单类型变为非必填 2、发货单创建，付款时间变为非必填 3、所有地址中的区域改为非必填 2015.5.7 2.1 2015.5.20 2.1 2015.6.5 2015.6.10 2.2 2.2 4、退货入库单确认接口，物流公司编码改为非必填 1、增加“出库单创建”，“出库单确认”接口 1、“出库单创建”增加货主编码字段 2
    奇门接入白皮书 2、增加“订单状态查询”和“库存查询”两个接口 3、规范“冻结库存”的使用范围 1、增加“组合商品接口” 2、入库单的收件人，发件人，物流公司信息为非必填 3、新增入库单类型：生产入库、领用入库、残次品入 库。 2015.6.11 2.2 4、入库单新增字段，采购单号 5、盘点单新增字段，盘点时间 6、新增“库存异动接口” 7、“订单状态查询”不仅查当前状态，历史状态也可以 8、“普通出库单”增加发件人信息 1、“组合商品创建接口”和“订单流水查询接口“，去 掉 warehouseCode 编码 2015.6.12 2.2 2 、 “ 订 单 流 水 查 询 接 口 ” 和 “ 库 存 查 询 接 口 ” response 增加的 flag，code，message 这三个标准的 应答。 2015.6.25 2.2 1、增加发货单查询接口 2015.7.2 2.2 部分收货完成, FULFILLED-收货完成。） 1、订单状态查询增加两个入库状态（PARTFULFILLED- 2、库存查询接口增加货主编码 ownerCode 1、退货入库创建接口：商品增加批次等信息 2、发货单创建接口，发票增加普通发票的类型 3、订单流水查询接口，删除 NEW 状态 2015.7.3 2.2 4、订单流水通知接口，删除 NEW，CANCELEDFAIL 状 态 5、发货单创建和发货单缺货通知接口，在 item 节点下 增加 inventoryType 等字段 1、商品同步接口的 barcode 可以填多个 2、发货单创建增加字段“deliveryType” 3、发货单创建返回值支持统仓统配的拆单 2015.7.6 2.2 4、发票内容格式化 5、增加 B2B 出库的出库类型 6、入库单确认接口的 entryOrderId 改为条件必填 7、extendProps 和 remark 统一定义了 3
    奇门接入白皮书 8、退货单创建和确认接口增加批次信息 9、订单流水查询删除 CANCELFAILED 状态 10、订单流水通知接口删除 NEW,CANCELFAILED 状态 11 、 发 货 单 缺 货 通 知 接 口 item 节 点 下 增 加 inventoryType 和批次信息 1、B2B 入库和 B2B 出库单据状态多接口修订 2015.7.9 2.2 2、发货单 SN 通知借口，加上分页，并且将 sns 的节点 2015.7.14 2.2 2015.7.16 2.2 去掉 1、增加库存异动接口，单据类型增加 ZZTZ=状态调整 单 1、发货单 invoices 下面的 detail 增加 item 节点 2、发货单发货类型的枚举值 CWPS（常温配送）改为 PTPS（普通配送） 3、商品同步 barcode 的分隔符改为； 4、部分warehouseCode重新定义约束和说明 5、库存异动接口更名为库存异动通知接口 2015.7.17 2.2 warehouseCode 和 logisticsCode 两个字段，以适配以 1 、 发 货 单 创 建 的 出 参 ， response 节 点 下 增 加 前的版本 1、库存异动接口，结构体变化，将 warehouseCode， 2015.7.20 2.2 ownerCode ，orderCode ，orderType，outbizCode 等放到 item 节点下 2015.7.21 2.2 1、快递编码中增加京东配送（JD），当当宅配（DD） 2015.7.22 2.2 1、出库单创建和出库单确认接口增加 logisticsCode 字 段 2015.7.23 2.2 等四个接口增加 totalOrderLines，outBizCode 这两个 1、入库单创建、入库单确认、出库单创建、出库单确认 2015.7.30 2.2 1、发货单确认接口增加“包裹理论重量” 字段用于分批传输处理 2015.8.14 2.2 1、新增接口订单状态查询接口（批量），用于解决通过 订单最后操作时间的区间值等信息，去批量查询订单 2、发货单创建接口的 orderLine 下面增加 batchCode 等字段，用于解决指定批次发货的问题 4
    奇门接入白皮书 2015.8.20 2.2 productDate,expireDate 等字段 1 、 发 货 单 创 建 接 口 的 orderLine 下 面 增 加 2、渠道枚举字段调整，凡客由 FK 调整为 VANCL 1、新增 5 个接口，支持用于各种订单在仓内操作结果的 详情查询，包括入库单查询，出库单查询，退货入库单 查询，发货单查询，发货单缺货查询。 2015/8/31 2.3 2、订单流水查询和订单流水确认接口的 status，增加两 个状态，PARTFULFILLED，FULFILLED 两个状态。 3、入库单确认接口，出库单确认接口，增加单据状态字 段 status。 1、发货单确认接口，单价和数量字段类型修正 2015/9/6 2.3 2、所有正向接口，均补充 warehouseCode，作为可能 2015/9/7 2.3 的一单分多仓的业务场景。 1、新增接口，为菜鸟自动流转的业务新增的特殊业务接 口。 1、新增盘点单查询接口 2 、 盘 点 单 确 认 接 口 和 盘 点 单 查 询 接 口 均 增 加 2015/9/14 2.3 checkOrderId 3、发货单查询接口，为了兼容，入参将 2015/9/21 2015/9/22 2015/9/24 2015/10/10 2.3 2.3 2.3 2.3 deliveryOrderCode 改为 orderCode,deliveryOrderId 改为 orderId 入库单确认，出库单确认，退货入库单确认，发货单确 认，库存异动通知 新增心跳接口 1、订单流水查询接口增加 orderType 2、发货单确认接口 orderType 增加枚举值 QTCK。 1、库存盘点查询的接口名变更 1、在发货单确认，发货单查询，退货入库单确认，退货 2015/10/15 2.3 入库单查询等接口的 orderline 中增加商品二维码，用于 对单个商品的管理。 2015/10/20 2.3 1、新增商品同步接口（批量），发货单创建接口（批 量），发货单确认接口（批量） 2015/10/27 2015/11/19 2.3 2.3 1、发货单创建接口的 orderline 下增加 payNo，用于 解决合单后的支付宝交易号的传输。 1、出库单类型新增采购退货出库类型（CGTH） 5
    奇门接入白皮书 2015/11/23 2.3 1、发货单创建接口，出参 response 下增加 createTime。 2015/11/25 2.4 用户号，包括奇门仓库注册接口，奇门仓库查询接口， 新增 4 个接口，主要用来注册奇门的仓库编码，奇门的 2015/12/3 2015/12/8 2015/12/21 2015/12/28 2.4 2.4 2.4 2.4 奇门仓库更新接口，奇门用户注册接口 1、新增店铺同步接口 1、新增库存查询接口（多条件） 1、新增挂起（恢复）接口 2、取消和挂起接口的订单类型增加 THRK=退货入库 1、组合商品增加 itemId 字段 1、出库单确认接口，orderline 节点下增加货主编码这 2015/12/30 2.4 个字段 2015/12/31 2.4 2016/1/11 2.4 2016/1/27 2.4 2016/2/17 2.4 2016/2/18 2.4 2、单据取消接口，单据类型增加采购退货出库 1、商品同步接口，商品同步接口（批量）新增字段 goodsCode 1. 发货单查询接口增加使用交易单查询 2. 订单状态查询返回结果增加交易单号 3. 仓库加工单创建接口增加货主信息和商品配比信息 4. 仓库加工单确认接口增加货主信息 1. 新增数据字典获取接口 2. 新增数据字典更新接口 1. 为发货单创建新增异步化的结果返回接口——发货 单创建结果通知接口（批量） 1. 入库单创建、出库单创建接口单据类型增加虚拟入 库、虚拟出库 2. 入库单创建、出库单创建接口增加关联单据节点， 以满足调拨、虚入虚出的业务场景的需求 1. 新增发货单波次通知接口，用来给 ERP 或者 OMS 2016/2/19 2.4 回传波次号及对应的发货单号，以支持商家货票同 2016/3/8 2/4 行、波次内包裹的处理等需求。 1. sourcePlatformCode 字段添加 MIA=蜜芽 2. 出库单创建接口入参添加字段：供应商编码和供应 商名称 3. 异动通知接口添加异动时间字段 changeTime 6
    奇门接入白皮书 2016/3/21 2.4 流、DBWL=德邦物流、DBKD=德邦快递、DBKY=德邦 物流公司编码中，增加枚举值：AMAZON=亚马逊物 2016/4/11 2.4 2016/4/28 2.4 2016/5/19 2.5 快运 6.13 发货单创建接口 & 6.14 发货单创建接口 （批量） 两个接口，在 receiverInfo 中新增两个字段： 收件人证件类型，string (50)， 1-身份证 2- 军官证 3-护照 4-其他 收件人证件号码，string (50) 6.16 发货单确认接口 & 6.17 发货单确认接口（批量） 中，新增一个字段： 仓储费用，double (18, 2) 6.13 6.14 两个接口中，字段增加枚举 值：HBP(环保配), 订单流水通知接口 （taobao.qimen.orderprocess.report）& 订单流水查 询接口（taobao.qimen.orderprocess.query）的 processStatus 字段，新增枚举值 （TMSCANCELFAILED=快递拦截失败），对应菜鸟特 有接口配送拦截接口 （taobao.qimen.order.callback），用于异步返回拦截 结果 2016/5/27 2.6 新增枚举值：SIGN=签收(菜鸟仓可以返回签 发货单查询接口(taobao.qimen.deliveryorder.query), 收的状态) 所有包括 sourcePlatformCode 字段的接口， 2016/6/6 2.6 sourcePlatformCode 字段添加 GW=商家官网，CT= 2016/7/7 2.6 添加一些接口和字段的说明，方便 ISV 理解接口 村淘 枚举值 2016/7/14 2.7 删除接口 6.38-6.43。如果需要查看可参考 V2.6 43 个 接口封存版。 删除接口 6.34 菜鸟自动流转查询接口 （扩展），移至 菜鸟专有接口白皮书中。 7
    奇门接入白皮书 6.13 发货单创建接口新增字段：生产 批号，string(50) 6.13 发货单创建接口 (taobao.qimen.deliveryorder.create)、 6.14 发货单 创建接口（批量） 2016/9/10 2.8 (taobao.qimen.deliveryorder.batchcreate)新增服务 编码字段：服务编码, string (50)， NCWLJH=集包, 条件必填，条件为集包订单发货 1. 新增 6.19 订单 SN 通知接口 2016/11/22 2.9 2. 物流公司编码中新增：DBWL=德邦物流、DBKD=德 2017/4/28 2017/5/3 2017/5/16 3.0 3.0 3.1 2017/6/16 3.1 2017/6/20 3.1 2017/6/29 3.1 2017/9/19 2018/1/23 2018/2/5 3.1 3.1 3.1 邦快递、DBKY=德邦快运 添加调拨单创建、调拨单查询和调拨单通知接口（菜 鸟） 添加承运商 RRS=日日顺 库存盘点查询通知接口添加商品总量字段： 盘点商品总量，int 订单来源平台编码 OTHER=其他 修改为 OTHERS=其 他，和电子面单编码一致 入库单确认增加邮费字段，帮助商家分摊成本， 快递费用 (元) , double (18, 2) 发货单创建和发货单创建批量接口增加税号字段 税号,string(50) taobao.qimen.orderprocess.report 增加 expressCode(运单号) 订单来源平台编码添加 YJWD=云集微店 添加仓库信息查询接口 taobao.qimen.warehouseinfo.query 2018/3/5 3.2 单确认、出库单确认、发货单确认接口增加商品序 入库单创建、退货入库单创建、入库单确认、退货入库 列号, string(50)节点 出库单创建添加 purchasePrice、retailPrice 、actualPrice 字段 升级出库单创建接口支持唯品会调拨场景 添加商品查询接口 taobao.qimen.singleitem.query 8 2018/5/15 2018/5/30 2018/6/13 3.2 3.3 3.4
    分享到：
    赞 收藏

    相关推荐

    资料库

    开发技术

    共收录19306份资料，累计14个分类，关注成员有19位，主要包括：Actionscript,Javascript,PHP,VB,Perl,Delphi,Python,C#,C,Java,C++,Web开发,硬件开发,其它

    热门标签

    Actionscript Javascript PHP VB Perl Delphi Python C# C Java C++ Web开发 硬件开发 其它

    最新资料