schm-outbound-sap-eapi
home
schm-outbound-sap-eapi
接口描述: 对账平台查询单据（Inprogress，revise）接口
DEV地址（开发环境）: https://schm-api-dev.shiseido.cn/schm-outbound-sap-eapi
UAT地址（测试环境）: https://schm-api-test.shiseido.cn/schm-outbound-sap-eapi
PROD地址（生产环境）: https://schm-api.shiseido.cn/schm-outbound-sap-eapi
1.身份认证
所有请求头必须包含以下键值参数作为身份验证信息。您需要向管理员申请这些信息。
client_id: fa98****3452
client_secret: 108b****41f2
注意:
生产环境和测试环境的认证方式不同，在生产环境中，需要使用之前注册的账号，登录后，点击对应的应用上线，就会出现生产使用的client_id和client_secret。
2.检查连通性:
可以通过curl命令或者接口工具调用/healthCheck检查接口连通性，成功则返回ok，检查地址如下：
DEV地址（开发环境）: https://schm-api-dev.shiseido.cn/schm-outbound-sap-eapi/healthCheck
UAT地址（测试环境）: https://schm-api-test.shiseido.cn/schm-outbound-sap-eapi/healthCheck
PROD地址（生产环境）: https://schm-api.shiseido.cn/schm-outbound-sap-eapi/healthCheck
3.接口总览:
| 请求接口 | 描述 |
|---|---|
| /inprogress/query | ToC 进行中销售单查询（对账用） |
| /revise/query | ToC 金额修正单查询（对账用） |
完整调用地址为对应环境地址+接口地址，例如：
https://schm-api-test.shiseido.cn/schm-outbound-sap-eapi/revise/query
4.接口调用说明
4.1 ToC 进行中销售单查询（对账用）
请求接口: /inprogress/query
接口描述: ToC 进行中销售单查询（对账用）
请求类型: HTTP GET
4.1.1 参数说明
| 字段名称 | 必填 | 字段描述 |
|---|---|---|
| pageSize | N | 按分页获取数据，每页显示数据条目，不传参数默认为50条。 |
| pageNo | N | 按分页获取数据，当前页码。分页从1开始（1为初始页），不传参数默认是第1页。 |
| totalFlg | N | 总数返回标识，控制是否返回totalPages、totalRecords参数，boolean类型，true，false，默认为false不返回。 |
| brandCode | N | 品牌编码 |
| txtFormHeader | N | 平台销售单号（商户订单号） |
| timestamp | N | 2023-09-15 18:06:32.447，筛选此时间之后（包括此时间）的数据，支持yyyy-MM-dd，也可以是yyyy-MM-dd HH:mm:ss |
接口请求示例：
/inprogress/query?timestamp=2024-08-16T17:15:44&pageSize=4&pageNo=3&totalFlg=true
返回参数
| 字段描述 | 字段名称 | 类型 | 长度 | 必填 | 备注 |
|---|---|---|---|---|---|
| 当前页码 | pageNo | INT | 是 | ||
| 每页显示数据条目 | pageSize | INT | 是 | ||
| 总页数 | totalPages | INT | 否 | 根据totalFlg标识返回，为true则返回 | |
| 总条目数 | totalRecords | INT | 否 | 根据totalFlg标识返回，为true则返回 | |
| 分页数据 | data | array | 是 |
data
| 字段描述 | 字段名称 | 类型 | 长度 | 必填 | 备注 |
|---|---|---|---|---|---|
| id | ID | INT | 是 | ||
| 单据唯一标识 | DocumentID | VARCHAR | 60 | 是 | |
| 订单来源 | orderSource | VARCHAR | 500 | 是 | POS |
| 品牌编码 | brandCode | VARCHAR | 500 | 是 | 品牌编码，仅接收如下编码：CPB、EFM、IPSA、NARS、TG、SDK、SHI、PCV、LM、BAUM |
| 销售平台 | channelCode | VARCHAR | 500 | 是 | web：官网 wx_ma：微信小程序 wx_video：微信视频号 tmall：天猫 tiktok：抖音 小红书：xhs |
| 平台销售单号（商户订单号） | TXT_FormHeader | VARCHAR | 200 | 是 | |
| 订单生成时间 | orderTime | VARCHAR | 500 | 是 | |
| 订单付款时间 | TXT_HeaderNote | VARCHAR | 200 | ||
| 付款金额 | payAmount | VARCHAR | 500 | 是 | |
| 退款金额 | refundAmount | VARCHAR | 500 | 是 | |
| 运费 | freight | VARCHAR | 500 | ||
| 交易状态 | transactionStatus | INT | 是 | 基础： 1. 交易完成 2. 交易关闭 3. 未付款（订单创建） 4. 已付款（已付款未发货） 9. 未知 天猫： 10. 交易完成（交易成功） 11. 交易关闭（付款以后用户退款成功） 12. 没有创建支付宝交易 13. 等待买家付款 14. 卖家部分发货 15. 等待卖家发货（买家已付款） 16. 等待买家确认收货（卖家已发货） 17. 买家已签收（货到付款专用） 18. 付款以前，卖家或买家主动关闭交易 21. 定金未付尾款未付 22. 定金已付尾款未付 23. 定金和尾款都付 24. 预售定金罚没 抖音： 40. 交易完成后（已完成-已收货） 41. 交易关闭（已取消） 42. 订单创建完毕 43. 已支付 44. 备货中 45. 部分发货 46. 已发货（全部发货） | |
| 推送状态 | pushStatus | INT | 是 | 1. 已推送，指已经推送到S4的单据。 2. 未推送，是指应该推送暂时还未推送到S4的单据。 3. 不用推送，不用推送到S4的单据。 | |
| 时间戳（当前时间） | Timestamp | VARCHAR | 20 | 是 | 同一单的时间戳相同：2024-08-26 00:00:00.00 |
4.1.2 返回参数示例
{
"pageNo": 1,
"pageSize": 4,
"totalPages": 4,
"totalRecords": 15,
"data": [
{
"ID": 1,
"DocumentID": "d1634210-53d4-11ef-b739-36ac293352b8",
"orderSource": "UCO",
"brandCode": "CPB",
"channelCode": "tmall",
"TXT_FormHeader": "3889942344064221567",
"orderTime": "2024-07-10 10:42:44",
"TXT_HeaderNote": "3425027475214591645",
"payAmount": "350.00",
"refundAmount": "0",
"freight": "0.00",
"transactionStatus": 15,
"pushStatus": 2,
"Timestamp": "2024-08-26T12:06:12"
},
{
"ID": 2,
"DocumentID": "d1634210-53d4-11ef-b739-36ac293352b8",
"orderSource": "UCO",
"brandCode": "CPB",
"channelCode": "tmall",
"TXT_FormHeader": "3889942344064221567",
"orderTime": "2024-07-10 10:42:44",
"TXT_HeaderNote": "3425027475214591645",
"payAmount": "350.00",
"refundAmount": "0",
"freight": "0.00",
"transactionStatus": 15,
"pushStatus": 2,
"Timestamp": "2024-08-26T12:06:13"
},
{
"ID": 3,
"DocumentID": "d1634210-53d4-11ef-b739-36ac293352b8",
"orderSource": "UCO",
"brandCode": "CPB",
"channelCode": "tmall",
"TXT_FormHeader": "3889942344064221567",
"orderTime": "2024-07-10 10:42:44",
"TXT_HeaderNote": "3425027475214591645",
"payAmount": "350.00",
"refundAmount": "0",
"freight": "0.00",
"transactionStatus": 15,
"pushStatus": 2,
"Timestamp": "2024-08-26T12:06:14"
},
{
"ID": 4,
"DocumentID": "d1634210-53d4-11ef-b739-36ac293352b8",
"orderSource": "UCO",
"brandCode": "CPB",
"channelCode": "tmall",
"TXT_FormHeader": "3889942344064221567",
"orderTime": "2024-07-10 10:42:44",
"TXT_HeaderNote": "3425027475214591645",
"payAmount": "350.00",
"refundAmount": "0",
"freight": "0.00",
"transactionStatus": 15,
"pushStatus": 2,
"Timestamp": "2024-08-26T12:06:15"
}
]
}4.2 ToC 金额修正单查询（对账用）
请求接口: /revise/query
接口描述: ToC 金额修正单查询（对账用）
请求类型: HTTP GET
4.2.1 参数说明
| 字段名称 | 必填 | 字段描述 |
|---|---|---|
| pageSize | N | 按分页获取数据，每页显示数据条目，不传参数默认为50条。 |
| pageNo | N | 按分页获取数据，当前页码。分页从1开始（1为初始页），不传参数默认是第1页。 |
| applyNo | N | 单据编号 |
| applyType | N | 业务类型 |
| txtFormHeader | N | 文本/OMS平台订单号 |
| timestamp | N | 2023-09-15 18:06:32.447，筛选此时间之后（包括此时间）的数据，支持yyyy-MM-dd，也可以是yyyy-MM-dd HH:mm:ss |
接口请求示例：
/revise/query?timestamp=2024-08-16T17:15:44&pageSize=4&pageNo=3
返回参数
| 字段描述 | 字段名称 | 类型 | 长度 | 必填 | 备注 |
|---|---|---|---|---|---|
| 当前页码 | pageNo | INT | 是 | ||
| 每页显示数据条目 | pageSize | INT | 是 | ||
| 总页数 | totalPages | INT | 是 | ||
| 总条目数 | totalRecords | INT | 是 | ||
| 分页数据 | data | array | 是 |
data
| 字段描述 | 字段名称 | 类型 | 长度 | 必填 | 备注 |
|---|---|---|---|---|---|
| id | ID_KEY | INT | 是 | ||
| 单据唯一标识 | DocumentID | VARCHAR | 60 | 是 | |
| 订单来源 | orderSource | VARCHAR | 500 | 是 | POS |
| 品牌编码 | brandCode | VARCHAR | 500 | 是 | 品牌编码，仅接收如下编码： CPB、EFM、IPSA、NARS、TG、SDK、SHI、PCV、LM、BAUM |
| 销售平台 | channelCode | VARCHAR | 500 | 是 | web：官网 wx_ma：微信小程序 wx_video：微信视频号 tmall：天猫 tiktok：抖音 小红书：xhs |
| revise | ID | VARCHAR | 100 | ||
| 单据编号 | APPLYNO | char | 35 | 是 | POS 单号、OMS 出库单号 |
| 业务类型 | APPLYTYPE | char | 3 | 是 | 10补货到门店 11退货到公司 20门店销售 21门店退货 30免费销售单 31免费单退货 |
| 订单类型 | orderType | INT | 是 | 固定值：11 | |
| 商店代码 | CUSTOMERCD | char | 10 | 是 | 周边商店代码 |
| SAP Shipto代码 | SAP_CUSTOMERCD | char | 10 | 是 | 店铺编码 |
| 文本/OMS平台订单号 | TXT_FormHeader | VARCHAR | 200 | 是 | POS传 支付订单号 |
| 修正金额 | reviseAmount | VARCHAR | 500 | 是 | |
| 修正金额的时间 | reviseTime | VARCHAR | 100 | 是 | 修正金额的时间，格式 yyyy-MM-dd hh:mm:ss |
| 订单原因（Head） | REASONCD | char | 3 | 是 | 1：物料修正 2：订单修正 说明： 1.对物料金额进行修正，要修正的订单中必须包含此物料； 2.对订单总金额进行修正，物料需要使用运费修正。 |
| 物料编码 | prdCode | VARCHAR | 500 | 是 | 物料编码 |
| 物料确定号 | DETERMINECODE | char | 13 | 是 | 物料确定号 |
| 产品名称 | prdName | VARCHAR | 500 | 是 | 产品名称 |
| 修正金额 | reviseAmount_ITEM | VARCHAR | 500 | 是 | 物料修正金额，区分正负值，按实际情况填写 |
| 时间戳（当前时间） | Timestamp | datetime | 20 | 是 | 同一单的时间戳相同：2024-08-26 00:00:00.00 |
4.2.2 参数示例
{
"pageNo": 2,
"pageSize": 2,
"totalPages": 3,
"totalRecords": 6,
"data": [
{
"ID_KEY": 1,
"DocumentID": "d163421053d411efb73936ac293352b8",
"orderSource": "UCO",
"brandCode": "CPB",
"channelCode": "tmall",
"ID": "1806847913",
"APPLYNO": "1908083850",
"APPLYTYPE": "20",
"orderType": 11,
"CUSTOMERCD": "31400000",
"SAP_CUSTOMERCD": "2200003902",
"TXT_FormHeader": "3889942344064221567",
"reviseAmount": "-50.00",
"reviseTime": "2024-04-05 09:47:13",
"REASONCD": "2",
"prdCode": "300000290",
"DETERMINECODE": "300000290",
"prdName": "NARS 官网运费",
"reviseAmount_ITEM": "-50",
"Timestamp": "2024-09-29T17:15:46"
},
{
"ID_KEY": 2,
"DocumentID": "d163421053d411efb73936ac293652b8",
"orderSource": "UCO",
"brandCode": "CPB",
"channelCode": "tmall",
"ID": "1806847913",
"APPLYNO": "1908083850",
"APPLYTYPE": "20",
"orderType": 11,
"CUSTOMERCD": "31400000",
"SAP_CUSTOMERCD": "2200003902",
"TXT_FormHeader": "3889942344064221567",
"reviseAmount": "-50.00",
"reviseTime": "2024-04-05 09:47:13",
"REASONCD": "2",
"prdCode": "300000290",
"DETERMINECODE": "300000290",
"prdName": "NARS 官网运费",
"reviseAmount_ITEM": "-50",
"Timestamp": "2024-09-29T17:15:47"
}
]
}