schm-inbound-sap-eapi

(0 reviews)

schm-inbound-sap-eapi

接口描述: 单据上传接口
DEV地址（开发环境）: https://schm-api-dev.shiseido.cn/schm-inbound-sap-eapi
UAT地址（测试环境）: https://schm-api-test.shiseido.cn/schm-inbound-sap-eapi
PROD地址（生产环境）: https://schm-api.shiseido.cn/schm-inbound-sap-eapi

1.身份认证

所有请求头必须包含以下键值参数作为身份验证信息。您需要向管理员申请这些信息。

client_id: fa98****3452
client_secret: 108b****41f2

2.接口总览:

请求接口	描述
/inbound/oms	订货销售单据上传(oms)
/inbound/pos	订货销售单据上传(pos)
/inbound/purchase	采购订单上传

完整调用地址为对应环境地址+接口地址，例如：

https://schm-api-test.shiseido.cn/schm-inbound-sap-eapi/api/v1/inbound/oms

3.接口调用说明

3.1 订货销售单据上传(oms)

请求接口: /inbound/oms
接口描述: oms订货销售单据上传接口
请求类型: HTTP POST

3.1.1 参数说明

字段描述	字段名称	类型	长度	必填	备注
公司代码	COMPANYCD	VARCHAR	3	是
单据申请单号/OMS出库单号	APPLYNO	VARCHAR	35	是
订单类型	APPLYTYPE	VARCHAR	4	是
订单申请日期/OMS出库日期	APPLYYMD	VARCHAR	10	是
商店代码	CUSTOMERCD	VARCHAR	10	是
ShipTo代码	SAP_CUSTOMERCD	VARCHAR	10
客户分类	SALEPATN	VARCHAR	2	是
订单原因	REASONCD	VARCHAR	3
POS区分	CustomerGroup1	VARCHAR	4	是	"Z201 SMILE POS, Z202 PS POS, Z203 E-ORDER, Z204 CS POS, Z205 SCHD, Z206 Others, Z207 OMS, Z208 ONECX"
促销事件	PromotionEvents	VARCHAR	35
文本/OMS平台订单号	TXT_FormHeader	VARCHAR	200
文本/OMS支付日期	TXT_HeaderNote	VARCHAR	200
成本中心	CostCenter	VARCHAR	10
决裁案件番号	imw_matter_number	VARCHAR	20
申请员工工号	EMPCODE	VARCHAR	20
申请员工姓名	EMPNAME	VARCHAR	20
订单来源	orderSource	VARCHAR	500
品牌编码	brandCode	VARCHAR	500
销售平台	channelCode	VARCHAR	500
订单类型	orderType	INT
订单状态	orderStatus	VARCHAR	500
支付方式	payType	VARCHAR	500
支付状态	payStatus	INT
出入库状态	shippedStatus	INT
会员识别号	memberId	VARCHAR	500
店铺名称	shopName	VARCHAR	500
源平台单号	parentPayCode	VARCHAR	500
订单生成时间	orderTime	VARCHAR	500
订单生成时间	payTime	VARCHAR	500
应付金额	amount	VARCHAR	500
修正金额	reviseAmount	VARCHAR	500
销售订单行项目	POSEX	VARCHAR	6	是
物料确定号	DETERMINECODE	VARCHAR	13	是
工厂	PLANT	VARCHAR	4
库位代码	LGORT	VARCHAR	8
订单数量	APPLYQNTY	INT		是
销售金额	actualMNY	number	11
免费品标识	Freegoods	CHAR	1
批次号	CHARG	VARCHAR	10
用途	USECODE	CHAR	3
决裁案件号	DecisionNo	VARCHAR	20
物料编码	prdCode	VARCHAR	500
产品名称	prdName	VARCHAR	500
发货时间	shippedTime	VARCHAR	500
时间戳（当前时间）	Timestamp	datetime	20	是
周边标识	SysFlg	CHAR	1		"由Mule分配的Cliend Id进行转换 1-POS, 2-SCHD, 3-E-order, 4-Shopex, 5-UCO, 6-LeQee, 7-决裁, 8-采购"
积分兑换标识	PointsFlg	CHAR	1		1-积分兑换
不启用最小起订量标识	SDABWFLG	CHAR	1		"1-不启用最小起订量 0或空-启用"

3.1.2 参数示例

注意: 参数体以数组结构一次性接收多条数据。

[
  {
    "COMPANYCD": "785",
    "APPLYNO": "RCXXXXXXXXXXXXXXX",
    "APPLYTYPE": "20",
    "APPLYYMD": "20220428",
    "CUSTOMERCD": "00200001",
    "SAP_CUSTOMERCD": "1000200001",
    "SALEPATN": "K2",
    "REASONCD": "564",
    "CustomerGroup1": "Z202",
    "PromotionEvents": "促销",
    "TXT_FormHeader": "3889942344064221567",
    "TXT_HeaderNote": "20240710",
    "CostCenter": "78599D11A7",
    "imw_matter_number": "0000163791",
    "EMPCODE": "001001",
    "EMPNAME": "Zhang San",
    "orderSource": "商派",
    "brandCode": "TG",
    "channelCode": "wx_ma",
    "orderType": 0,
    "orderStatus": "1",
    "payType": "wx",
    "payStatus": 2,
    "shippedStatus": 2,
    "memberId": "M8489250509",
    "shopName": "THE GINZA小程序店铺",
    "parentPayCode": "3889942344064221567",
    "orderTime": "2024-07-10 10:42:44",
    "payTime": "2024-07-10 10:42:44",
    "amount": "350.00",
    "reviseAmount": "0",
    "POSEX": "10",
    "DETERMINECODE": "730852143449",
    "PLANT": "Plan",
    "LGORT": "W001",
    "APPLYQNTY": 3,
    "actualMNY": 480.00,
    "Freegoods": "1",
    "CHARG": "COMMON",
    "USECODE": "",
    "DecisionNo": "AR028786-001",
    "prdCode": "10100350",
    "prdName": "御银座 宙光奢润面膜 P 试用装(单片)",
    "shippedTime": "2024-07-10 14:51:40",
    "Timestamp": "2024-07-14 16:48:30",
    "SysFlg": "1",
    "PointsFlg": "1",
    "SDABWFLG": "1"
  }
]

3.1.3 返回值说明

字段描述	字段名称	类型	必填	备注
返回状态	status	String	是	"success" 表示成功
数量	count	String	int	上传的数量
唯一标识id	DocumentIDs	array	是	每条数据的唯一标识id

3.1.4 返回值示例

{
    "status": "success",
    "count": 100,
    "DocumentIDs": ["e32df223333sadfewf","e32df223333sadfewf","e32df223333sadfewf"]
}

3.2 订货销售单据上传(pos)

请求接口: /inbound/pos
接口描述: pos订货销售单据上传接口
请求类型: HTTP POST

3.2.1 参数说明

字段描述	字段名称	类型	长度	必填	备注
公司代码	COMPANYCD	VARCHAR	3	是
单据申请单号/OMS出库单号	APPLYNO	VARCHAR	35	是
订单类型	APPLYTYPE	VARCHAR	4	是
订单申请日期/OMS出库日期	APPLYYMD	VARCHAR	10	是
商店代码	CUSTOMERCD	VARCHAR	10	是
ShipTo代码	SAP_CUSTOMERCD	VARCHAR	10
客户分类	SALEPATN	VARCHAR	2	是
订单原因	REASONCD	VARCHAR	3
POS区分	CustomerGroup1	VARCHAR	4	是	"Z201 SMILE POS, Z202 PS POS, Z203 E-ORDER, Z204 CS POS, Z205 SCHD, Z206 Others, Z207 OMS, Z208 ONECX"
促销事件	PromotionEvents	VARCHAR	35
文本/OMS平台订单号	TXT_FormHeader	VARCHAR	200
文本/OMS支付日期	TXT_HeaderNote	VARCHAR	200
成本中心	CostCenter	VARCHAR	10
决裁案件番号	imw_matter_number	VARCHAR	20
申请员工工号	EMPCODE	VARCHAR	20
申请员工姓名	EMPNAME	VARCHAR	20
订单来源	orderSource	VARCHAR	500
品牌编码	brandCode	VARCHAR	500
销售平台	channelCode	VARCHAR	500
订单类型	orderType	INT
订单状态	orderStatus	VARCHAR	500
支付方式	payType	VARCHAR	500
支付状态	payStatus	INT
出入库状态	shippedStatus	INT
会员识别号	memberId	VARCHAR	500
店铺名称	shopName	VARCHAR	500
源平台单号	parentPayCode	VARCHAR	500
订单生成时间	orderTime	VARCHAR	500
订单生成时间	payTime	VARCHAR	500
应付金额	amount	VARCHAR	500
修正金额	reviseAmount	VARCHAR	500
销售订单行项目	POSEX	VARCHAR	6	是
物料确定号	DETERMINECODE	VARCHAR	13	是
工厂	PLANT	VARCHAR	4
库位代码	LGORT	VARCHAR	8
订单数量	APPLYQNTY	INT		是
销售金额	actualMNY	number	11
免费品标识	Freegoods	CHAR	1
批次号	CHARG	VARCHAR	10
用途	USECODE	CHAR	3
决裁案件号	DecisionNo	VARCHAR	20
物料编码	prdCode	VARCHAR	500
产品名称	prdName	VARCHAR	500
发货时间	shippedTime	VARCHAR	500
时间戳（当前时间）	Timestamp	datetime	20	是
周边标识	SysFlg	CHAR	1		"由Mule分配的Cliend Id进行转换 1-POS, 2-SCHD, 3-E-order, 4-Shopex, 5-UCO, 6-LeQee, 7-决裁, 8-采购"
积分兑换标识	PointsFlg	CHAR	1		1-积分兑换
不启用最小起订量标识	SDABWFLG	CHAR	1		"1-不启用最小起订量 0或空-启用"

3.2.2 参数示例

注意: 参数体以数组结构一次性接收多条数据。

[
  {
    "COMPANYCD": "785",
    "APPLYNO": "RCXXXXXXXXXXXXXXX",
    "APPLYTYPE": "20",
    "APPLYYMD": "20220428",
    "CUSTOMERCD": "00200001",
    "SAP_CUSTOMERCD": "1000200001",
    "SALEPATN": "K2",
    "REASONCD": "564",
    "CustomerGroup1": "Z202",
    "PromotionEvents": "促销",
    "TXT_FormHeader": "3889942344064221567",
    "TXT_HeaderNote": "20240710",
    "CostCenter": "78599D11A7",
    "imw_matter_number": "0000163791",
    "EMPCODE": "001001",
    "EMPNAME": "Zhang San",
    "orderSource": "商派",
    "brandCode": "TG",
    "channelCode": "wx_ma",
    "orderType": 0,
    "orderStatus": "1",
    "payType": "wx",
    "payStatus": 2,
    "shippedStatus": 2,
    "memberId": "M8489250509",
    "shopName": "THE GINZA小程序店铺",
    "parentPayCode": "3889942344064221567",
    "orderTime": "2024-07-10 10:42:44",
    "payTime": "2024-07-10 10:42:44",
    "amount": "350.00",
    "reviseAmount": "0",
    "POSEX": "10",
    "DETERMINECODE": "730852143449",
    "PLANT": "Plan",
    "LGORT": "W001",
    "APPLYQNTY": 3,
    "actualMNY": 480.00,
    "Freegoods": "1",
    "CHARG": "COMMON",
    "USECODE": "",
    "DecisionNo": "AR028786-001",
    "prdCode": "10100350",
    "prdName": "御银座 宙光奢润面膜 P 试用装(单片)",
    "shippedTime": "2024-07-10 14:51:40",
    "Timestamp": "2024-07-14 16:48:30",
    "SysFlg": "1",
    "PointsFlg": "1",
    "SDABWFLG": "1"
  }
]

3.2.3 返回值说明

字段描述	字段名称	类型	必填	备注
返回状态	status	String	是	"success" 表示成功
数量	count	String	int	上传的数量
唯一标识id	DocumentIDs	array	是	每条数据的唯一标识id

3.2.4 返回值示例

{
    "status": "success",
    "count": 100,
    "DocumentIDs": ["e32df223333sadfewf","e32df223333sadfewf","e32df223333sadfewf"]
}

3.3 采购订单上传

请求接口: /inbound/purchase
接口描述: 采购订单上传
请求类型: HTTP POST

3.3.1 参数说明

字段描述	字段名称	类型	长度	必填
公司代码	CoCode	VARCHAR	4	是
订单类型	APPLYTYPE	VARCHAR	4	是
订单类型	OrderType	VARCHAR	4	是
创建日期	CreateDate	VARCHAR	8	是
创建者	CreateBy	VARCHAR	12	是
SAP供应商编号	Vendor	VARCHAR	10	是
Language Key语言	Language	VARCHAR	1	是
采购组织	PurOrg	VARCHAR	4	是
采购组	PurGrp	VARCHAR	3	是
币种	Currency	VARCHAR	5	是
下单日期	DOC_DATE	VARCHAR	8	是
我们的参考	Reference	VARCHAR	12	是
采购订单明细编号	ItemNo	VARCHAR	5	是
短文本	ShortText	VARCHAR	40
SAP商品编号	ItemCode	VARCHAR	18	是
工厂	Plant	VARCHAR	4	是
库位	STGE_LOC	VARCHAR	4	是
采购订单编号	NPSPONo	VARCHAR	10	是
物料组	MaterialGroup	VARCHAR	9	是
数量	Quantity	INT	13	是
订单单位	PO_UNIT	VARCHAR	3	是
税代码	TAX_CODE	VARCHAR	2	是
科目分配类别	ACCTASSCAT	VARCHAR	1
免费货特殊标识	Free	VARCHAR	1
确认控制码	ControlKey	VARCHAR	4
退货标识	Return	VARCHAR	1
申请人	Requester	VARCHAR	12	是
内部订单	Internalorder	VARCHAR	18
总账科目	GL_ACCOUNT	VARCHAR	10
单价	Netprice	VARCHAR	11	是
价格单位	PRICE_UNIT	VARCHAR	5	是
交货日期	DeliveryDate	DATS	8	是
预算单价	POINTS	number		是
时间戳（当前时间）	Timestamp	datetime	20	是

3.3.2 参数示例

注意: 参数体以数组结构一次性接收多条数据。

[
  {
        "CoCode": "785",
        "APPLYTYPE": "14",
        "OrderType": "Z4NB",
        "CreateDate": "20240618",
        "CreateBy": "30018426",
        "Vendor": "2100003028",
        "Language": "1",
        "PurOrg": "2001",
        "PurGrp": "220",
        "Currency": "CNY",
        "DOC_DATE": "20240619",
        "Reference": "INTRAMART",
        "ItemNo": "00010",
        "ShortText": "",
        "ItemCode": "78704995101",
        "Plant": "785V",
        "STGE_LOC": "H001",
        "NPSPONo": "PO2406163",
        "MaterialGroup": "",
        "Quantity": 150,
        "PO_UNIT": "EA",
        "TAX_CODE": "J1",
        "ACCTASSCAT": "",
        "Free": "",
        "ControlKey": "",
        "Return": "",
        "Requester": "30018426",
        "Internalorder": "",
        "GL_ACCOUNT": "",
        "Netprice": "4.28",
        "PRICE_UNIT": "1",
        "DeliveryDate": "20240708",
        "POINTS": 4.47,
        "Timestamp": "2024-07-14 16:48:30.710"
    }
]

3.3.3 返回值说明

字段描述	字段名称	类型	必填	备注
返回状态	status	String	是	"success" 表示成功
数量	count	String	int	上传的数量
唯一标识id	DocumentIDs	array	是	每条数据的唯一标识id

3.3.4 返回值示例

{
    "status": "success",
    "count": 100,
    "DocumentIDs": ["e32df223333sadfewf","e32df223333sadfewf","e32df223333sadfewf"]
}

schm-inbound-sap-eapi

1.身份认证

2.接口总览:

3.接口调用说明

3.1 订货销售单据上传(oms)

3.1.1 参数说明

3.1.2 参数示例

3.1.3 返回值说明

3.1.4 返回值示例

3.2 订货销售单据上传(pos)

3.2.1 参数说明

3.2.2 参数示例

3.2.3 返回值说明

3.2.4 返回值示例

3.3 采购订单上传

3.3.1 参数说明

3.3.2 参数示例

3.3.3 返回值说明

3.3.4 返回值示例

Reviews