Batch Integration | Supply Chain Open Platform

需求说明

联想VMI系统负责与国内外3PL进行对接。对接过程中常有一些全量数据的接口，数据量大，在网络不好的情况下，容易丢包，因此本方案是将大批的数据分页发送且需要校验完整性。

1.1 版本记录

版本	时间	内容	变更人
v1.0	2021-8-23	第一版	wangdong18
v1.1	2021-09-28	补充链路，补充流程，补充key值	lingcq1
V1.2	2021-10-19	1. soi_gr, loi_gr 删除asn字段，增加an， anLine字段 2. pull _info 增加字段destStorageLoc	lingcq1
V1.3	2021-11-18	1. pull_info, mo_pull_list 增加route字段 2. pull_info 增加groupId, totalQty字段 3. confirm pull增加destStorageLocation字段 4. 增加发货汇总，发货明细，暂存发货三个api	lingcq1
v1.4	2021-12-09	1. 添加body.code 代码异常说明 2. 添加支持hgc 3.为每个接口增加source_system, target_system, system_time	lingcq1
v1.4	2021-12-13	发货明细添加四个参数送货单号，车牌号，总毛重，总件数	lingcq1
v1.5	2021-12-17	purchase_order和item_supplier_all全量逻辑修改，从全量到by工厂全量	lingcq1
v1.6	2022-01-05	方案修改	lingcq1
v1.7	2022-01-13	1. 增加方案说明 2. 修改系统名为VMI/H***/L***E 3. confirm data 请求示例修改 4. 增加业务完整的请求示例	lingcq1
v1.8	2022-01-17	1. 修改确认接口, 增加数据状态fail	lingcq1
v1.9	2022-01-21	补充链接	lingcq1
v1.10	2022-01-22	补充VMI 链接， WSO2 key& token	lingcq1
v1.11	2022-02-15	外仓和3号GR-H**C发货汇总， 3号暂存发货汇总增加pallet信息，新接口待开发，后续补充结构	lingcq1
v1.12	2022-02-16	外仓和3号GR-H**C发货汇总， 3号暂存发货汇总这两个接口增加逻辑（待定）： 1. 一个push_id下的data中的数据只有一个拍号 2. 一个拍的数据必须放在同一个push_id的信号中，也就是一个push_id和一拍等价 3. 理论上一拍数据不会超1000条，该接口不分页。	lingcq1
v1.13	2022-02-17	3号暂存改为实时接口	lingcq1
v1.14	2022-02-21	3号暂存改为实时接口, 增加deliveryNo和deliveryLineNo字段	lingcq1
v1.15	2022--02-22	更新3号暂存接口url：/specialReceive/H**C/whse_tmp_trd_sum_delivery	lingcq1
v1.16	2022--02-23	1. 更新确认接口：确认请求对于fail的情况，增加failList， failReason， data(可以为整条数据，最少为promary key + shipToId)，返回增加result.message； 2. balance pull增加字段destStorageLocation，且pullId的定义， H以H开头， LE 以L开头； 3. inventory snapshot， po snapshot， po 频率和时段更新； 4. 整理primary key	gaomx5/lingcq1
v1.17	2022-02-28	确认3号暂存接口为实时接口：url：/specialReceive/H**C/whse_tmp_trd_sum_delivery 以及对应的字段	lingcq1
v1.18	2022-03-04	1. 3号暂存url修改，字段修改； 2. 增加3号GR和外仓收货汇总接口； 3. 添加PDA扫描的接口 FOR HIK；4.添加WSO2示例	lingcq1
v1.19	2022-03-08	报关明细添加供应商代码，订单号等信息	lingcq1
v1.20	2022-03-23	3号暂存, 3号GR和外仓收货汇总接口返回值调整	lingcq1
v1.21	2022-04-07	接口调整purchase_order改为purchase_order	gaomx5
v1.22	2022-04-13	PULL_INFO增加saNumber和saLineId字段	gaomx5
v0.00	2022-04-20	PULL_MO_INFO增加indicator和remark字段	gaomx5
v1.24	2022-04-22	1. PULL_MO_INFO增加changeType字段。 2. 3号暂存接口quantity修改为mo+item的总数， palletQty表示这一拍上这一个deliveryNo上的总数	lingcq1
v1.25	2022-05-11	增加WSO2 uat（pre-p）环境配置，补充token连接	gaomx5
v1.26	2022-05-16	pull_info接口增加productionOrdId。如果有值，认为mo bom change，非mo bom change，该字段为空(不传). 此外，针对mo bom chang，在v1.24中提到的pull_mo_info中的changeType取值，如果mo 创建了mo bom change的manual pull，则对应的整个mo list都要重新发给3pl，且字段取值是UPDATE, 非mo bom change取值ADD。	lingcq1
v1.27	2022-05-16	增加WSO2 prd环境配置，补充token连接	lingcq1
v1.28	2022-06-06	整理文档格式，将扫描相关接口独立到另一个文档	lingcq1
v1.29	2022-06-30	1. 拓展workshopCode: 1.4节增加workshopCode的描述 ;1.8和1.9增加跟push_id平级的workshop_code; 2. 1.8节增加push_id的要求:客户端生成的全局唯一批量数据ID，LE: LE; HC BOX: 时间戳； H SMT： H*-SMT 3. 1.10 PULL_INFO, PULL_MO_INFO增加排程和栈位号相关内容	lingcq1
v1.30	2022-07-22	支持LSSC SMT: 1.10 pull_mo_info接口增加prodDesc 和 moQty 2. 1.10 customs接口增加字段dropshipFlag，单独装车单独报关标记，取值Y/N	lingcq1
v1.31	2022-07-25	1.9 简化response	lingcq1
v1.32	2022-09-29	pull line 接口增加runFlag：取值产品好年月日run次，9* - NDT, 如RUN1,RUN2	lingcq1
v1.33	2023-01-04	mo list接口增加runFlag：取值产品好年月日run次，9* - NDT, 如RUN1,RUN2	lingcq1
v1.34	2023-04-11	增加sh2 wso2环境	lingcq1
v1.35	2023-06-14	增加urgent pull链路， 3PL可通过此链路发起类似于manual pull的需求， LX VMI 会正常走src-900-dest的库存移动	lingcq1
v1.36	2023-07-28	修改urgent pull，改为异步确认	lingcq1
v1.37	2023-12-13	补充并修改WSO2环境及对应S4环境	gaomx5

1.2 接入流程

WSO2接入的示例，联系VMI IT进行咨询。

mermaid

sequenceDiagram
Partner->>WSO2: 获取Token
WSO2-->>Partner: 返回Token
Partner->>WSO2: 请求API
WSO2->>VMI: 请求API
VMI-->>WSO2:返回结果
WSO2-->>Partner:返回结果

1.3 方案说明

方案一：【推荐方案】 按批分页发送，只要保证每页正常发送，无需异步确认。

方案二： 按批分页发送 + 异步确认

根据上述得方案，三方（Lenovo VMI, 海晨，联晟）都需要提供一个发送数据的接口和一个确认数据的接口。发送数据接口用于接收对方发送过来的数据。确认数据的接口是对方对已发送数据的确认。确认成功后方可进行后续处理。Lenovo vmi重发数据，会启用一个新的push_id推送数据。同时也要求海晨和联晟，重发数据，必须使用一个新的唯一的push_id.该方案不包含3号暂存发货， 3号GR收货，外仓收货接口， pda扫描接口。3号暂存发货， 3号GR收货，外仓收货接口， pda扫描接口接口等多要求实时性，做成实时接口，放在另外的文档。

1.4 公共参数说明

参数位置	参数名称	描述	示例
path	biz_key	下发给客户端的biz_key	如： item_supplier_all
header	sign	通过下发给用户的secret_key,对body进行签名的结果	详见签名文档，使用WSO2，暂时不启用
body	source_system	Y	string
body	target_system	Y	string
body	system_time	Y	string，请求的当前时间，如2021-12-09 11:00:00
body	workshop_code	业务标识，南方厂BOX: LSSC; 南方厂SMT: LSSC-SMT, 不填则默认为LSSC	LSSC-SMT

1.5 请求限制

RequestBody的JSON内容的总条数不得超过1000条，即单页中的数据量不大于1000条。1000条非固定，上线前可根据压测进行调整。如果一个push_id的总条数大于1000条，则需要分页推送。

1.6 公共返回说明

参数位置	参数名称	是否必填/不为空	参数类型	参数格式	描述	示例
response	code	Y	string	---	状态码	"0"代表接口是成功还是失败，不起业务判断作用
response	msg	N	string	---	提示消息	提示信息

1.7 返回码说明（更多code见具体接口）

参数位置	Value	描述
httpcode	200	正常返回结果
httpcode	401	Token错误/签名错误
body.code	"0"	成功
body.code	"-1"	系统异常

1.8 发送数据接口Push data

Description: 对于同一时间，并发量较大的数据，需要压缩为同一个push_id进行发送，否则会影响后续的工作流程. Sender如果发完一个push_id数据，则可以等待Receiver来confirm。

Method:POST

ContentType: application/json

请求说明

参数位置	参数名称	是否必填/不为空	参数类型	参数格式	描述	示例
body	push_id	Y	string	---	客户端生成的全局唯一批量数据ID，LE: LE; HC BOX: 时间戳； HC SMT： HC-SMT	---
body	workshop_code	N	string		业务标识，南方厂BOX: LSSC; 南方厂SMT: LSSC-SMT, 不填则默认为LSSC
body	total_size	Y	number	---	push_id要发送的总数据量，如果分页，这个total_size 要保证在不同页都一样，Sender要保证	---
body	current_page	Y	number		当前页
body	current_page_size	Y	number		当前页的page size，理论上应该是保证数据大小与data size一致， Sender要保证
body	data	Y	array	---	要push到Receiver的数据	---

接口请求示例

json

第一次push data, total_size是2， 当前第一页，当前页1条数据
{
  "push_id": "11111",
  "workshop_code":"workshop code",
  "source_system": "VMI",
  "target_system": "source system", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "data": [
    {
      "pull1": "ABCD001"
    }
  ]
}

第二次push data, total_size是2， 当前第二页，当前页1条数据
{
  "push_id": "11111",
  "workshop_code":"workshop code",
  "source_system": "VMI",
  "target_system": "source system", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 2,
  "current_page_size": 1,
  "data": [
    {
      "pull2": "ABCD001"
    }
  ]
}

接口返回示例

json

正常返回code=0才能认为这一页是成功发到Receiver
{
    "code":"0",
    "msg":"success"
}

{
    "code":"-1",
    "msg":"exception for what"
}

1.9 确认数据接口Confirm data - 异步确认（方案二才需要看）

Description: 当对于一个push_id, Receiver收集到了达到总数的数据后，需要给Sender一个confirm的信号。只有confirm这个信号本身达到双方系统，才认为这个push结束。

请求说明

参数位置	参数名称	是否必填/不为空	参数类型	参数格式	描述	示例
body	push_id	Y	string	---	客户端生成的全局唯一批量数据ID	---
body	workshop_code	N	string		业务标识，南方厂BOX: LSSC; 南方厂SMT: LSSC-SMT, 不填则默认为LSSC
body	result.status	Y	string		取值只能是success/fail
body	result.message	N	string		用于返回失败的原因描述，是一个总的失败原因
body	result.failList	N	array		用于返回失败的行对象及错误信息
body	result.failList.failReason	N	string		用于返回失败行的错误信息
body	result.failList.data	N	object		用于返回失败行的对象, 对应的不同的api，是不同的对象。

json

确认成功示例
{
"push_id": "11111",
"workshop_code":"workshop code",
"source_system": "VMI",
"target_system": "source system", 
"system_time":"2020-11-20 14:00:00",
"result":{
   "status": "success",
   "message":"success" 
	}
}

确认失败示例
{
"push_id": "wwww",
"workshop_code":"workshop code",
"source_system": "VMI",
"target_system": "source system", 
"system_time":"2020-11-20 14:00:00",
"result":{
   "status": "fail",
   "message":"fail reason",
   "failList":[{"failReason":"fail reason", "data":{//可以整条数据返回，也可以只返回primary key + 工厂 }}]
	}
}

接口返回参数

参数位置	参数名称	是否必填/不为空	参数类型	参数格式	描述	示例
body	result.status	Y	string		确认之后数据的最终状态。接收方带着确认信息（成功或者失败）过来。发送方自身也可能维护着超时和失败的状态，此时这个返回值应该是发送方根据接收方的信息和自身维护的信息，综合给出这条数据最终的状态。如果发送方自身维护的状态是超时和失败，则忽略接收方发过来的信息，返回该条数据的最终状态为超时或者失败。如果发送自身没有维护信息，则以接收方发过来的信息为准，给出最终状态为接收方确认的状态。取值只能是success/timeout/in_process/fail
body	result.message	N	string		用于返回失败的原因描述

接口返回示例

json

成功确认且数据状态是成功 code = 0 && result.status = 'success'， 双方认为数据有效
{
    "code":0,
    "msg": "success",
    "result":{
        "status":"success",
        "message":"ok"
    }
}
    
失败确认1, code ！= "0"，系统异常，需要继续confirm， 建议定时重复确认（每分钟重复确认，超过20分钟的，可以不用确认了）
{
    "code":-1,
    "msg": "exception/in_process"
}

失败确认2 code = '0' && status = 'fail'，这种情况数据作废,不需要继续confirm了， status= fail的原因， 可能是对方确认的fail， 也可能是超时
{
    "code":0,
    "msg": "success"，
    "result":{
        "status":"fail",
    	"message":"fail/timeout"
    }
}

数据防重复操作机制和频率

数据	操作机制	频率
SOI_GR	增量，多个相同Primary Key数据视为重复，只取一条
LOI_GR	增量，多个相同Primary Key数据视为重复，只取一条
MO_PREKITTING_FINISH	增量，多个相同Primary Key数据视为重复，只取一条
CONFIRM_PULL	增量，多个相同Primary Key数据视为重复，只取一条
DISPATCH_PULL	增量，多个相同Primary Key数据视为重复，只取一条
BALANCE_PULL	增量，多个相同Primary Key数据视为重复，只取一条
INVENTORY_SNAPSHOT	增量，多个相同Primary Key数据视为重复，只取一条	H***/ L***E:一天一次，凌晨2点做快照， by工厂发
PO_SNAPSHOT	增量，多个相同Primary Key数据视为重复，只取一条	H***/L***E: 一天一次，凌晨2点做快照，全量发
CUSTOMS_DELIVERY_DETAIL	增量，多个相同Primary Key数据视为重复，只取一条
PURCHASE_ORDER	全量，取完一批数据后，区别出工厂后删除表内对应工厂数据再插入	2小时一次
ITEM_SUPPLIER_ALL	全量，取完一批数据后，区别出工厂后删除表内对应工厂数据再插入
ITEM_SUPPLIER	增量，根据PrimaryKey进行update or insert
PULL_INFO	增量，多个相同Primary Key数据视为重复，只取一条
PULL_MO_LIST	增量，多个相同Primary Key数据视为重复，只取一条

1.10 业务数据 data 部分说明

SOI_GR data部分说明

参数名称	参数类型	数据库type	描述	Primary key
tplReceiptId	string	VARCHAR2(20)	3PL receipt id,	Y
supplierId	string	VARCHAR2(10)	Supplier id
shipToId	string	VARCHAR2(4)	Logical plant
receiptDate	string	Date	Receipt date, yyyy-MM-dd HH:mm:ss
tplReceiptLineId	string	VARCHAR2(20)	3PL receipt line id	Y
itemId	string	VARCHAR2(18)	Item id
destBin	string	VARCHAR2(40)	Destination bin
destType	string	VARCHAR2(40)	Destination type
destStorageLocation	string	VARCHAR2(40)	Destination storage location
quantity	number	NUMBER(13,3)	Quantity
holdType	string	CHAR(1)	Q或者S ，如果为空字符串，表示没有hold
holdQuantity	number	NUMBER(13,3)	Hold quantity
houseAirWayBill	string	VARCHAR2(32)	House Airway Bill
purchaseOrderId	string	VARCHAR2(10)	Empty for now
purchaseOrderLineId	string	VARCHAR2(10)	Empty for now
dnNumber	string	VARCHAR2(26)	Delivery Notes on Packing info
an	string	VARCHAR2(10)	arrival notice
anLine	string	VARCHAR2(5)	arrival notice line
dataType	string	VARCHAR2(20)	dt1

json

{
  "push_id": "11111",
  "source_system": "source system",
  "target_system": "VMI", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "workshop_code": "workshop code",
   "data": [
    {
      "tplReceiptId": "receipt1",
      "supplierId": "supplier1",
      "shipToId": "111",
      "receiptDate": "2020-11-20 14:00:00",
      "tplReceiptLineId": "line1",
      "itemId": "item1",
      "destBin": "VENDOR",
      "destType": "222",
      "destStorageLocation": "CCCDDD",
      "quantity": 111,
      "holdType": "Q",
	 "holdQuantity":0,
	 "houseAirWaybill":"123456789",
	 "purchaseOrderId": "",
	 "purchaseOrderLineId":"",
	  "dnNumber":"dn1",
      "an": "1234567896",
      "anLine": "1234567896",
      "dataType": "dt1"
    }
  ]
}

LOI_GR data部分说明

参数名称	参数类型	数据库type	描述	Primary Key
tplReceiptId	string	VARCHAR2(20)	3PL receipt id	Y
supplierId	string	VARCHAR2(10)	Supplier id
shipToId	string	VARCHAR2(4)	Logical plant
receiptDate	string	DATE	Receipt date，yyyy-MM-dd HH:mm:ss
invoiceNumber	string	VARCHAR2(16)	Invoice number
tplReceiptLineId	string	VARCHAR2(20)	3PL receipt line id	Y
itemId	string	VARCHAR2(18)	Item id
destBin	string	VARCHAR2(40)	Destination bin
destType	string	VARCHAR2(40)	Destination type
destStorageLocation	string	VARCHAR2(40)	Destination storage location
quantity	number	NUMBER(13,3)	Quantity
holdType	string	CHAR(1)	Q或者S ，如果为空字符串，表示没有hold
holdQuantity	number	NUMBER(13,3)	Hold quantity
houseAirWayBill	string	VARCHAR2(32)	House Airway Bill
purchaseOrderId	string	VARCHAR2(10)	Purchase Order (or Sales Agreement) Number
purchaseOrderLineId	string	VARCHAR2(5)	Purchase Order Line (or Sales Agreement Line) Number
dnNumber	string	VARCHAR2(26)	Delivery Notes on Packing info.
an	string	VARCHAR2(10)	arrival notice
anLine	string	VARCHAR2(5)	arrival notice line
dataType	string	VARCHAR2(20)	LOIGR

json

{
  "push_id": "11111",
   "workshop_code": "workshop code",
  "source_system": "source system",
  "target_system": "VMI", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "data": [
    {
      "tplReceiptId": "receipt1",
      "supplierId": "supplier1",
      "shipToId": "A**",
      "receiptDate": "2020-11-20 14:00:00",
	  "invoiceNumber": "9953090187",
      "tplReceiptLineId": "line1",
      "itemId": "item1",
      "destBin": "VENDOR",
      "destType": "222",
      "destStorageLocation": "CCCDDD",
      "quantity": 1440,
      "holdType": "Q",
	 "holdQuantity":0,
	 "houseAirWaybill":"123456789",
	 "purchaseOrderId": "",
	 "purchaseOrderLineId":"",
	  "dnNumber":"dn1",
      "an": "1234567896",
      "anLine": "1234567896",
      "dataType": "LOIGR"
    }
  ]
}

MO_PREKITTING_FINISH data部分说明

参数名称	参数类型	数据库type	描述	Primary Key
productionOrdId	string	VARCHAR2(80)	mo id	Y
shipToId	string	VARCHAR2(4)	plant
sourceType	string	VARCHAR2(40)	pre source type
sourceStorageLocation	string	VARCHAR2(40)	pre source sloc
sourceBin	string	VARCHAR2(40)	pre source bin
destType	string	VARCHAR2(20)	dest type
destStorageLocation	string	VARCHAR2(40)	dest location
destBin	string	VARCHAR2(40)	dest bin
pullQuantity	number	NUMBER	pull qty
itemId	string	VARCHAR2(18)	material name	Y

json

{
  "push_id": "11111",
   "workshop_code": "workshop code",
  "source_system": "source system",
  "target_system": "VMI", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "data": [
    {
      "productionOrdId": "ABCD001",
      "shipToId": "AAA",
      "sourceType": "L21",
      "sourceStorageLocation": "CCCDDD",
	  "sourceBin": "FIS",
      "destType": "W02",
      "destStorageLocation": "MW02",
      "destBin": "KIT",
      "pullQuantity": 2,
      "itemId": "SP10R39102"
    }
  ]
}

CONFIRM_PULL data部分说明

参数名称	参数类型	数据库type	描述	Primary Key
pullId	String	VARCHAR2(40)	Pull header id	Y
shipToId	String	VARCHAR2(40)	Logic plant
destStorageLocation	String	VARCHAR2(40)	destStorageLocation
destBin	String	VARCHAR2(40)	Destination bin
destType	String	VARCHAR2(40)	Destination type
pullType	String	VARCHAR2(40)	Pull type
pullLineId	String	VARCHAR2(40)	Pull line id	Y
itemId	String	VARCHAR2(18)	Item id
supplierId	String	VARCHAR2(40)	Supplier id
sourceStorageLocation	String	VARCHAR2(40)	Source storage location
sourceBin	String	VARCHAR2(40)	Source bin
sourceType	String	VARCHAR2(40)	Source type
quantity	number	NUMBER	Confirm quantity
dataType	String	VARCHAR2(40)	PullConfirm

json

{
  "push_id": "11111",
   "workshop_code": "workshop code",
  "source_system": "source system",
  "target_system": "VMI", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "workshopCode": "workshop code",
  "data": [
      {
		"pullId": "1489865",
		"shipToId": "AAA",
        "destStorageLocation": "MMMN",
		"destBin": "W09",
		"destType": "W06",
		"pullType": "NORMAL",
		"pullLineId": "line1",
		"itemId": "item1",
		"supplierId": "supplier1",
		"sourceStorageLocation": "CCCDDD",
		"sourceBin": "VENDOR",
		"sourceType": "C51",
		"quantity": 21,
		"dataType": "PullConfirm"
	}
  ]
}

DISPATCH_PULL data部分说明

参数名称	参数类型	数据库type	描述	Primary Key
pullId	String	VARCHAR2(10)	Pull header id	Y
shipToId	String	VARCHAR2(4)	Logic plant
shippedDate	String	DATE	Shipped date
pullLineId	String	VARCHAR2(10)	Pull line id	Y
itemId	String	VARCHAR2(18)	Item id
supplierId	String	VARCHAR2(40)	Supplier id
sourceStorageLocation	String	VARCHAR2(40)	Source storage location
sourceBin	String	VARCHAR2(40)	Source bin
sourceType	String	VARCHAR2(40)	Source type
quantity	number	NUMBER	Dispatch quantity
dataType	String	VARCHAR2(40)	Dispatch

json

{
  "push_id": "11111",
   "workshop_code": "workshop code",
  "source_system": "source system",
  "target_system": "VMI", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "data": [
      {
		"pullId": "pull1",
		"shipToId": "AAA",
		"shippedDate": "2021-09-11 11:11:11",
		"pullLineId": "line1",
		"itemId": "item1",
		"supplierId": "supplier1",
		"sourceStorageLocation": "CCCDDD",
		"sourceBin": "VENDOR",
		"sourceType": "C51",
		"quantity": 21,
		"dataType": "Dispatch"
	}
  ]
}

BALANCE_PULL data 部分说明

参数名称	参数类型	数据库type	描述	Primary Key
pullId	String	VARCHAR2(10)	Pull header id	Y
shipToId	String	VARCHAR2(4)	Logic plant
shippedDate	DATE	DATE	Ship date
destType	String	VARCHAR2(40)	Destination type
destBin	String	VARCHAR2(40)	Destination bin
pullLineId	String	VARCHAR2(40)	Pull line id	Y
itemId	String	VARCHAR2(40)	Item id
supplierId	String	VARCHAR2(40)	Supplier id
destStorageLocation	String	VARCHAR2(40)	用于集货仓IM移动
sourceStorageLocation	String	VARCHAR2(40)	Source storage loc
sourceBin	String	VARCHAR2(40)	Source bin
sourceType	String	VARCHAR2(40)	Source type
quantity	number	NUMBER	quantity
dataType	String	VARCHAR2(40)	Balance

json

{
  "push_id": "11111",
   "workshop_code": "workshop code",
  "source_system": "source system",
  "target_system": "VMI", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "data": [
      {
		"pullId": "pull1",
		"shipToId": "shopto",
		"shippedDate": "2021-09-11 11:11:11",
		"destType": "A**A",
		"destBin": "FIS",
		"pullLineId": "line1",
		"itemId": "item1",
		"supplierId": "supplier1",
        "destStorageLocation":"sss",
		"sourceStorageLocation": "CCCDDD",
		"sourceBin": "VENDOR",
		"sourceType": "222",
		"quantity": 21,
		"dataType": "Balance"
	}
  ]
}

INVENTORY_SNAPSHOT data 部分说明

参数名称	参数类型	数据库type	描述	Primary Key
supplierId	String	VARCHAR2(40)	Supplier id	Y
shipToId	String	VARCHAR2(4)	Logic plant	Y
itemId	String	VARCHAR2(18)	Item id	Y
status	String	VARCHAR2(10)	Status	Y
storageLocation	String	VARCHAR2(40)	Storage location	Y
storageBin	String	VARCHAR2(40)	Storage bin	Y
storageType	String	VARCHAR2(40)	Storage type	Y
quantity	number	NUMBER	quantity
dataType	String	VARCHAR2(40)	Inventory

json

{
  "push_id": "11111",
  "workshop_code": "workshop code",
  "source_system": "source system",
  "target_system": "VMI", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "data": [
      {
		"supplierId": "supplier1",
		"shipToId": "shopto",
		"itemId": "item1",
		"status": "A",
		"storageLocation": "CCCDDD",
		"storageBin": "VENDOR",
		"storageType": "A**",
		"quantity": 1,
		"dataType": "Inventory"
	}
  ]
}

PO_SNAPSHOT data部分说明

参数名称	参数类型	数据库type	描述	Primary Key
purchaseOrderId	String	VARCHAR2(10)	Po id	Y
supplierId	String	VARCHAR2(40)	Supplier id
shipToId	String	VARCHAR2(4)	Logic plant
createDate	Date	DATE	Create date
startDate	Date	DATE	Start date
endDate	Date	DATE	End date
purchaseOrderLineId	String	VARCHAR2(5)	Po line id	Y
itemId	String	VARCHAR2(18)	Item id
quantity	number	NUMBER	quantity
openQuantity	number	NUMBER	Open quantity
dataType	String	VARCHAR2(40)	POK

json

{
  "push_id": "11111",
   "workshop_code": "workshop code",
  "source_system": "source system",
  "target_system": "VMI", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "data": [
      {
		"purchaseOrderId": "A**A",
		"supplierId": "supplier1",
		"shipToId": "AAA",
        "createDate":"2021-09-01 11:11:11",
        "startDate":"2021-09-01 11:11:11",
        "endDate":"2021-09-01 11:11:11",
		"purchaseOrderLineId": "L10",
		"itemId": "item1",
		"quantity": 1,
		"openQuantity": 1,
		"dataType": "POK"
	}
  ]
}

CUSTOMS_DELIVERY_DETAIL 发货明细 data部分说明

参数名称	参数类型	数据库type	描述	Primary Key
deliveryNoteNo	String	VARCHAR2(18)	送货单号	Y
deliveryLineNo	String
deliveryPlateNumber	number	VARCHAR2(10)	车牌号
totalGrossWeight	String	NUMBER(18,3)	总毛重
totalBoxNumber	number	NUMBER(18,3)	总件数
itemId	String	VARCHAR2(18)	物料号
quantity	number	number	数量
pullId	String	VARCHAR2(10)	pullheaderid	Y
pullLineId	String	VARCHAR2(10)	pulllineid	Y
inventoryType	String	VARCHAR2(10)	inventory type SOI或者LOI
sourcePlant	String	VARCHAR2(4)	起始工厂
sourceLocation	String	VARCHAR2(4)	起始库存地
destPlant	String	VARCHAR2(4)	目的工厂
destLocation	String	VARCHAR2(4)	目的库存地
coo	String	VARCHAR2(20)	原产地
brand	String	VARCHAR2(20)	品牌
type	String	VARCHAR2(20)	包装种类
dataType	String	VARCHAR2(40)
supplierCode	String	VARCHAR2(40)	供应商代码
orderNo	String	VARCHAR2(12)	订单编号
orderItem	String	VARCHAR2(32)	订单行号
fullBoxIndicator	String	VARCHAR2(32)	整箱标识，取值是Y或者N
price	number	NUMBER(18,5)	单价
curr	String	VARCHAR2(10)	币制
dropshipFlag	string	VARCHAR2(2)	单独装车单独报关标记，取值Y/N

json

{
  "push_id": "11111",
  "workshop_code": "workshop code",
  "source_system": "source system",
  "target_system": "VMI", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "data": [
      {
		"deliveryNoteNo":"A**A",
        "deliveryPlateNumber":"A**A",
        "totalGrossWeight":110.00,
        "totalBoxNumber":666,
        "itemId": "A**A",
        "quantity": 1,
		"pullId": "A**A",
		"pullLineId": "A**A",
        "inventoryType":"SOI",
        "sourcePlant": "A**",
		"sourceLocation": "CCCDDD",
        "destPlant": "A**",
		"destLocation": "CCCDDD",
        "coo": "xx",
		"brand": "xx",        
        "type":"candyman",
		"dataType": "CUSTOMS_DELIVERY",
        "route":"CCCDDD_FFFF",
        "supplierCode":"A**",
        "orderNo":"moId",
        "orderItem":"molineid",
        "fullBoxIndicator":"Y",
        "price": 0,
        "curr":"502",
        "dropshipFlag":"Y"
	}
  ]
}

PURCHASE_ORDER data部分说明

参数名称	参数类型	数据库type	描述	Primary Key
purchaseOrderId	string	VARCHAR2(10)	PO Id	Y
supplierId	string	VARCHAR2(10)	Supplier Id
shipToId	string	VARCHAR2(4)	Logical plant
purchaseOrderLineId	string	VARCHAR2(5)	PO line id	Y
poType	string	VARCHAR2(40)	PO类型
itemId	string	VARCHAR2(18)	Material Id
quantity	number	NUMBER(13,3)	Quantity
openQuantity	number	NUMBER(13,3)	Open quantity
storageLocation	string	VARCHAR2(40)	Storage location，S4 如果为空，接口可能为空
returnItem	string	VARCHAR2(40)	Remark return PO
dataType	string	VARCHAR2(20)	PO
createDate	string	DATE	CreateDate
startDate	string	DATE	StartDate
endDate	string	DATE	EndDate

json

{
  "push_id": "11111",
   "workshop_code": "workshop code",
  "source_system": "VMI",
  "target_system": "source system", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "data": [
      {
      "purchaseOrderId": "A**",
      "supplierId": "A**",
      "shipToId": "A**",
      "purchaseOrderLineId": "A**",
      "poType": "MB",
      "itemId": "A**A",
      "quantity": 111,
      "openQuantity": 22,
      "storageLocation": "MRMN",
      "returnItem": "eeeeeee",
      "dataType": "PO",
      "createDate": "2021-01-01 11:11:11",
      "startDate": "2021-01-01 11:11:11",
      "endDate": "2021-01-01 11:11:11"
	}
  ]
}

ITEM_SUPPLIER_ALL/ITEM_SUPPLIER data部分说明

参数名称	参数类型	数据库type	描述	Primary Key
supplierId	string	VARCHAR2(40)	Supplier Id	Y
supplierDesc	string	VARCHAR2(200)	Supplier Description
itemId	string	VARCHAR2(18)	Material Id	Y
itemDesc	string	VARCHAR2(200)	Material Description
shipToId	string	VARCHAR2(4)	Logical plant	Y
itemType	string	VARCHAR2(40)	Material type, defined by ECC sscode
status	string	VARCHAR2(40)	Operation type *
inspectionType	string	VARCHAR2(40)	Whether the item needs inspection, IQC检测flag
dataType	string	VARCHAR2(20)	ItemSupplier

json

{
  "push_id": "11111",
  "workshop_code": "workshop code",
  "source_system": "VMI",
  "target_system": "source system", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "data": [
      {
		"supplierId": "A**",
		"supplierDesc": "desc",
		"itemId": "A**A",
		"itemDesc": "desc ",
		"shipToId": "A**",
		"itemType": "PU",
		"status": "UPDATE",
		"inspectionType": "Y",
		"dataType": "ItemSupplier"
	}
  ]
}

PULL_INFO data部分说明

参数名称	参数类型	数据库type	描述	Primary Key
shipToId	String	VARCHAR2(4)	Logic plant
productionLine	String	VARCHAR2(40)	Production line
deliveryDate	String	DATE	Delivery date (DS upload) XXX
destStorageLoc	String	VARCHAR2(40)	Destination storage location
destType	String	VARCHAR2(40)	Destination type
destBin	String	VARCHAR2(40)	Destination bin
pullType	String	VARCHAR2(40)	Pull type *
moType	String	VARCHAR2(40)	Demand type *
isSOI	String	VARCHAR2(10)	CASE WHEN INVENTORY_TYPE='SOI' THEN 'Y' ELSE 'N' END
creationDate	String	DATE	Creation date
pullId	String	VARCHAR2(10)	Pull header ID	Y
pullLineId	String	VARCHAR2(10)	Pull line ID	Y
tplReceiptId	String	VARCHAR2(10)	3PL receipt ID
tplReceiptLineId	String	VARCHAR2(10)	3PL receipt line ID
sourceType	String	VARCHAR2(40)	Source type
sourceStorageLocation	String	VARCHAR2(40)	Source storage location
sourceBin	String	VARCHAR2(40)	Source bin
specialRemark	String	VARCHAR2(40)	Nullable
supplierId	String	VARCHAR2(40)	Supplier ID
supplierDesc	String	VARCHAR2(40)	Nullable in case of LOI
quantity	number	NUMBER	Request quantity
fullBoxQuantity	number	NUMBER	Full box quantity
itemId	String	VARCHAR2(18)	Material ID
itemDesc	String	VARCHAR2(200)	Material description
lotNumber	String	NUMBER	收货批次有值或空，only for manual
boxId	String	VARCHAR2(40)	箱号有值或空，only for manual
brand	String	VARCHAR2(40)	品牌有值或空，only for manual
coo	String	VARCHAR2(18)	COO 有值或空，only for manual
dateCode	String	VARCHAR2(40)	datecode 有值或空，only for manual
urgent	String	VARCHAR2(40)	加急有值或空，only for manual
dataType	String	VARCHAR2(40)	Pull
route	String	VARCHAR2(400)	字符串，路径
groupId	String	VARCHAR2(20)
totalQty	number	number
saNumber	String	VARCHAR2(64)
saLineId	String	VARCHAR2(5)
productionOrdId	String	VARCHAR2(20)	For BOX, 是MO; for SMT, 是排程号
stackLocationBarCode	string	VARCHAR2(20)	栈号， SMT 特有， BOX不传这个字段
runFlag	string	VARCHAR2(100)	forbox，取值举例RUN1,RUN2

json

{
  "push_id": "11111",
  "workshop_code": "workshop code",
  "source_system": "VMI",
  "target_system": "source system", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "workshop_code":"workshop code",
  "data": [
      {
		"shipToId": "111",
		"productionLine": "**",
		"deliveryDate": "2021-01-01 11:11:11",
        "destStorageLoc": "CCCDDD",
		"destType": "W02",
		"destBin": "A**",
		"pullType": "MANUAL",
		"moType": "SO",
		"isSOI": "Y",
		"creationDate": "2021-01-01 11:11:11",
		"pullId": "A**A",
		"pullLineId": "A**A",
		"tplReceiptId ": "111",
		"tplReceiptLineId ": "1",
		"sourceType": "A**",
		"sourceStorageLocation": "CCCDDD",
		"sourceBin": "VENDOR",
		"specialRemark": "1494233 L-121",
		"supplierId": "A**",
		"supplierDesc": "desc",
		"quantity": 1,
		"fullBoxQuantity": 6,
		"itemId": "A**A",
		"itemDesc": "item desc",
		"lotNumber": "xx",
		"boxId": "xx",
		"brand": "xx",
		"coo": "xx",
		"dateCode": "xx",
		"urgent": "xx",
		"dataType": "Pull",
        "route":"CCCDDD_FFFF",
        "groupId":"GROUP1",
        "totalQty":1009,
        "saNumber":"00000000",
        "saLineId":"00010",
        "productionOrdId": "SSSSSSS", -- For BOX, 是MO; for SMT, 是排程号
        "stackLocationBarCode":"0000",  -- 栈号， SMT 特有， BOX不传这个字段
        "runFlag":"RUN1,RUN2",  -- 
	}
  ]
}

PULL_MO_INFO data部分说明

参数名称	参数类型	数据库type	描述	Primary Key
productionOrdId	String	VARCHAR2(12)	For BOX, 是MO; for SMT, 是排程号	Y
stackLocationBarCode	string	VARCHAR2(20)	栈号， SMT 特有， BOX不传这个字段	Y- Only for smt
shipToId	String	VARCHAR2(4)	plant
bomName	String	VARCHAR2(18)	finish goods name
pullId	String	VARCHAR2(10)	pull header id	Y
pullLineId	String	VARCHAR2(10)	pull line id	Y
sourceType	String	VARCHAR2(40)	source type
sourceStorageLocation	String	VARCHAR2(40)	source sloc
sourceBin	String	VARCHAR2(40)	source bin
destType	String	VARCHAR2(40)	dest type
destStorageLocation	String	VARCHAR2(40)	dest sloc
destBin	String	VARCHAR2(40)	dest bin
pullType	String	VARCHAR2(40)
inventoryType	String	VARCHAR2(40)	inventory type LOI/SOI
supplierId	String	VARCHAR2(40)	soi是vendor号， loi 默认写3PL
headerSupplierId	String	VARCHAR2(40)	3pl
pullQuantity	number	NUMBER	pull qty
productionLine	String	VARCHAR2(40)	production line
deliveryDate	String	DATE	delivery date by APS
itemId	String	VARCHAR2(18)	material name
posnr	String	VARCHAR2(4)	reservation no in MO bom
route	String	VARCHAR2(400)	字符串，路径
indicator	String	VARCHAR2(10)	CSC	原包装发货，取值是CSC, 其他取值为空（不传该字段）
remark	String	VARCHAR2(250)
changeType	String	VARCHAR2(10)	ADD/UPDATE	新增或者更新. 如果发生了mo bom change，则整个mo list重新发送，取值UPDATE, 否则为ADD
prodDesc	string	VARCHAR2(120)		成品料号描述
moQty	number	NUMBER(11,0)		mo qty，成品数量
runFlag	string	VARCHAR2(100)		forbox，取值举例RUN1,RUN2

json

{
  "push_id": "11111",
  "workshop_code": "workshop code",
  "source_system": "VMI",
  "target_system": "source system", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "data": [
      {
		"productionOrdId": "ABCD001",
        "stackLocationBarCode":"0001"  -- 栈号， SMT 特有， BOX不传这个字段
		"shipToId": "shopto",
		"bomName": "****",
		"pullId": "****",
		"pullLineId": "****",
		"sourceType": "A**",
		"sourceStorageLocation": "CCCDDD",
		"sourceBin": "VENDOR",
		"destType": "A**",
		"destStorageLocation": "CCCDDD",
		"destBin": "VENDOR",
		"pullType": "NORMAL",
		"inventoryType": "SOI",
		"supplierId": "****",
		"headerSupplierId": "flex",
		"pullQuantity": 2,
		"productionLine": "**",
		"deliveryDate": "2021-01-01 11:11:11",
		"itemId": "A**A",
		"posnr": "1",
        "route":"CCCDDD_FFFF",
        "indicator": "",
        "remark":"",
        "changeType":"ADD"，
        "prodDesc":"成品",
         "moQty":10，
         "runFlag":"RUN1,RUN2",  -- 
	}
  ]
}

URGENT_PULL data 部分说明

参数名称	参数类型	数据库type	描述	Primary Key
pullId	String	VARCHAR2(10)	Pull header id，必须与H开头，不能与balance pull重复	Y
shipToId	String	VARCHAR2(4)
shippedDate	DATE	DATE	Ship date
destType	String	VARCHAR2(40)	Destination type
destBin	String	VARCHAR2(40)	Destination bin
pullLineId	String	VARCHAR2(40)	Pull line id	Y
itemId	String	VARCHAR2(40)	Item id
supplierId	String	VARCHAR2(40)	Supplier id, 如果是LOI，请填写3PL，如果是SOI，请填写供应商id
destStorageLocation	String	VARCHAR2(40)	用于集货仓IM移动
sourceStorageLocation	String	VARCHAR2(40)	Source storage loc
sourceBin	String	VARCHAR2(40)	Source bin
sourceType	String	VARCHAR2(40)	Source type
remark	String	VARCHAR2(4000)	数据库限制，不要太长，最长4000
quantity	number	NUMBER	quantity
dataType	String	VARCHAR2(40)	Balance

json

{
  "push_id": "11111",
   "workshop_code": "code**",
  "source_system": "source system",
  "target_system": "VMI", 
  "system_time":"2020-11-20 14:00:00",
  "total_size": 2,
  "current_page": 1,
  "current_page_size": 1,
  "mode":"sync", //该接口会由工作流进行异步确认，所以加上这个参数
  "data": [
      {
		"pullId": "pull1",//H开头，且不能与balance pull重复
        "pullLineId": "line1",
		"shipToId": "shopto",
		"shippedDate": "2021-09-11 11:11:11",
        "destStorageLocation":"sss",
		"destType": "A**A",
		"destBin": "FIS",
		"itemId": "item1",
		"supplierId": "3PL",//Supplier id, 如果是LOI， 请填写3PL， 如果是SOI，请填写供应商id
		"sourceStorageLocation": "CCCDDD",
		"sourceBin": "VENDOR",
		"sourceType": "222",
		"quantity": 21,
        "remark":"for what DN",
		"dataType": "URGENT"
	}
  ]
}

需求说明 ​

1.1 版本记录 ​

1.2 接入流程 ​

1.3 方案说明 ​

​

1.4 公共参数说明 ​

1.5 请求限制 ​

1.6 公共返回说明 ​

1.7 返回码说明（更多code见具体接口） ​

1.8 发送数据接口Push data ​

接口请求示例 ​

​

接口返回示例 ​

1.9 确认数据接口Confirm data - 异步确认（方案二才需要看） ​

请求说明 ​

接口返回参数 ​

接口返回示例 ​

数据防重复操作机制和频率 ​

1.10 业务数据 data 部分说明 ​

SOI_GR data部分说明 ​

LOI_GR data部分说明 ​

MO_PREKITTING_FINISH data部分说明 ​

CONFIRM_PULL data部分说明 ​

DISPATCH_PULL data部分说明 ​

BALANCE_PULL data 部分说明 ​

INVENTORY_SNAPSHOT data 部分说明 ​

PO_SNAPSHOT data部分说明 ​

CUSTOMS_DELIVERY_DETAIL 发货明细 data部分说明 ​

PURCHASE_ORDER data部分说明 ​

ITEM_SUPPLIER_ALL/ITEM_SUPPLIER data部分说明 ​

PULL_INFO data部分说明 ​

PULL_MO_INFO data部分说明 ​

URGENT_PULL data 部分说明 ​

需求说明

1.1 版本记录

1.2 接入流程

1.3 方案说明

1.4 公共参数说明

1.5 请求限制

1.6 公共返回说明

1.7 返回码说明（更多code见具体接口）

1.8 发送数据接口Push data

接口请求示例

接口返回示例

1.9 确认数据接口Confirm data - 异步确认（方案二才需要看）

请求说明

接口返回参数

接口返回示例

数据防重复操作机制和频率

1.10 业务数据 data 部分说明

SOI_GR data部分说明

LOI_GR data部分说明

MO_PREKITTING_FINISH data部分说明

CONFIRM_PULL data部分说明

DISPATCH_PULL data部分说明

BALANCE_PULL data 部分说明

INVENTORY_SNAPSHOT data 部分说明

PO_SNAPSHOT data部分说明

CUSTOMS_DELIVERY_DETAIL 发货明细 data部分说明

PURCHASE_ORDER data部分说明

ITEM_SUPPLIER_ALL/ITEM_SUPPLIER data部分说明

PULL_INFO data部分说明

PULL_MO_INFO data部分说明

URGENT_PULL data 部分说明