schm-sap-outbound-eapi
home
schm-sap-outbound-eapi
API Description: External API for querying business documents.
DEV Environment URL: https://schm-api-dev.shiseido.cn/schm-sap-outbound-eapi/api/v1
UAT Environment URL: https://schm-api-test.shiseido.cn/schm-sap-outbound-eapi/api/v1
PROD Environment URL: https://schm-api.shiseido.cn/schm-sap-outbound-eapi/api/v1
1. Authentication
All request headers must include the following key-value parameters as authentication information. You need to contact the administrator to obtain these details.
client_id: fa98****3452
client_secret: 108b****41f2
notice:
Authentication for production and test environments is different, in the production environment, you need to use the previously registered account. After logging in, click the corresponding application to go online, and then the client_id and client_secret used in production will appear.
2.Check connectivity:
You can run the curl command or the interface tool to call /healthCheck to check the interface connectivity. If the interface succeeds, ok is returned. The check address is as follows:
DEV Environment URL: https://schm-api-dev.shiseido.cn/schm-sap-outbound-eapi/healthCheck
UAT Environment URL: https://schm-api-test.shiseido.cn/schm-sap-outbound-eapi/healthCheck
PROD Environment URL: https://schm-api.shiseido.cn/schm-sap-outbound-eapi/healthCheck
3. API Overview:
| Endpoint | Description |
|---|---|
| /outBound/getBusinessMain | SAP 2B Inbound/Outbound Main Table Query (New Table) |
| /outBound/getBusinessSub | SAP 2B Inbound/Outbound Sub Table Query (New Table) |
| /outBound/getOrder | SAP 2B Inbound Orders (Old Table) |
| /outBound/getRtnSale | SAP 2B Return Outbound Orders (Old Table) |
| /outBound/getNewBusiness | SAP 2B Adjustment Orders (Old Table) |
| /outBound/getStockMvmtGR | SAP Purchase Order Reversal Query |
| /outBound/getBusinessSubOMS | ToC Sales Order Details Query (For Reconciliation) |
| /outBound/getBillingDataPool | SAP Billing Document Query |
| /outBound/getBillingCounteract | SAP Billing Counteraction Document Query |
| /outBound/getCoupoChargePlatform | POS Loan Payment Method Query |
The complete API endpoint is constructed by appending the endpoint path to the corresponding environment URL, for example:
https://schm-api-test.shiseido.cn/schm-sap-outbound-eapi/api/v1/outBound/getBusinessMain
4. API Call Details
4.1 SAP 2B Inbound/Outbound Main Table Query (New Table)
Endpoint: /api/v1/outBound/getBusinessMain
Description: SAP 2B Inbound/Outbound Main Table Query (New Table)
Request Method: HTTP GET
4.1.1 Request Parameters
| Field Description | Field Name | Type | Length | Required | Notes |
|---|---|---|---|---|---|
| Entries per page | pageSize | INT | Optional | Retrieve data by page, number of entries per page. Default is 50 if not provided. | |
| Page number | pageNo | INT | Optional | Retrieve data by page, current page number. Pagination starts at 1. Default is 1 if not provided. | |
| Document number | applyNo | VARCHAR | Optional | Example: 1504575834 | |
| Business type | businessType | VARCHAR | Optional | Example: 10 | |
| Store code | customerCd | VARCHAR | Optional | Example: 10200184 | |
| SAP Shipto code | sapCustomerCd | VARCHAR | Optional | Example: 2200003451 | |
| POS distinction | customerGroup1 | VARCHAR | Optional | Example: Z202 | |
| SAP order code | sapOrderNo | VARCHAR | Optional | Example: 4203193399 | |
| Status | status | VARCHAR | Optional | Example: 3 | |
| SAP order type | sapApplyType | VARCHAR | Optional | Example: Z4OR | |
| Update time | updateTime | datetime | Optional | Retrieve data updated after (including) this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 |
Request example:/api/v1/outBound/getBusinessMain?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49
4.1.2 Response Parameters
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Response status | status | String | Yes | "success" indicates success, "error" indicates failure |
| Current page number | pageNo | INT | Yes | |
| Entries per page | pageSize | INT | Yes | |
| Total pages | totalPages | INT | Yes | |
| Total records | totalRecords | INT | Yes | |
| Data | data | array | Yes | Data retrieved from the query |
| Error message | message | String | No | Returned when status is "error", providing details about the error |
Data Structure
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Company code | COMPANYCD | char | Example: 785 | |
| Document number | APPLYNO | char | Example: 1504575834 | |
| Application date | BusinessType | char | Example: 32 | |
| Store code | CUSTOMERCD | char | Example: 00100184 | |
| SAP Shipto code | SAP_CUSTOMERCD | char | Example: 2200003152 | |
| Customer classification | SALEPATN | char | Example: K1-Distributor, K2-Agent, FS-Direct | |
| POS distinction | CustomerGroup1 | char | Example values: Z201 SMILE POS Z202 PS POS Z203 E-ORDER Z204 CS POS Z205 SCHD Z206 OTHERS Z207 OMS Z208 ONECX | |
| Application date | APPLYYMD | datetime | Example: 2022-12-12 00:00:00.000 | |
| Confirmation date | AdMinYmd | datetime | Example: 2022-12-27 13:40:15.000 | |
| Outbound date | OUTSTCYMD | datetime | Example: NULL | |
| SAP order code | SAPORDERNO | char | Example: 4202451650 | |
| SAP order type | SAPAPPLYTYPE | char | Example: Z4IO | |
| Status | STATUS | char | Example values: 1-Application, 2-Confirmation, 3-Outbound, 4-Arrival Confirmation | |
| Interface flag | IFFlg | char | Example: 0, for EAI use | |
| Update time | UPDATETIME | datetime | Example: 2023-03-14 17:11:15.337 | |
| Updated by | UPDATEMAN | char | Example: SAP | |
| Created by | CREATEMAN | Char | ||
| Creation time | CREATETIME | datetime |
4.1.3 Response Examples
Success:
{
"status": "success",
"pageNo": 1,
"pageSize": 2,
"totalPages": 1,
"totalRecords": 2,
"data": [
{
"COMPANYCD": "785",
"APPLYNO": "RC103001232024703 ",
"BusinessType": "10 ",
"CUSTOMERCD": "10300123 ",
"SAP_CUSTOMERCD": "2200003606",
"SALEPATN": "K1",
"CustomerGroup1": "Z202",
"APPLYYMD": "2024-07-05T00:00:00",
"AdMinYmd": "2024-07-21T23:37:14",
"OUTSTCYMD": "2024-07-22T00:00:00",
"SAPORDERNO": "4204409917 ",
"SAPAPPLYTYPE": "Z4OR",
"STATUS": "3",
"IFFlg": "0",
"UPDATETIME": "2024-07-23T16:00:32.33",
"UPDATEMAN": "SAP ",
"CREATEMAN": "SAP ",
"CREATETIME": "2024-07-22T12:01:19.647"
},
{
"COMPANYCD": "785",
"APPLYNO": "RC103001232024703 ",
"BusinessType": "12 ",
"CUSTOMERCD": "10300123 ",
"SAP_CUSTOMERCD": "2200003606",
"SALEPATN": "K1",
"CustomerGroup1": "Z202",
"APPLYYMD": "2024-07-05T00:00:00",
"AdMinYmd": "2024-07-21T23:37:14",
"OUTSTCYMD": "2024-07-22T00:00:00",
"SAPORDERNO": "4204409917-POD ",
"SAPAPPLYTYPE": "Z4OR",
"STATUS": "3",
"IFFlg": "0",
"UPDATETIME": "2024-07-23T16:00:32.453",
"UPDATEMAN": "SAP ",
"CREATEMAN": "SAP ",
"CREATETIME": "2024-07-23T16:00:47.413"
}
]
}
Error:
{
"status": "error",
"message": ""
}4.2 SAP Issuance of 2B Inbound/Outbound Subtable Query (New Table)
Request Endpoint: /api/v1/outBound/getBusinessSub
Description: SAP Issuance of 2B Inbound/Outbound Subtable Query (New Table)
Request Type: HTTP GET
4.2.1 Request Parameters
| Field Description | Field Name | Type | Length | Required | Notes |
|---|---|---|---|---|---|
| Page Size | pageSize | INT | No | Retrieves data by pagination. Default value is 50 if not specified. | |
| Page Number | pageNo | INT | No | Retrieves data by pagination, current page number. Starts from 1. Default value is 1 if not specified. | |
| Document Number | applyNo | VARCHAR | No | Example: 1504575834 | |
| Application Date | applyYmd | datetime | No | Filters data after (and including) this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 | |
| Business Type | businessType | VARCHAR | No | Example: 10 | |
| Store Code | customerCd | VARCHAR | No | Example: 10200184 | |
| SAP Shipto Code | sapCustomerCd | VARCHAR | No | Example: 2200003451 | |
| POS Distinction | customerGroup1 | VARCHAR | No | Example: Z202 | |
| SAP Order Number | sapOrderNo | VARCHAR | No | Example: 4203193399 | |
| Customer Category | salePatn | VARCHAR | No | Example: 4203193399 | |
| Status | status | VARCHAR | No | Example: 3 | |
| SAP Order Type | sapApplyType | VARCHAR | No | Example: Z4OR | |
| Delivery Number (Inbound/Outbound) | deliveryNo | VARCHAR | No | Example: 4402988335 | |
| Material Determination Number | determineCode | VARCHAR | No | Example: 4402988335 | |
| SAP STO Number | applyNoSto | VARCHAR | No | Example: 4402988335 | |
| Update Time | updateTime | datetime | No | Filters updated data after (and including) this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 |
Example request:/api/v1/outBound/getBusinessSub?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49
4.2.2 Response Parameters
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Status | status | String | Yes | "success" indicates success, "error" indicates failure |
| Current Page Number | pageNo | INT | Yes | |
| Records per Page | pageSize | INT | Yes | |
| Total Pages | totalPages | INT | Yes | |
| Total Records | totalRecords | INT | Yes | |
| Data | data | array | Yes | Retrieved data |
| Error Message | message | String | No | Returned when status is "error". |
data
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Company Code | COMPANYCD | char | ||
| Document Number | APPLYNO | char | "POS/SCHD/E-ORDER Document No." | |
| Application Date | APPLYYMD | datetime | ||
| Business Type | BusinessType | char | "10 Replenishment to store 11 Return to company 20 Store sales 21 Store return 30 Free sales order 31 Free return order" | |
| Order Reason (Head) | REASONCD | char | "① Only for free orders and returns; not required for others. ② Free orders are uploaded to OMS only." | |
| Order Reason Description | ReasonDes | char | ||
| POS Distinction | CustomerGroup1 | char | "POS Distinction Z201 SMILE POS Z202 PS POS Z203 E-ORDER Z204 CS POS Z205 SCHD Z206 OTHERS Z207 OMS Z208 ONECX" | |
| Sold-to Party Code | SOLDTOCODE | char | ||
| Store Code | CUSTOMERCD | char | Peripheral store code | |
| SAP Shipto Code | SAP_CUSTOMERCD | char | ||
| Customer Classification | SALEPATN | char | "K1-Distribution K2-Consignment FS-Direct sale" | |
| Requested Delivery Date | RequestedDate | datetime | ||
| Promotion Events | PromotionEvents | char | ||
| Remarks (Link POS) | headerTXT | char | Additional textual information | |
| Remarks (Link WMS) | headerNote | char | Delivery information; can be passed to WMS | |
| SAP Sales Order Number | SAPORDERNO | char | ||
| SAP Order Type | SAPAPPLYTYPE | char | ||
| Delivery Number (Inbound/Outbound) | DeliveryNO | char | ||
| Delivery Type (Inbound/Outbound) | DeliveryType | char | ||
| Delivery Date (Inbound/Outbound) | INOUTSTCYMD | datetime | ||
| App Order Number | APP_OrderNo | char | OMS-specific | |
| Payment Date | PayDate | datetime | OMS-specific | |
| Summary Number | DailySummaryNo | char | OMS post-aggregation document number | |
| External Store Code | ExCUSTOMERCD | char | ||
| Vendor Code | SAP_VENDORCODE | char | ||
| Vendor Name | SAP_VENDORNAME | char | ||
| Currency | CURCY | char | ||
| Order Line Item | POSEX | char | ||
| Delivery Note Line Item | COSNR | char | ||
| Product Code | PRODUCTCD | char | Peripheral 8-digit product code | |
| SAP Product Code | SAPPRODUCTCD | char | ||
| Material Determination Code | DETERMINECODE | char | ||
| Material Description | DESCRIBE | char | ||
| Batch | CHARG | char | ||
| Expiry Date | ExpiryDate | datetime | ||
| Requested Quantity | APPLYRQNTY | int | ||
| Free Goods Indicator | Freegoods | char | ||
| Reason for Rejection (ITEM) | RejectReason | char | ||
| Item Description | ItemDEC | char | ||
| Plant | Plant | char | ||
| Storage Location Code | LGORT | char | ||
| Order Net Value | NETVALUE | money | Total price excluding tax for line items | |
| Confirmed Quantity | ADMQNTY | int | ||
| Confirmation Date | AdMinYmd | datetime | ||
| Retail Unit Price | RPRICEMNY | money | ||
| Retail Amount | RETAILMNY | money | ||
| Wholesale Unit Price (Tax Included) | WPRICEMNY | money | "Actual sales price for FSS/OMS sales" | |
| Wholesale Amount (Tax Included) | WHOLEMNY | money | ||
| Unit Price (Excluding Tax) | UPRICEMNY | money | ||
| Unit Amount (Excluding Tax) | UNITMNY | money | ||
| Tax Rate | TaxPrice | int | ||
| Tax Amount | TaxAmount | money | ||
| Return Price | ReturnPrice | money | ||
| Return Amount | ReturnAmount | money | ||
| Unit of Measure (UoM) | MEINS | char | ||
| Inbound/Outbound Quantity | INOUTSTCNum | int | ||
| Sales Notes | NOTE | nvarchar | Order notes in delivery document | |
| Update Time | UPDATETIME | datetime | ||
| Updated By | UPDATEMAN | char | ||
| Status | STATUS | char | "1-Application 2-Confirmation 3-Outbound 4-Arrival Confirmation" | |
| Interface Run Flag | IFFlg | char | Used by EAI | |
| SAP STO Number | APPLYNO_STO | char | ||
| Replenishment/Return Flag | SaleRtnflg | char | "S: Replenishment/POD Overdelivery R: Return Warehouse/POD Underdelivery" | |
| Created By | CREATEMAN | char | ||
| Creation Time | CREATETIME | datetime | ||
| Material Type Identifier | PRODTYPE | char | "1: Service Material 0: Non-Service Material" | |
| Invoice Flag | BillingFlg | char | 1: Invoiced | |
| Reconciliation Platform Transmission Flag | CHECKPLATFLG | char | Used by EAI | |
| Usage | USECODE | char | ||
| Decision Case Number | DecisionNo | varchar | ||
| Cost Center | CostCenter | char | ||
| Special Order Quantity Flag | SDABW | char | For order reason 519 (physical returns), SAP order type Z4OR, and storage location W001, this flag is set by EAI to Z002. | |
| Sales Organization | SAP_SALESORGANIZATION | char | ||
| Decision Case Number | imw_matter_number | varchar | ||
| Brand | BRAND | char | For aggregation | |
| Applicant Employee ID | EMPCODE | varchar | For decisions | |
| Applicant Name | EMPNAME | varchar | For decisions | |
| Disable Minimum Order Quantity Flag | SDABWFLG | char | "1-Disable Minimum Order Quantity 0 or Empty-Enable" | |
| IO Number | IONum | varchar |
4.2.3 Example Responses
Success:
{
"status": "success",
"pageNo": 1,
"pageSize": 2,
"totalPages": 1,
"totalRecords": 2,
"data": [
{
"COMPANYCD": "785",
"APPLYNO": "RC103001232024704 ",
"APPLYYMD": "2024-07-05T00:00:00",
"BusinessType": "10 ",
"REASONCD": null,
"ReasonDes": null,
"CustomerGroup1": "Z202",
"SOLDTOCODE": "2100002874",
"CUSTOMERCD": "10300123 ",
"SAP_CUSTOMERCD": "2200003606",
"SALEPATN": "K1",
"RequestedDate": "2024-07-05T00:00:00",
"PromotionEvents": null,
"headerTXT": null,
"headerNote": null,
"SAPORDERNO": "4204409918 ",
"SAPAPPLYTYPE": "Z4OR",
"DeliveryNO": "4405007820",
"DeliveryType": "Z4LF",
"INOUTSTCYMD": "2024-07-22T00:00:00",
"APP_OrderNo": null,
"PayDate": null,
"DailySummaryNo": null,
"ExCUSTOMERCD": null,
"SAP_VENDORCODE": null,
"SAP_VENDORNAME": null,
"CURCY": "CNY",
"POSEX": "000011",
"COSNR": "000010",
"PRODUCTCD": "78700787 ",
"SAPPRODUCTCD": "78700787101 ",
"DETERMINECODE": "78700787101 ",
"DESCRIBE": null,
"CHARG": "COMMON ",
"ExpiryDate": "2027-07-10T00:00:00",
"APPLYRQNTY": 1,
"Freegoods": "0",
"RejectReason": null,
"ItemDEC": null,
"Plant": "7857",
"LGORT": "W001 ",
"NETVALUE": 849.56,
"ADMQNTY": 1,
"AdMinYmd": "2024-07-21T23:37:19",
"RPRICEMNY": 1280,
"RETAILMNY": 1280,
"WPRICEMNY": 960,
"WHOLEMNY": 960,
"UPRICEMNY": 849.56,
"UNITMNY": 849.56,
"TaxPrice": 13,
"TaxAmount": 110.44,
"ReturnPrice": null,
"ReturnAmount": null,
"MEINS": "EA ",
"INOUTSTCNum": 1,
"NOTE": null,
"UPDATETIME": "2024-07-23T16:00:32.233",
"UPDATEMAN": "SAP ",
"STATUS": "3",
"IFFlg": "0",
"APPLYNO_STO": null,
"SaleRtnflg": "S",
"CREATEMAN": "SAP ",
"CREATETIME": "2024-07-22T14:00:50.107",
"PRODTYPE": null,
"BillingFlg": null,
"CHECKPLATFLG": null,
"USECODE": null,
"DecisionNo": null,
"CostCenter": null,
"SDABW": null,
"SAP_SALESORGANIZATION": null,
"imw_matter_number": null,
"BRAND": null,
"EMPCODE": null,
"EMPNAME": null,
"SDABWFLG": null,
"IONum": null
},
{
"COMPANYCD": "785",
"APPLYNO": "MV103000782024703 ",
"APPLYYMD": "2024-07-19T00:00:00",
"BusinessType": "10 ",
"REASONCD": null,
"ReasonDes": null,
"CustomerGroup1": "Z202",
"SOLDTOCODE": "2100002780",
"CUSTOMERCD": "10300078 ",
"SAP_CUSTOMERCD": "2200003565",
"SALEPATN": "K2",
"RequestedDate": null,
"PromotionEvents": null,
"headerTXT": null,
"headerNote": null,
"SAPORDERNO": "4101636263 ",
"SAPAPPLYTYPE": "Z4KB",
"DeliveryNO": "4405007817",
"DeliveryType": "Z4LF",
"INOUTSTCYMD": "2024-07-22T00:00:00",
"APP_OrderNo": null,
"PayDate": null,
"DailySummaryNo": null,
"ExCUSTOMERCD": null,
"SAP_VENDORCODE": null,
"SAP_VENDORNAME": null,
"CURCY": null,
"POSEX": "000011",
"COSNR": "000010",
"PRODUCTCD": "78700786 ",
"SAPPRODUCTCD": "78700786101 ",
"DETERMINECODE": "78700786101 ",
"DESCRIBE": null,
"CHARG": "COMMON ",
"ExpiryDate": "2027-07-10T00:00:00",
"APPLYRQNTY": 3,
"Freegoods": "0",
"RejectReason": null,
"ItemDEC": null,
"Plant": "7857",
"LGORT": "W001 ",
"NETVALUE": null,
"ADMQNTY": 3,
"AdMinYmd": "2024-07-22T00:00:00",
"RPRICEMNY": 1280,
"RETAILMNY": null,
"WPRICEMNY": null,
"WHOLEMNY": null,
"UPRICEMNY": null,
"UNITMNY": null,
"TaxPrice": null,
"TaxAmount": null,
"ReturnPrice": null,
"ReturnAmount": null,
"MEINS": "EA ",
"INOUTSTCNum": 3,
"NOTE": null,
"UPDATETIME": "2024-07-23T16:00:35.323",
"UPDATEMAN": "SAP ",
"STATUS": "3",
"IFFlg": "0",
"APPLYNO_STO": null,
"SaleRtnflg": "S",
"CREATEMAN": "SAP ",
"CREATETIME": "2024-07-22T14:00:50.06",
"PRODTYPE": null,
"BillingFlg": null,
"CHECKPLATFLG": null,
"USECODE": null,
"DecisionNo": null,
"CostCenter": null,
"SDABW": null,
"SAP_SALESORGANIZATION": null,
"imw_matter_number": null,
"BRAND": null,
"EMPCODE": null,
"EMPNAME": null,
"SDABWFLG": null,
"IONum": null
}
]
}
Failure:
{
"status": "error",
"message": ""
}4.3 SAP Issuance of 2B Inbound Orders (Old Table)
Request Endpoint: /api/v1/outBound/getOrder
Description: SAP Issuance of 2B Inbound Orders (Old Table)
Request Type: HTTP GET
4.3.1 Request Parameters
| Field Description | Field Name | Type | Length | Required | Notes |
|---|---|---|---|---|---|
| Page Size | pageSize | INT | No | Retrieves data by pagination. Default value is 50 if not specified. | |
| Page Number | pageNo | INT | No | Retrieves data by pagination, current page number. Starts from 1. Default value is 1 if not specified. | |
| Order Number | orderNo | VARCHAR | No | Example: 1504575834 | |
| Product Code | productCd | VARCHAR | No | ||
| Store Code | customerCd | VARCHAR | No | ||
| Delivery Note Number | shipNo | VARCHAR | No | ||
| Order Date | orderYMD | datetime | No | Filters data after (and including) this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2024-10-08 00:00:00.000 | |
| Outbound Date | outStcYMD | datetime | No | Filters data after (and including) this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2024-10-08 00:00:00.000 | |
| Status | status | VARCHAR | No | Example: 3 | |
| SAP Sales Order Number | sapOrderNo | VARCHAR | No | Example: 4205057289 | |
| Update Time | updateTime | datetime | No | Filters updated data after (and including) this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 |
Example request:/api/v1/outBound/getOrder?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49
4.3.2 Response Parameters
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Status | status | String | Yes | "success" indicates success, "error" indicates failure |
| Current Page Number | pageNo | INT | Yes | |
| Records per Page | pageSize | INT | Yes | |
| Total Pages | totalPages | INT | Yes | |
| Total Records | totalRecords | INT | Yes | |
| Data | data | array | Yes | Retrieved data |
| Error Message | message | String | No | Returned when status is "error". |
data
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Order Number | ORDERNO | char | ||
| Company Code | CompanyCd | char | ||
| Store Code | CUSTOMERCD | char | ||
| Product Code | PRODUCTCD | char | ||
| Red/Black Number | REDBLKNO | int | ||
| Delivery Address Code | DeliverAddCD | char | ||
| Urgent Outbound Flag | StcFlg | char | "0-Non-urgent 1-Urgent" | |
| Specified Production Date | DirectProductYmd | datetime | ||
| Product Production Date | ProductYmd | datetime | ||
| Place Code | PLACECD | char | ||
| Salesperson Code | SALEMANCD | varchar | ||
| Delivery Note Number | SHIPNO | char | ||
| Order Handler | ORDDTMAN | char | ||
| Order Date | ORDERYMD | datetime | ||
| Bulk Order Quantity | MailinnoBigNum | int | ||
| Order Quantity | ORDERQNTY | int | ||
| Acknowledgment Handler | ADMDTMAN | char | ||
| Bulk Acknowledgment Quantity | AdmMailinnoBigNum | int | ||
| Acknowledged Quantity | ADMQNTY | int | ||
| Shortage Quantity | ShortQnty | int | ||
| Shortage Amount | ShortMny | money | Shortage Amount = Shortage Quantity * Wholesale Unit Price | |
| Order Reason | OUTSTCNO | char | ||
| Outbound Date | OUTSTCYMD | datetime | ||
| Wholesale Amount | WHOLEMNY | money | ||
| Retail Amount | RETAILMNY | money | ||
| Status | STATUS | char | "0-Out of Stock 1-Order Received 2-Outbound 3-Outbound Correction 5-Acknowledged 7-Outbound Terminated 8-Out of Stock Outbound 9-Outbound Completed A-Inbound Completed B-Mismatch on Receipt C-Stock Secured D-Fake Outbound E-Matched (Fake Outbound) F-Matched (Not Fake Outbound) G-Canceled Order After SAP implementation: 1-Application 2-Outbound C-Stock Secured A-Consignment Sales" | |
| Wholesale Unit Price | WPRICEMNY | money | ||
| Update Time | UPDATETIME | datetime | ||
| Updated By | UPDATEMAN | char | ||
| Unit Price | UPRICEMNY | float | ||
| Unit Amount | UNITMNY | money | ||
| VAT Amount | RISETAXMNY | money | ||
| Consumption Tax Amount | CONTAXMNY | money | ||
| Expected Arrival Date | HopeInYmd | datetime | ||
| Actual Arrival Date | InStcYmd | datetime | ||
| Actual Inbound Quantity | InStcQnty | int | ||
| Acknowledgment Date | AdMinYmd | datetime | ||
| Scheduled Outbound Day | OUTSTCDAY | char | "1-7 correspond to Monday-Sunday 0-Urgent Outbound" | |
| Fake Outbound Quantity | FAKEOUTQNTY | int | ||
| Fake Outbound Handler | FAKEOUTMAN | char | ||
| Specified Outbound Date | HopeOutYmd | datetime | ||
| Outbound Handler | OUTSTCMan | char | ||
| Bulk Outbound Quantity | OutMailinnoBigNum | int | ||
| Outbound Quantity | OUTSTCNum | int | ||
| Actual Arrival Handler | InStcMan | char | ||
| Bulk Inbound Quantity | InMailinnoBigNum | int | ||
| Department Code | DEPMTCD | char | ||
| Responsible Person Code | AnswerManCode | char | ||
| Cost Payment Flag | FreeFlg | char | "0-Unpaid 1-Paid" | |
| Interface Flag | IFFlg | char | "3-Pending SAP Import 0-Imported to SAP or not dispatched to store 1-Dispatched to store" | |
| Retail Unit Price | RPRICEMNY | money | ||
| Shortage Date | QuehuoYmd | datetime | ||
| SAP Sales Order Number | SAPORDERNO | char | ||
| Order Type | SAPAPPLYTYPE | char | Z4OR: Standard Order | |
| Sales Notes | NOTE | nvarchar |
4.3.3 Example Responses
Success:
{
"status": "success",
"pageNo": 1,
"pageSize": 2,
"totalPages": 1,
"totalRecords": 2,
"data": [
{
"ORDERNO": "20240723 ",
"CompanyCd": "785",
"CUSTOMERCD": "23100001 ",
"PRODUCTCD": "78704071 ",
"REDBLKNO": 0,
"DeliverAddCD": null,
"StcFlg": null,
"DirectProductYmd": "2024-07-22T00:00:00",
"ProductYmd": "2024-07-22T00:00:00",
"PLACECD": "000",
"SALEMANCD": "0",
"SHIPNO": null,
"ORDDTMAN": "SAP ",
"ORDERYMD": "2024-07-22T00:00:00",
"MailinnoBigNum": 0,
"ORDERQNTY": 1,
"ADMDTMAN": null,
"AdmMailinnoBigNum": null,
"ADMQNTY": 1,
"ShortQnty": null,
"ShortMny": null,
"OUTSTCNO": null,
"OUTSTCYMD": "2024-07-22T00:00:00",
"WHOLEMNY": 216,
"RETAILMNY": 400,
"STATUS": "C",
"WPRICEMNY": 216,
"UPDATETIME": "2024-07-23T12:02:49.53",
"UPDATEMAN": "SAP ",
"UPRICEMNY": 0,
"UNITMNY": 0,
"RISETAXMNY": 0,
"CONTAXMNY": 0,
"HopeInYmd": "2024-07-22T00:00:00",
"InStcYmd": "2024-07-22T00:00:00",
"InStcQnty": 0,
"AdMinYmd": "2024-07-22T23:04:30",
"OUTSTCDAY": " ",
"FAKEOUTQNTY": null,
"FAKEOUTMAN": null,
"HopeOutYmd": "2024-07-22T00:00:00",
"OUTSTCMan": null,
"OutMailinnoBigNum": null,
"OUTSTCNum": 0,
"InStcMan": null,
"InMailinnoBigNum": null,
"DEPMTCD": null,
"AnswerManCode": null,
"FreeFlg": "1",
"IFFlg": "0",
"RPRICEMNY": 400,
"QuehuoYmd": "2024-07-22T00:00:00",
"SAPORDERNO": "4204409937 ",
"SAPAPPLYTYPE": "Z4OR",
"NOTE": null
},
{
"ORDERNO": "4204409943 ",
"CompanyCd": "9Z2",
"CUSTOMERCD": "23100001 ",
"PRODUCTCD": "45631 ",
"REDBLKNO": 0,
"DeliverAddCD": null,
"StcFlg": null,
"DirectProductYmd": "2024-07-23T01:47:21",
"ProductYmd": "2024-07-23T01:47:21",
"PLACECD": "000",
"SALEMANCD": "0",
"SHIPNO": null,
"ORDDTMAN": "SAP ",
"ORDERYMD": "2024-07-23T01:47:21",
"MailinnoBigNum": 0,
"ORDERQNTY": 2,
"ADMDTMAN": null,
"AdmMailinnoBigNum": null,
"ADMQNTY": 2,
"ShortQnty": null,
"ShortMny": null,
"OUTSTCNO": null,
"OUTSTCYMD": "2024-07-23T01:47:21",
"WHOLEMNY": 278.64,
"RETAILMNY": 516,
"STATUS": "C",
"WPRICEMNY": 139.32,
"UPDATETIME": "2024-07-23T15:01:39.927",
"UPDATEMAN": "SAP ",
"UPRICEMNY": 0,
"UNITMNY": 0,
"RISETAXMNY": 0,
"CONTAXMNY": 0,
"HopeInYmd": "2024-07-23T01:47:21",
"InStcYmd": "2024-07-23T01:47:21",
"InStcQnty": 0,
"AdMinYmd": "2024-07-23T01:47:21",
"OUTSTCDAY": " ",
"FAKEOUTQNTY": null,
"FAKEOUTMAN": null,
"HopeOutYmd": "2024-07-23T01:47:21",
"OUTSTCMan": null,
"OutMailinnoBigNum": null,
"OUTSTCNum": 0,
"InStcMan": null,
"InMailinnoBigNum": null,
"DEPMTCD": null,
"AnswerManCode": null,
"FreeFlg": "1",
"IFFlg": "0",
"RPRICEMNY": 258,
"QuehuoYmd": "2024-07-23T01:47:21",
"SAPORDERNO": "4204409943 ",
"SAPAPPLYTYPE": "Z4OR",
"NOTE": null
}
]
}
Failure:
{
"status": "error",
"message": ""
}4.4 SAP Issuance of 2B Return Outbound (Old Table)
Request Endpoint: /api/v1/outBound/getRtnSale
Description: SAP Issuance of 2B Return Outbound (Old Table)
Request Type: HTTP GET
4.4.1 Request Parameters
| Field Description | Field Name | Type | Length | Required | Notes |
|---|---|---|---|---|---|
| Page Size | pageSize | INT | No | Retrieves data by pagination. Default value is 50 if not specified. | |
| Page Number | pageNo | INT | No | Retrieves data by pagination, current page number. Starts from 1. Default value is 1 if not specified. | |
| Return Number | rtnSaleNo | VARCHAR | No | Example: 1504575834 | |
| Product Code | productCd | VARCHAR | No | Example: 10 | |
| Store Code | customerCd | VARCHAR | No | Example: 10200184 | |
| Return Date | rtnSaleYMD | datetime | No | Filters data after (and including) this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 | |
| Processing Date | handleYMD | datetime | No | Filters data after (and including) this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 | |
| SAP Order Number | sapOrderNo | VARCHAR | No | Example: 4203193399 | |
| Status | status | VARCHAR | No | Example: 3 | |
| Update Time | updateTime | datetime | No | Filters updated data after (and including) this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 |
Example request:/api/v1/outBound/getRtnSale?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49
4.4.2 Response Parameters
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Status | status | String | Yes | "success" indicates success, "error" indicates failure |
| Current Page Number | pageNo | INT | Yes | |
| Records per Page | pageSize | INT | Yes | |
| Total Pages | totalPages | INT | Yes | |
| Total Records | totalRecords | INT | Yes | |
| Data | data | array | Yes | Retrieved data |
| Error Message | message | String | No | Returned when status is "error". |
data
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Return Number | RTNSALENO | char | ||
| Company Code | CompanyCd | char | ||
| Store Code | CUSTOMERCD | char | ||
| Product Code | PRODUCTCD | char | ||
| Red/Black Indicator | REDBLKNO | int | ||
| Return Date | RTNSALEYMD | datetime | ||
| Place Code | PLACECD | char | ||
| Product Production Date | ProductYmd | datetime | ||
| Quality Product Quantity | QULQNTY | int | ||
| Defective Product Quantity | NOTQULQNTY | int | ||
| Wholesale Unit Price | WPRICEMNY | money | ||
| Retail Unit Price | RPRICEMNY | money | ||
| Wholesale Amount | WHOLEMNY | money | ||
| Restored Quantity | HOMQULQNTY | int | ||
| Unit Amount | UNITMNY | money | ||
| Value-Added Tax | RISETAXMNY | money | ||
| Rejected Quantity | REJECTQNTY | int | ||
| Processing Date | HANDLEYMD | datetime | ||
| Consumption Tax | CONTAXMNY | money | ||
| Entry Staff | INDTMAN | char | ||
| Processing Staff | HANDDTMAN | char | ||
| Update Time | UPDATETIME | datetime | ||
| Updated By | UPDATEMAN | char | ||
| Applicant | APPLYMAN | char | ||
| Application Quantity | APPLYMOUNT | int | ||
| Return Type | RTNKIND | char | ||
| Order Reason | REJECTEDRESONCD | char | ||
| Return Quantity | returnqnty | int | ||
| Confirmed Quantity | ADMINQNTY | int | ||
| Confirmation Date | ADMINYMD | datetime | ||
| Confirmation Staff | ADMINMAN | char | ||
| Status Code | STATUS | char | "0-Terminated 1-Application 2-Confirmed Z-Consignment Store Return (Post-SAP implementation)" | |
| SAP Sales Order Number | SAPORDERNO | char | ||
| SAP Order Type | SAPAPPLYTYPE | char | Z4RE: Standard Return Order | |
| Sales Notes | NOTE | nvarchar | ||
| Interface Run Status | IFFLG | char | "0-Extracted 3-Not Extracted" |
4.4.3 Return Value Examples
Success:
{
"status": "success",
"pageNo": 1,
"pageSize": 2,
"totalPages": 1,
"totalRecords": 2,
"data": [
{
"RTNSALENO": "23171291 ",
"CompanyCd": "785",
"CUSTOMERCD": "33300004",
"PRODUCTCD": "16173 ",
"REDBLKNO": 0,
"RTNSALEYMD": "2023-03-01T00:00:00",
"PLACECD": "000",
"ProductYmd": "2023-03-01T00:00:00",
"QULQNTY": 0,
"NOTQULQNTY": 0,
"WPRICEMNY": 181.04,
"RPRICEMNY": 248,
"WHOLEMNY": 350312.4,
"HOMQULQNTY": 0,
"UNITMNY": 0,
"RISETAXMNY": 0,
"REJECTQNTY": 0,
"HANDLEYMD": "2023-03-01T00:00:00",
"CONTAXMNY": 0,
"INDTMAN": "NULL ",
"HANDDTMAN": null,
"UPDATETIME": "2023-07-05T17:07:23.67",
"UPDATEMAN": "SAP ",
"APPLYMAN": null,
"APPLYMOUNT": 1935,
"RTNKIND": null,
"REJECTEDRESONCD": "99 ",
"RETURNQNTY": 1935,
"ADMINQNTY": 1935,
"ADMINYMD": "2023-03-01T00:00:00",
"ADMINMAN": "SAP ",
"STATUS": "2",
"SAPORDERNO": "4300289445 ",
"SAPAPPLYTYPE": "Z4RE",
"NOTE": null,
"IFFLG": "0 "
},
{
"RTNSALENO": "4300363400 ",
"CompanyCd": "785",
"CUSTOMERCD": "20600517",
"PRODUCTCD": "74252779",
"REDBLKNO": 0,
"RTNSALEYMD": "2023-11-20T00:00:00",
"PLACECD": "000",
"ProductYmd": "2023-11-20T00:00:00",
"QULQNTY": 0,
"NOTQULQNTY": 0,
"WPRICEMNY": 502.2,
"RPRICEMNY": 930,
"WHOLEMNY": 5022,
"HOMQULQNTY": 0,
"UNITMNY": 0,
"RISETAXMNY": 0,
"REJECTQNTY": 0,
"HANDLEYMD": "2023-11-20T00:00:00",
"CONTAXMNY": 0,
"INDTMAN": "NULL ",
"HANDDTMAN": null,
"UPDATETIME": "2023-11-20T16:00:26.913",
"UPDATEMAN": "SAP ",
"APPLYMAN": null,
"APPLYMOUNT": 10,
"RTNKIND": null,
"REJECTEDRESONCD": "99 ",
"RETURNQNTY": 10,
"ADMINQNTY": 10,
"ADMINYMD": "2023-11-20T00:00:00",
"ADMINMAN": "SAP ",
"STATUS": "2",
"SAPORDERNO": "4300363400 ",
"SAPAPPLYTYPE": "Z4RE",
"NOTE": null,
"IFFLG": "0 "
}
]
}
Failure:
{
"status": "error",
"message": ""
}4.5 SAP 2B Adjustment Order Issuance (Old Table)
API Endpoint: /api/v1/outBound/getNewBusiness
API Description: SAP 2B Adjustment Order Issuance (Old Table)
Request Type: HTTP GET
4.5.1 Request Parameters
| Field Description | Field Name | Type | Length | Required | Notes |
|---|---|---|---|---|---|
| Page Size | pageSize | INT | No | Retrieves data in pages. Number of items per page. Default is 50 if not provided. | |
| Page Number | pageNo | INT | No | Retrieves data in pages. Current page number. Pages start from 1. Default is 1 if not provided. | |
| Order Number | orderNo | VARCHAR | No | Example: RC231000012024A01 | |
| Store Code | customerCd | VARCHAR | No | Example: 10200184 | |
| Product Code | productCd | VARCHAR | No | Example: 78705518 | |
| Order Date | orderYMD | datetime | No | Example: 2024-10-08 00:00:00.000. Filters data on or after this date. Supports formats yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. | |
| Outbound Date | outStcYMD | datetime | No | Example: 2024-10-08 00:00:00.000. Filters data on or after this date. Supports formats yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. | |
| Status | status | VARCHAR | No | Example: 3 | |
| Update Time | updateTime | datetime | No | Example: 2023-09-15 18:06:32.447. Filters data updated on or after this time. Supports formats yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. | |
| Sales Order Number | sapOrderNo | VARCHAR | No | Example: 4203193399 |
API Request Example:/api/v1/outBound/getNewBusiness?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49
4.5.2 Response Parameters
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Return Status | status | String | Yes | "success" indicates success, "error" indicates failure. |
| Current Page Number | pageNo | INT | Yes | |
| Items per Page | pageSize | INT | Yes | |
| Total Pages | totalPages | INT | Yes | |
| Total Items | totalRecords | INT | Yes | |
| Data | data | array | Yes | The retrieved data. |
| Error Message | message | String | No | Returned when status is "error". Provides error details. |
data
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Order Number | ORDERNO | char | ||
| Company Code | CompanyCd | char | ||
| Store Code | CUSTOMERCD | char | ||
| Product Code | PRODUCTCD | char | ||
| Red/Black Flag | REDBLKNO | int | Value: 0, as of 2014-11-19 | |
| Delivery Location Code | DeliverAddCD | char | ||
| Urgent Outbound Flag | StcFlg | char | ||
| Specified Production Date | DirectProductYmd | datetime | ||
| Product Production Date | ProductYmd | datetime | ||
| Location Code | PLACECD | char | ||
| Salesperson Code | SALEMANCD | varchar | ||
| Delivery Order Number | SHIPNO | char | ||
| Order Responsible Person | ORDDTMAN | char | ||
| Order Date | ORDERYMD | datetime | ||
| Large Package Quantity (Order) | MailinnoBigNum | int | ||
| Order Quantity | ORDERQNTY | int | ||
| Approval Responsible Person | ADMDTMAN | char | ||
| Approval Date | AdMinYmd | datetime | ||
| Stock-out Date | QuehuoYmd | datetime | ||
| Large Package Quantity (Confirmed) | AdmMailinnoBigNum | int | ||
| Approved Quantity | ADMQNTY | int | ||
| Stock-out Quantity | ShortQnty | int | ||
| Stock-out Amount | ShortMny | money | ||
| Order Reason | OUTSTCNO | char | Previously "Outbound Summary Table Number" - 2014-04-29 | |
| Fake Outbound Responsible Person | FAKEOUTMAN | char | ||
| Fake Outbound Quantity | FAKEOUTQNTY | int | ||
| Specified Outbound Date | HopeOutYmd | datetime | ||
| Outbound Date | OUTSTCYMD | datetime | ||
| Outbound Responsible Person | OUTSTCMan | char | ||
| Large Package Quantity (Outbound) | OutMailinnoBigNum | int | ||
| Outbound Quantity | OUTSTCNum | int | ||
| Expected Arrival Date | HopeInYmd | datetime | ||
| Actual Arrival Date | InStcYmd | datetime | ||
| Actual Arrival Responsible Person | InStcMan | char | ||
| Large Package Quantity (Inbound) | InMailinnoBigNum | int | ||
| Actual Inbound Quantity | InStcQnty | int | ||
| Fixed Day | OUTSTCDAY | char | ||
| Department Code | DEPMTCD | char | ||
| Responsible Person Code | AnswerManCode | char | ||
| Cost Payment Division | FreeFlg | char | ||
| Wholesale Unit Price | WPRICEMNY | money | ||
| Wholesale Amount | WHOLEMNY | money | ||
| Unit Price | UPRICEMNY | float | ||
| Unit Amount | UNITMNY | money | ||
| Retail Amount | RETAILMNY | money | ||
| VAT Amount | RISETAXMNY | money | ||
| Consumption Tax Amount | CONTAXMNY | money | ||
| Status | STATUS | char | 2 - Completed Status | |
| Interface Flag | IFFlg | char | "0 - Interface not generated; 1 - Interface generated." | |
| Update Time | UPDATETIME | datetime | ||
| Updated By | UPDATEMAN | char | ||
| Retail Unit Price | RPRICEMNY | char | ||
| SAP Document Type | SAPAPPLYTYPE | char | Example: Z4IO - Adjustment Free Usage Document | |
| POS Division Name | POSKBN | char | ||
| Sales Order Number | SAPORDERNO | char | ||
| Sales Remarks | NOTE | nvarchar |
4.5.3 Return Value Examples
Success:
{
"status": "success",
"pageNo": 1,
"pageSize": 2,
"totalPages": 1,
"totalRecords": 2,
"data": [
{
"ORDERNO": "4202483035 ",
"COMPANYCD": "785",
"CUSTOMERCD": "20700001",
"PRODUCTCD": "13998 ",
"REDBLKNO": 0,
"DELIVERADDCD": null,
"STCFLG": "0",
"DIRECTPRODUCTYMD": "2023-01-06T00:00:00",
"PRODUCTYMD": "2023-01-06T00:00:00",
"PLACECD": "000",
"SALEMANCD": "000",
"SHIPNO": "4402991338 ",
"ORDDTMAN": "9999 ",
"ORDERYMD": "2023-01-06T05:26:17",
"MAILINNOBIGNUM": 0,
"ORDERQNTY": 1,
"ADMDTMAN": "9999 ",
"ADMINYMD": "2023-01-06T05:26:17",
"QUEHUOYMD": "2023-01-06T00:00:00",
"ADMMAILINNOBIGNUM": 0,
"ADMQNTY": 1,
"SHORTQNTY": 0,
"SHORTMNY": 0,
"OUTSTCNO": "561 ",
"FAKEOUTMAN": null,
"FAKEOUTQNTY": 0,
"HOPEOUTYMD": "2023-01-06T00:00:00",
"OUTSTCYMD": "2023-01-06T00:00:00",
"OUTSTCMAN": null,
"OUTMAILINNOBIGNUM": 0,
"OUTSTCNUM": 1,
"HOPEINYMD": "2023-01-06T00:00:00",
"INSTCYMD": "2023-01-06T00:00:00",
"INSTCMAN": null,
"INMAILINNOBIGNUM": 0,
"INSTCQNTY": 1,
"OUTSTCDAY": " ",
"DEPMTCD": null,
"ANSWERMANCODE": null,
"FREEFLG": "1",
"WPRICEMNY": 0,
"WHOLEMNY": 0,
"UPRICEMNY": 0,
"UNITMNY": 0,
"RETAILMNY": 0,
"RISETAXMNY": 0,
"CONTAXMNY": 0,
"STATUS": "2",
"IFFLG": "0",
"UPDATETIME": "2023-07-05T17:01:41.117",
"UPDATEMAN": "SAP ",
"RPRICEMNY": null,
"SAPAPPLYTYPE": "Z4IO",
"POSKBN": "Z499 ",
"SAPORDERNO": "4202483035 ",
"NOTE": null
},
{
"ORDERNO": "4202483035 ",
"COMPANYCD": "785",
"CUSTOMERCD": "20700001",
"PRODUCTCD": "15282 ",
"REDBLKNO": 0,
"DELIVERADDCD": null,
"STCFLG": "0",
"DIRECTPRODUCTYMD": "2023-01-06T00:00:00",
"PRODUCTYMD": "2023-01-06T00:00:00",
"PLACECD": "000",
"SALEMANCD": "000",
"SHIPNO": "4402991338 ",
"ORDDTMAN": "9999 ",
"ORDERYMD": "2023-01-06T05:26:17",
"MAILINNOBIGNUM": 0,
"ORDERQNTY": 8,
"ADMDTMAN": "9999 ",
"ADMINYMD": "2023-01-06T05:26:17",
"QUEHUOYMD": "2023-01-06T00:00:00",
"ADMMAILINNOBIGNUM": 0,
"ADMQNTY": 8,
"SHORTQNTY": 0,
"SHORTMNY": 0,
"OUTSTCNO": "561 ",
"FAKEOUTMAN": null,
"FAKEOUTQNTY": 0,
"HOPEOUTYMD": "2023-01-06T00:00:00",
"OUTSTCYMD": "2023-01-06T00:00:00",
"OUTSTCMAN": null,
"OUTMAILINNOBIGNUM": 0,
"OUTSTCNUM": 8,
"HOPEINYMD": "2023-01-06T00:00:00",
"INSTCYMD": "2023-01-06T00:00:00",
"INSTCMAN": null,
"INMAILINNOBIGNUM": 0,
"INSTCQNTY": 8,
"OUTSTCDAY": " ",
"DEPMTCD": null,
"ANSWERMANCODE": null,
"FREEFLG": "1",
"WPRICEMNY": 0,
"WHOLEMNY": 0,
"UPRICEMNY": 0,
"UNITMNY": 0,
"RETAILMNY": 0,
"RISETAXMNY": 0,
"CONTAXMNY": 0,
"STATUS": "2",
"IFFLG": "0",
"UPDATETIME": "2023-07-05T17:01:41.117",
"UPDATEMAN": "SAP ",
"RPRICEMNY": null,
"SAPAPPLYTYPE": "Z4IO",
"POSKBN": "Z499 ",
"SAPORDERNO": "4202483035 ",
"NOTE": null
}
]
}
Failure:
{
"status": "error",
"message": ""
}4.6 SAP PO Reversal Query
API Endpoint: /api/v1/outBound/getStockMvmtGR
API Description: SAP PO Reversal Query
Request Type: HTTP GET
4.6.1 Request Parameters
| Field Description | Field Name | Type | Length | Required | Notes |
|---|---|---|---|---|---|
| Page Size | pageSize | INT | No | Retrieves data in pages. Number of items per page. Default is 50 if not provided. | |
| Page Number | pageNo | INT | No | Retrieves data in pages. Current page number. Pages start from 1. Default is 1 if not provided. | |
| Purchase Order Number | poNo | VARCHAR | No | Example: RC231000012024A01 | |
| Timestamp (Current Time) | Timestamp | datetime | No | Example: 2024-10-08 00:00:00.000. Filters data on or after this time. Supports formats yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. |
API Request Example:/api/v1/outBound/getStockMvmtGR?pageNo=1&pageSize=2&Timestamp=2023-06-23 12:02:49
4.6.2 Response Parameters
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Return Status | status | String | Yes | "success" indicates success, "error" indicates failure. |
| Current Page Number | pageNo | INT | Yes | |
| Items per Page | pageSize | INT | Yes | |
| Total Pages | totalPages | INT | Yes | |
| Total Items | totalRecords | INT | Yes | |
| Data | data | array | Yes | Retrieved data. |
| Error Message | message | String | No | Returned when status is "error". Provides error details. |
data
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Document Unique ID | DocumentID | VARCHAR | ||
| Document Date | DocDate | VARCHAR | ||
| Posting Date | PostingDate | VARCHAR | ||
| Creation Date | CreateDate | VARCHAR | ||
| Creation Time | CreateTime | VARCHAR | ||
| Header Text | BKTXT | VARCHAR | ||
| Material Document | ProDoc | VARCHAR | ||
| Document Year | ProDocYear | VARCHAR | ||
| Line Item | Lineno | VARCHAR | ||
| Vendor Code | VendorCode | VARCHAR | ||
| Purchase Order Number | PONo | VARCHAR | ||
| Purchase Order Line Item | POItemno | VARCHAR | ||
| Intramart PO | NPSPONo | VARCHAR | ||
| Material Code | SAPPRODUCTCD | VARCHAR | ||
| Quantity | Qnty | int | ||
| Unit | ERFME | VARCHAR | ||
| Plant | Plant | VARCHAR | ||
| Storage Location | LGORT | VARCHAR | ||
| Batch | CHARG | VARCHAR | ||
| Movement Type | MoveType | VARCHAR | ||
| Timestamp (Current Time) | Timestamp | datetime |
4.6.3 Return Value Examples
Success:
{
"status": "success",
"pageNo": 1,
"pageSize": 2,
"totalPages": 1,
"totalRecords": 2,
"data": [
{
"DocumentID": "ed60b9ea58dd475c97f90bc4429f6bd5",
"DocDate": "20240105",
"PostingDate": "20240105",
"CreateDate": "20240104",
"CreateTime": "220008",
"BKTXT": "PO2311207",
"ProDoc": "5003780718",
"ProDocYear": "2024",
"Lineno": "0001",
"VendorCode": "2100003079",
"PONo": "4560010994",
"POItemno": "00010",
"NPSPONo": "PO2311207",
"SAPPRODUCTCD": "78702537101",
"Qnty": 10000,
"ERFME": "EA",
"Plant": "785B",
"LGORT": "W001",
"CHARG": null,
"MoveType": "101",
"Timestamp": "2024-10-10T19:50:14"
},
{
"DocumentID": "5a3018b4e036405b8e257d78f656fe3f",
"DocDate": "20240105",
"PostingDate": "20240105",
"CreateDate": "20240104",
"CreateTime": "220008",
"BKTXT": "PO2311207",
"ProDoc": "5003780718",
"ProDocYear": "2024",
"Lineno": "0001",
"VendorCode": "2100003079",
"PONo": "4560010994",
"POItemno": "00010",
"NPSPONo": "PO2311207",
"SAPPRODUCTCD": "78702537101",
"Qnty": 10000,
"ERFME": "EA",
"Plant": "785B",
"LGORT": "W001",
"CHARG": null,
"MoveType": "101",
"Timestamp": "2024-10-15T15:14:56"
}
]
}
Failure:
{
"status": "error",
"message": ""
}4.7 ToC Sales Order Details Query (For Reconciliation)
API Endpoint: /api/v1/outBound/getBusinessSubOMS
API Description: ToC Sales Order Details Query (For Reconciliation)
Request Type: HTTP GET
4.7.1 Request Parameters
| Field Description | Field Name | Type | Length | Required | Notes |
|---|---|---|---|---|---|
| Page Size | pageSize | INT | No | Retrieves data in pages. Number of items per page. Default is 50 if not provided. | |
| Page Number | pageNo | INT | No | Retrieves data in pages. Current page number. Pages start from 1. Default is 1 if not provided. | |
| Total return identifier | totalFlg | Boolean | No | Controls whether totalPages, totalRecords parameters are returned, boolean type, true, false, default false is not returned. | |
| Document Number | applyNo | VARCHAR | No | Example: RC231000012024A01 | |
| SAP Sales Order Number | sapOrderNo | VARCHAR | No | ||
| Summary Number | dailySummaryNo | VARCHAR | No | ||
| Consolidation Flag | summaryFlg | VARCHAR | No | Refreshed by EAI: 0 - Not Consolidated 1 - Consolidated | |
| update Time | updateTime | datetime | No | Example: 2024-10-08 00:00:00.000. Filters data on or after this time. Supports formats yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. |
API Request Example:/api/v1/outBound/getBusinessSubOMS?pageNo=1&pageSize=2&updateTime=2023-06-23 12:02:49&totalFlg=true
4.7.2 Response Parameters
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Return Status | status | String | Yes | "success" indicates success, "error" indicates failure. |
| Current Page Number | pageNo | INT | Yes | |
| Items per Page | pageSize | INT | Yes | |
| Total Pages | totalPages | INT | No | Returned according to the totalFlg identifier, if true |
| Total Items | totalRecords | INT | No | Returned according to the totalFlg identifier, if true |
| Data | data | array | Yes | Retrieved data. |
| Error Message | message | String | No | Returned when status is "error". Provides error details. |
data
| Field Description | Field Name | Type | Required | Notes |
|---|---|---|---|---|
| Company Code | COMPANYCD | char | ||
| Document Number | APPLYNO | char | "POS Number OMS Outbound Order Number" | |
| Application Date | APPLYYMD | datetime | ||
| Business Type | BusinessType | char | "10: Replenishment to Store 11: Return to Company 20: Store Sales 21: Store Returns 30: Free Sales Order 31: Free Order Return" | |
| Order Reason (Head) | REASONCD | char | "① Only for free orders and returns; otherwise, not required ② Free order upload only available in OMS" | |
| Order Reason Description | ReasonDes | char | ||
| POS Classification | CustomerGroup1 | char | "Z201: SMILE POS Z202: PS POS Z203: E-ORDER Z204: CS POS Z205: SCHD Z206: Others Z207: OMS Z208: ONECX" | |
| Sold-to Party | SOLDTOCODE | char | ||
| Store Code | CUSTOMERCD | char | Peripheral store code | |
| SAP Ship-to Code | SAP_CUSTOMERCD | char | ||
| Customer Classification | SALEPATN | char | "K1: Distribution K2: Consignment FS: Direct Sale" | |
| Requested Delivery Date | RequestedDate | datetime | ||
| Promotion Events | PromotionEvents | char | ||
| Remarks (Link POS) | headerTXT | char | Other textual information | |
| Remarks (Link WMS) | headerNote | char | Delivery information passed to WMS | |
| SAP Sales Order Number | SAPORDERNO | char | ||
| SAP Order Type | SAPAPPLYTYPE | char | ||
| Outbound/Inbound Delivery Number | DeliveryNO | char | ||
| Delivery Type | DeliveryType | char | ||
| Outbound/Inbound Date | INOUTSTCYMD | datetime | ||
| Mini-program Order Number | APP_OrderNo | char | OMS exclusive | |
| Payment Date | PayDate | datetime | OMS exclusive | |
| Summary Number | DailySummaryNo | char | Consolidated order number in OMS | |
| External Store Code | ExCUSTOMERCD | char | ||
| Vendor Code | SAP_VENDORCODE | char | ||
| Vendor Name | SAP_VENDORNAME | char | ||
| Currency | CURCY | char | ||
| Order Line Item | POSEX | char | ||
| Delivery Line Item | COSNR | char | ||
| Product Code | PRODUCTCD | char | Peripheral 8-digit product code | |
| SAP Product Code | SAPPRODUCTCD | char | ||
| Material Determination Code | DETERMINECODE | char | ||
| Material Description | DESCRIBE | char | ||
| Batch | CHARG | char | ||
| Expiration Date | ExpiryDate | datetime | ||
| Application Quantity | APPLYRQNTY | int | ||
| Free Goods Identifier | Freegoods | char | ||
| Rejection Reason (Item) | RejectReason | char | ||
| Item Description | ItemDEC | char | ||
| Plant | PLANT | char | ||
| Storage Location Code | LGORT | char | ||
| Net Order Value | NETVALUE | money | Total price of line items excluding tax | |
| Approval Quantity | ADMQNTY | int | ||
| Approval Date | AdMinYmd | datetime | ||
| Retail Unit Price | RPRICEMNY | money | ||
| Retail Amount | RETAILMNY | money | ||
| Wholesale Price (Including Tax) | WPRICEMNY | money | "If FSS/OMS: Actual sales price" | |
| Wholesale Amount (Including Tax) | WHOLEMNY | money | ||
| Unit Price (Excluding Tax) | UPRICEMNY | money | ||
| Unit Amount (Excluding Tax) | UNITMNY | money | ||
| Tax Rate | TaxPrice | int | ||
| Tax Amount | TaxAmount | money | ||
| Return Price | ReturnPrice | money | ||
| Return Amount | ReturnAmount | money | ||
| UoM (Unit of Measurement) | MEINS | char | ||
| Inbound/Outbound Quantity | INOUTSTCNum | int | ||
| Sales Notes | NOTE | nvarchar | Order remarks in outbound order | |
| Update Time | UPDATETIME | datetime | ||
| Updated By | UPDATEMAN | char | ||
| Status | STATUS | char | "1: Application 2: Confirmation 3: Outbound 4: Arrival Confirmation" | |
| Interface Execution Flag | IFFlg | char | "0: Imported to SAP or not sent to store 1: Sent to store 3: Pending SAP Import" | |
| SAP STO Number | APPLYNO_STO | char | ||
| Supplement/Return Flag | SaleRtnFlg | char | "S: Supplement/POD Overdelivery R: Return/POD Shortage" | |
| Created By | CREATEMAN | char | ||
| Creation Time | CREATETIME | datetime | ||
| Material Type Identifier | PRODTYPE | char | "1: Service Material 0: Non-Service Material" | |
| Billing Identifier | BillingFlg | char | "1: Invoiced" | |
| Reconciliation Platform Transmission Flag | CheckPlatFlg | char | Used by EAI | |
| Purpose | USECODE | char | ||
| Decision Case Number | DecisionNo | varchar | ||
| Cost Center | CostCenter | char | ||
| Minimum Order Quantity Identifier | SDABW | char | "EAI assigns value Z002 for Minimum Order Quantity" | |
| Sales Organization | SAP_SALESORGANIZATION | char | ||
| Decision Case Number | imw_matter_number | varchar | ||
| Brand | BRAND | char | ||
| Actual Quota Allocation Quantity | ActualQNTY | int | ||
| Quota Deficit Flag | QuotaDeficitFlg | char | ||
| Applicant Employee Code | EMPCODE | varchar | ||
| Applicant Employee Name | EMPNAME | varchar | ||
| Minimum Order Quantity Activation Flag | SDABWFLG | char | "1: Do not activate minimum order quantity 0 or blank: Activate" | |
| Document Unique ID | DocumentID | varchar | ||
| Timestamp (Current Time) | Timestamp | datetime | ||
| Peripheral Identifier | SysFlg | char | "1: POS 2: SCHD 3: E-order 4: Shopex 5: UCO 6: LeQee 7: Decision 8: Purchase" | |
| Points Redemption Flag | PointsFlg | char | "1: Points Redemption" | |
| Consolidation Flag | SummaryFlg | char | "Refreshed by EAI: 0: Not Consolidated 1: Consolidated" | |
| Order Source | orderSource | varchar | "POS" | |
| Brand Code | brandCode | varchar | "Only accepts the following codes: CPB, EFM, IPSA, NARS, TG, SDK, SHI, PCV, LM, BAUM" | |
| Sales Platform | channelCode | varchar | "POS (lowercase)" | |
| Order Type | orderType | int | "0: Sales Order 1: Return Order" | |
| Order Status | orderStatus | varchar | "1: Order Completed" | |
| Payment Method | payType | varchar | "POS (indicates bank POS)" | |
| Payment Status | payStatus | int | "2: Paid 3: Refunded" | |
| Inbound/Outbound Status | shippedStatus | int | "2: Outbound 5: Inbound" | |
| Member ID | memberId | varchar | ||
| Shop Name | shopName | varchar | Not provided | |
| Source Platform Order Number | parentPayCode | varchar | Associated original order number for returns | |
| Order Creation Time | orderTime | varchar | ||
| Payment Time | payTime | varchar | ||
| Payable Amount | amount | varchar | Payment amount for this order | |
| Adjustment Amount | reviseAmount | varchar | Not provided | |
| Material Code | prdCode | varchar | ||
| Product Name | prdName | varchar | ||
| Shipping Time | shippedTime | varchar | ||
| Presale sign | PresaleFlag | varchar | 0: general sales, 1: pre-sale, 2: pre-sale delivery, 3: group purchase coupon purchase, 4: group purchase coupon delivery | |
| Pre-sale order number | PresaleTradeNo | varchar | ||
| BC code | BCCode | varchar |
4.7.3 Return Value Examples
Success:
{
"status": "success",
"pageNo": 1,
"pageSize": 2,
"totalPages": 1,
"totalRecords": 2,
"data": [
{
"COMPANYCD": "785",
"APPLYNO": "1909397583 ",
"APPLYYMD": "2024-05-21T00:00:00",
"BusinessType": "20 ",
"REASONCD": null,
"ReasonDes": null,
"CustomerGroup1": "Z207",
"SOLDTOCODE": "2100002961",
"CUSTOMERCD": "10400000 ",
"SAP_CUSTOMERCD": "2200003134",
"SALEPATN": "FS",
"RequestedDate": null,
"PromotionEvents": null,
"headerTXT": null,
"headerNote": null,
"SAPORDERNO": " ",
"SAPAPPLYTYPE": "Z4BV",
"DeliveryNO": null,
"DeliveryType": null,
"INOUTSTCYMD": null,
"APP_OrderNo": "3897472826800671542 ",
"PayDate": "2024-05-20T00:00:00",
"DailySummaryNo": "S220000313420241025133128101 ",
"ExCUSTOMERCD": null,
"SAP_VENDORCODE": null,
"SAP_VENDORNAME": null,
"CURCY": null,
"POSEX": "10 ",
"COSNR": null,
"PRODUCTCD": "16182 ",
"SAPPRODUCTCD": "10116182205CN",
"DETERMINECODE": "10116182205CN",
"DESCRIBE": null,
"CHARG": "COMMON ",
"ExpiryDate": null,
"APPLYRQNTY": 2,
"Freegoods": "0",
"RejectReason": null,
"ItemDEC": null,
"PLANT": "785B",
"LGORT": "W001 ",
"NETVALUE": null,
"ADMQNTY": null,
"AdMinYmd": null,
"RPRICEMNY": null,
"RETAILMNY": null,
"WPRICEMNY": null,
"WHOLEMNY": 897.1,
"UPRICEMNY": null,
"UNITMNY": null,
"TaxPrice": null,
"TaxAmount": null,
"ReturnPrice": null,
"ReturnAmount": null,
"MEINS": null,
"INOUTSTCNum": null,
"NOTE": null,
"UPDATETIME": "2024-10-25T13:31:30.417",
"UPDATEMAN": "EAI ",
"STATUS": "1",
"IFFlg": "0",
"APPLYNO_STO": null,
"SaleRtnFlg": null,
"CREATEMAN": "EAI ",
"CREATETIME": "2024-10-22T17:40:11.883",
"PRODTYPE": "0",
"BillingFlg": null,
"CheckPlatFlg": "3",
"USECODE": null,
"DecisionNo": null,
"CostCenter": null,
"SDABW": null,
"SAP_SALESORGANIZATION": "7851",
"imw_matter_number": null,
"BRAND": "11",
"ActualQNTY": null,
"QuotaDeficitFlg": "0",
"EMPCODE": null,
"EMPNAME": null,
"SDABWFLG": null,
"DocumentID": "25092e0a11184690ac2454cdcc67c780",
"Timestamp": "2024-10-21T15:28:11",
"SysFlg": "5",
"PointsFlg": null,
"SummaryFlg": "1",
"brandCode": null,
"channelCode": null,
"orderType": null,
"orderStatus": null,
"payType": null,
"payStatus": null,
"shippedStatus": null,
"memberId": null,
"shopName": null,
"parentPayCode": null,
"orderTime": null,
"payTime": null,
"amount": null,
"reviseAmount": null,
"prdCode": null,
"prdName": null,
"shippedTime": null
},
{
"COMPANYCD": "785",
"APPLYNO": "1909397583 ",
"APPLYYMD": "2024-05-21T00:00:00",
"BusinessType": "20 ",
"REASONCD": null,
"ReasonDes": null,
"CustomerGroup1": "Z207",
"SOLDTOCODE": "2100002961",
"CUSTOMERCD": "10400000 ",
"SAP_CUSTOMERCD": "2200003134",
"SALEPATN": "FS",
"RequestedDate": null,
"PromotionEvents": null,
"headerTXT": null,
"headerNote": null,
"SAPORDERNO": " ",
"SAPAPPLYTYPE": "Z4BV",
"DeliveryNO": null,
"DeliveryType": null,
"INOUTSTCYMD": null,
"APP_OrderNo": "3897472826800671542 ",
"PayDate": "2024-05-20T00:00:00",
"DailySummaryNo": "S220000313420241025133128101 ",
"ExCUSTOMERCD": null,
"SAP_VENDORCODE": null,
"SAP_VENDORNAME": null,
"CURCY": null,
"POSEX": "20 ",
"COSNR": null,
"PRODUCTCD": "16182 ",
"SAPPRODUCTCD": "10116182205CN",
"DETERMINECODE": "10116182205CN",
"DESCRIBE": null,
"CHARG": "COMMON ",
"ExpiryDate": null,
"APPLYRQNTY": 1,
"Freegoods": "1",
"RejectReason": null,
"ItemDEC": null,
"PLANT": "785B",
"LGORT": "W001 ",
"NETVALUE": null,
"ADMQNTY": null,
"AdMinYmd": null,
"RPRICEMNY": null,
"RETAILMNY": null,
"WPRICEMNY": null,
"WHOLEMNY": 0,
"UPRICEMNY": null,
"UNITMNY": null,
"TaxPrice": null,
"TaxAmount": null,
"ReturnPrice": null,
"ReturnAmount": null,
"MEINS": null,
"INOUTSTCNum": null,
"NOTE": null,
"UPDATETIME": "2024-10-25T13:31:30.417",
"UPDATEMAN": "EAI ",
"STATUS": "1",
"IFFlg": "0",
"APPLYNO_STO": null,
"SaleRtnFlg": null,
"CREATEMAN": "EAI ",
"CREATETIME": "2024-10-22T17:40:11.92",
"PRODTYPE": "0",
"BillingFlg": null,
"CheckPlatFlg": "3",
"USECODE": null,
"DecisionNo": null,
"CostCenter": null,
"SDABW": null,
"SAP_SALESORGANIZATION": "7851",
"imw_matter_number": null,
"BRAND": "11",
"ActualQNTY": null,
"QuotaDeficitFlg": "0",
"EMPCODE": null,
"EMPNAME": null,
"SDABWFLG": null,
"DocumentID": "25092e0a11184690ac2454cdcc67c780",
"Timestamp": "2024-10-21T15:28:11",
"SysFlg": "5",
"PointsFlg": null,
"SummaryFlg": "1",
"brandCode": null,
"channelCode": null,
"orderType": null,
"orderStatus": null,
"payType": null,
"payStatus": null,
"shippedStatus": null,
"memberId": null,
"shopName": null,
"parentPayCode": null,
"orderTime": null,
"payTime": null,
"amount": null,
"reviseAmount": null,
"prdCode": null,
"prdName": null,
"shippedTime": null
}
]
}
Error:
{
"status": "error",
"message": ""
}4.8 SAP Issued Billing Documents Query
Request URL: /api/v1/outBound/getBillingDataPool
Description: Query SAP issued billing documents
Request Type: HTTP GET
4.8.1 Request Parameters
| Field Description | Field Name | Type | Length | Required | Remarks |
|---|---|---|---|---|---|
| Page data entries | pageSize | INT | No | Fetch data by pages, entries per page. Defaults to 50 if not provided. | |
| Page number | pageNo | INT | No | Fetch data by pages, current page number. Starts from 1 (1 is the initial page). Defaults to page 1 if not provided. | |
| Billing Document | billingNo | VARCHAR | No | Example: 1504575834 | |
| Billing Date | billingYMD | datetime | No | Filters data from and including this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 | |
| Sales Order (SO) Number | sapOrderNO | VARCHAR | No | Example: 4300439027 | |
| Delivery Number | deliveryNO | VARCHAR | No | Example: 2200003451 | |
| PO Date | applyYMD | datetime | No | Filters data from and including this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 | |
| PO Number | applyNO | VARCHAR | No | Example: RT102002152024140 | |
| Original Billing Document (for reversal) | originBillingNO | VARCHAR | No | ||
| Counteract Flag | counteractFlg | VARCHAR | No | Example: 0 | |
| Update Time | updateTime | datetime | No | Filters data updated from and including this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 |
Request Example:/api/v1/outBound/getBillingDataPool?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49
4.8.2 Response Parameters
| Field Description | Field Name | Type | Required | Remarks |
|---|---|---|---|---|
| Return status | status | String | Yes | "success" indicates success, "error" indicates failure. |
| Current page number | pageNo | INT | Yes | |
| Entries per page | pageSize | INT | Yes | |
| Total pages | totalPages | INT | Yes | |
| Total entries | totalRecords | INT | Yes | |
| Data | data | array | Yes | Queried data. |
| Error message | message | String | No | Returned when status is "error". |
data
| Field Description | Field Name | Type | Required | Remarks |
|---|---|---|---|---|
| Billing Document | BillingNo | CHAR | No | |
| Billing Type | BillingType | CHAR | No | |
| Sales Organization | SAP_SALESORGANIZATION | CHAR | No | |
| Distribution Channel | SAP_DISTRIBUTIONCHANNEL | CHAR | No | |
| Billing Date | BillingYMD | DATETIME | No | |
| SAP Region Code | SAP_REGION | CHAR | No | |
| Company Code | COMPANYCD | CHAR | No | |
| Payer Code | SAP_PayerCD | CHAR | No | |
| Sold-To Code | SAP_SoldToCD | CHAR | No | |
| Payer Name | SAP_PayerNM | CHAR | No | |
| City | CITY | CHAR | No | |
| Language | SAP_LANGUAGE | CHAR | No | |
| Payer Address 1 | LOCATION1 | CHAR | No | |
| Payer Address 2 | LOCATION2 | CHAR | No | |
| Contact Number | ContactNumber | CHAR | No | |
| Currency | SAP_CURRENCY | CHAR | No | |
| Line Number | POSEX | CHAR | No | |
| Billed Quantity | BilledQuantity | INT | No | |
| Sales Unit | Salesunit | CHAR | No | |
| Net Weight | Netweight | nvarchar | No | |
| Product Code | SAPPRODUCTCD | CHAR | No | |
| Product Description | ItemDescription | CHAR | No | |
| Plant | PLANT | CHAR | No | |
| Country | Country | CHAR | No | |
| Net Value | NetValue | money | No | |
| Tax Amount | TaxAmount | money | No | |
| Product Barcode | PRODBARCODE1 | CHAR | No | |
| Tax Code | TaxCode | CHAR | No | |
| Tax Rate | TaxRate | money | No | |
| Sales Order Number | SAPORDERNO | CHAR | No | |
| Sales Order Line | POSEX_SO | CHAR | No | |
| Delivery Number | DeliveryNO | CHAR | No | |
| Delivery Line | COSNR | CHAR | No | |
| Accounting Document | AccountingNO | CHAR | No | |
| PO Date | APPLYYMD | DATETIME | No | |
| PO Number | APPLYNO | CHAR | No | |
| Material Number | Materialentered | CHAR | No | |
| Total Amount (incl. Tax) | WHOLEMNY | MONEY | No | |
| Ship-To Code | SAPCUSTOMERCD | CHAR | No | |
| Original Billing Document | OriginBillingNO | CHAR | No | |
| Update Handler | UPDATEMAN | CHAR | No | |
| Update Time | UPDATETIME | DATETIME | No | |
| Creation Handler | CREATEMAN | CHAR | No | |
| Creation Time | CREATETIME | DATETIME | No | |
| Interface Flag | IFFlg | CHAR | No | |
| Counteract Flag | counteractFlg | CHAR | No | |
| Product Short Code | PRODUCTCD | CHAR | No | |
| Sales Statistics Flag | SSSFLG | CHAR | No | |
| Reconciliation Platform Flag | CheckPlatFlg | CHAR | No |
4.8.3 Return Value Examples
Success:
{
"status": "success",
"pageNo": 1,
"pageSize": 2,
"totalPages": 1,
"totalRecords": 2,
"data": [
{
"BillingNo": "4700282757",
"BillingType": "Z4G2",
"SAP_SALESORGANIZATION": "7851",
"SAP_DISTRIBUTIONCHANNEL": "14",
"BillingYMD": "2023-01-31T00:00:00",
"SAP_REGION": "020",
"COMPANYCD": "785 ",
"SAP_PayerCD": "2300001557",
"SAP_SoldToCD": "2100002963",
"SAP_PayerNM": "TG_EC_微店 ",
"CITY": "上海 ",
"SAP_LANGUAGE": "ZH",
"LOCATION1": null,
"LOCATION2": null,
"ContactNumber": null,
"SAP_CURRENCY": null,
"POSEX": "000010",
"BilledQuantity": 1,
"Salesunit": "EA ",
"Netweight": null,
"SAPPRODUCTCD": "300000300 ",
"ItemDescription": "THE GINZA-商场白条 ",
"PLANT": "7857",
"Country": null,
"NetValue": 37080.52,
"TaxAmount": 4820.47,
"PRODBARCODE1": null,
"TaxCode": "X1",
"TaxRate": null,
"SAPORDERNO": "4300278902",
"POSEX_SO": "000010",
"DeliveryNO": "4300278902",
"COSNR": "000010",
"AccountingNO": "4700282757",
"APPLYYMD": null,
"APPLYNO": null,
"Materialentered": "300000300 ",
"WHOLEMNY": 41900.99,
"SAPCUSTOMERCD": "2200003131 ",
"OriginBillingNO": null,
"UPDATEMAN": "UPDATEMAN ",
"UPDATETIME": "2023-07-05T11:24:52.703",
"CREATEMAN": "SAP ",
"CREATETIME": "2023-05-01T14:00:11.31",
"IFFlg": "0",
"counteractFlg": "1",
"PRODUCTCD": "300000300 ",
"SSSFLG": "0",
"CheckPlatFlg": "0"
},
{
"BillingNo": "4700282757",
"BillingType": "Z4G2",
"SAP_SALESORGANIZATION": "7851",
"SAP_DISTRIBUTIONCHANNEL": "14",
"BillingYMD": "2023-01-31T00:00:00",
"SAP_REGION": null,
"COMPANYCD": "785 ",
"SAP_PayerCD": "2300001557",
"SAP_SoldToCD": "2100002963",
"SAP_PayerNM": null,
"CITY": null,
"SAP_LANGUAGE": null,
"LOCATION1": null,
"LOCATION2": null,
"ContactNumber": null,
"SAP_CURRENCY": "CNY ",
"POSEX": "10 ",
"BilledQuantity": 1,
"Salesunit": "EA ",
"Netweight": null,
"SAPPRODUCTCD": "300000300 ",
"ItemDescription": "THE GINZA-商场白条 ",
"PLANT": null,
"Country": null,
"NetValue": 37080.52,
"TaxAmount": 4820.47,
"PRODBARCODE1": null,
"TaxCode": null,
"TaxRate": null,
"SAPORDERNO": "4300278902",
"POSEX_SO": "10 ",
"DeliveryNO": "4300278902",
"COSNR": null,
"AccountingNO": null,
"APPLYYMD": null,
"APPLYNO": null,
"Materialentered": "300000300 ",
"WHOLEMNY": 41900.99,
"SAPCUSTOMERCD": "2200003131 ",
"OriginBillingNO": null,
"UPDATEMAN": "UPDATEMAN ",
"UPDATETIME": "2023-07-05T11:24:52.703",
"CREATEMAN": "EAI ",
"CREATETIME": "2023-04-07T10:53:05",
"IFFlg": "0",
"counteractFlg": "1",
"PRODUCTCD": "300000300 ",
"SSSFLG": "0",
"CheckPlatFlg": "0"
}
]
}
Error:
{
"status": "error",
"message": ""
}4.9 SAP Issued Billing Reversal Documents Query
Request URL: /api/v1/outBound/getBillingCounteract
Description: Query SAP issued billing reversal documents
Request Type: HTTP GET
4.9.1 Request Parameters
| Field Description | Field Name | Type | Length | Required | Remarks |
|---|---|---|---|---|---|
| Page data entries | pageSize | INT | No | Fetch data by pages, entries per page. Defaults to 50 if not provided. | |
| Page number | pageNo | INT | No | Fetch data by pages, current page number. Starts from 1 (1 is the initial page). Defaults to page 1 if not provided. | |
| Billing Document | billingNo | VARCHAR | No | Example: 1504575834 | |
| Billing Date | billingYMD | datetime | No | Filters data from and including this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 | |
| Sales Order (SO) Number | sapOrderNO | VARCHAR | No | Example: 4300439027 | |
| Delivery Number | deliveryNO | VARCHAR | No | Example: 2200003451 | |
| PO Date | applyYMD | datetime | No | Filters data from and including this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 | |
| PO Number | applyNO | VARCHAR | No | Example: RT102002152024140 | |
| Original Billing Document (for reversal) | originBillingNO | VARCHAR | No | ||
| Reversal Status | counteractStatus | VARCHAR | No | 0: Reversed, 1: Original document not found | |
| Update Time | updateTime | datetime | No | Filters data updated from and including this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 |
Request Example:/api/v1/outBound/getBillingCounteract?pageNo=1&pageSize=2&updateTime=2024-07-23 12:02:49
4.9.2 Response Parameters
| Field Description | Field Name | Type | Required | Remarks |
|---|---|---|---|---|
| Return status | status | String | Yes | "success" indicates success, "error" indicates failure. |
| Current page number | pageNo | INT | Yes | |
| Entries per page | pageSize | INT | Yes | |
| Total pages | totalPages | INT | Yes | |
| Total entries | totalRecords | INT | Yes | |
| Data | data | array | Yes | Queried data. |
| Error message | message | String | No | Returned when status is "error". |
data
| Field Description | Field Name | Type | Required | Remarks |
|---|---|---|---|---|
| Billing Document | BillingNo | CHAR | No | |
| Billing Type | BillingType | CHAR | No | |
| Sales Organization | SAP_SALESORGANIZATION | CHAR | No | |
| Distribution Channel | SAP_DISTRIBUTIONCHANNEL | CHAR | No | |
| Billing Date | BillingYMD | DATETIME | No | |
| SAP Region Code | SAP_REGION | CHAR | No | |
| Company Code | COMPANYCD | CHAR | No | |
| Payer Code | SAP_PayerCD | CHAR | No | |
| Sold-To Code | SAP_SoldToCD | CHAR | No | |
| Payer Name | SAP_PayerNM | CHAR | No | |
| City | CITY | CHAR | No | |
| Language | SAP_LANGUAGE | CHAR | No | |
| Payer Address 1 | LOCATION1 | CHAR | No | |
| Payer Address 2 | LOCATION2 | CHAR | No | |
| Contact Number | ContactNumber | CHAR | No | |
| Currency | SAP_CURRENCY | CHAR | No | |
| Line Number | POSEX | CHAR | No | |
| Billed Quantity | BilledQuantity | INT | No | |
| Sales Unit | Salesunit | CHAR | No | |
| Net Weight | Netweight | nvarchar | No | |
| Product Code | SAPPRODUCTCD | CHAR | No | |
| Product Description | ItemDescription | CHAR | No | |
| Plant | PLANT | CHAR | No | |
| Country | Country | CHAR | No | |
| Net Value | NetValue | money | No | |
| Tax Amount | TaxAmount | money | No | |
| Product Barcode | PRODBARCODE1 | CHAR | No | |
| Tax Code | TaxCode | CHAR | No | |
| Tax Rate | TaxRate | money | No | |
| Sales Order Number | SAPORDERNO | CHAR | No | |
| Sales Order Line | POSEX_SO | CHAR | No | |
| Delivery Number | DeliveryNO | CHAR | No | |
| Delivery Line | COSNR | CHAR | No | |
| Accounting Document | AccountingNO | CHAR | No | |
| PO Date | APPLYYMD | DATETIME | No | |
| PO Number | APPLYNO | CHAR | No | |
| Material Number | Materialentered | CHAR | No | |
| Total Amount (incl. Tax) | WHOLEMNY | MONEY | No | |
| Ship-To Code | SAPCUSTOMERCD | CHAR | No | |
| Original Billing Document (for reversal) | OriginBillingNO | CHAR | No | |
| Update Handler | UPDATEMAN | CHAR | No | |
| Update Time | UPDATETIME | DATETIME | No | |
| Creation Handler | CREATEMAN | CHAR | No | |
| Creation Time | CREATETIME | DATETIME | No | |
| Interface Flag | IFFlg | CHAR | No | |
| Reconciliation Platform Flag | CheckPlatFlg | CHAR | No | |
| Product Short Code | PRODUCTCD | CHAR | No | |
| Reversal Status | counteractStatus | CHAR | No |
4.9.3 Return Value Examples
Success:
{
"status": "success",
"pageNo": 1,
"pageSize": 2,
"totalPages": 1,
"totalRecords": 2,
"data": [
{
"BillingNo": "4700310614",
"BillingType": "Z4S2",
"SAP_SALESORGANIZATION": "7851",
"SAP_DISTRIBUTIONCHANNEL": "11",
"BillingYMD": "2023-04-03T00:00:00",
"SAP_REGION": "010",
"COMPANYCD": "785 ",
"SAP_PayerCD": "2300001897",
"SAP_SoldToCD": "2100002528",
"SAP_PayerNM": "北京汉光百货有限责任公司 ",
"CITY": "北京 ",
"SAP_LANGUAGE": "ZH",
"LOCATION1": null,
"LOCATION2": null,
"ContactNumber": "010-63608899 ",
"SAP_CURRENCY": null,
"POSEX": "000020",
"BilledQuantity": 58240,
"Salesunit": "EA ",
"Netweight": "1747200.000",
"SAPPRODUCTCD": "1018N162000CN ",
"ItemDescription": "肌肤之钥 沁肌调理精华露 S 30ml ",
"PLANT": "7857",
"Country": null,
"NetValue": 0,
"TaxAmount": 0,
"PRODBARCODE1": "729238988200 ",
"TaxCode": null,
"TaxRate": null,
"SAPORDERNO": "4300301535",
"POSEX_SO": "000020",
"DeliveryNO": "4600263960",
"COSNR": "000010",
"AccountingNO": "4700310614",
"APPLYYMD": "2023-04-03T00:00:00",
"APPLYNO": "# ",
"Materialentered": "1018N162000CN ",
"WHOLEMNY": 0,
"SAPCUSTOMERCD": "2200003433 ",
"OriginBillingNO": "4700305882 ",
"UPDATEMAN": "UPDATEMAN ",
"UPDATETIME": "2023-07-05T11:19:56.363",
"CREATEMAN": "SAP ",
"CREATETIME": "2023-04-18T16:00:32.903",
"IFFlg": "3",
"CheckPlatFlg": "0",
"PRODUCTCD": "1018N162 ",
"counteractStatus": "0"
},
{
"BillingNo": "4700310615",
"BillingType": "Z4S2",
"SAP_SALESORGANIZATION": "7851",
"SAP_DISTRIBUTIONCHANNEL": "11",
"BillingYMD": "2023-04-16T00:00:00",
"SAP_REGION": "240",
"COMPANYCD": "785 ",
"SAP_PayerCD": "2300001766",
"SAP_SoldToCD": "2100002670",
"SAP_PayerNM": "昆明王府井百货有限责任公司 ",
"CITY": "昆明 ",
"SAP_LANGUAGE": "ZH",
"LOCATION1": null,
"LOCATION2": null,
"ContactNumber": "0871-65230566 ",
"SAP_CURRENCY": null,
"POSEX": "000010",
"BilledQuantity": 7,
"Salesunit": "EA ",
"Netweight": null,
"SAPPRODUCTCD": "74383756801 ",
"ItemDescription": "SHI 银卡升级礼220206（wtl15ml+utm10ml) ",
"PLANT": "7857",
"Country": null,
"NetValue": 0,
"TaxAmount": 0,
"PRODBARCODE1": null,
"TaxCode": null,
"TaxRate": null,
"SAPORDERNO": "4300305736",
"POSEX_SO": "000010",
"DeliveryNO": "4600267786",
"COSNR": "000010",
"AccountingNO": "4700310615",
"APPLYYMD": null,
"APPLYNO": "# ",
"Materialentered": "74383756801 ",
"WHOLEMNY": 0,
"SAPCUSTOMERCD": "2200003286 ",
"OriginBillingNO": "4700310183 ",
"UPDATEMAN": "UPDATEMAN ",
"UPDATETIME": "2023-07-05T11:19:56.363",
"CREATEMAN": "SAP ",
"CREATETIME": "2023-04-18T16:00:33.087",
"IFFlg": "3",
"CheckPlatFlg": "0",
"PRODUCTCD": "74383756 ",
"counteractStatus": "0"
}
]
}
Error:
{
"status": "error",
"message": ""
}4.10 POS Loan and Credit Payment Method Query
Request URL: /api/v1/outBound/getCoupoChargePlatform
Description: Query POS loan and credit payment methods
Request Type: HTTP GET
4.10.1 Request Parameters
| Field Description | Field Name | Type | Length | Required | Remarks |
|---|---|---|---|---|---|
| Page data entries | pageSize | INT | No | Fetch data by pages, entries per page. Defaults to 50 if not provided. | |
| Page number | pageNo | INT | No | Fetch data by pages, current page number. Starts from 1 (1 is the initial page). Defaults to page 1 if not provided. | |
| Transaction Time (payment sent time) | tradeTime | datetime | No | Filters data from and including this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 | |
| Timestamp (current time) | Timestamp | datetime | No | Filters data updated from and including this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 |
Request Example:/api/v1/outBound/getCoupoChargePlatform?pageNo=1&pageSize=2&Timestamp=2024-07-23 12:02:49
4.10.2 Response Parameters
| Field Description | Field Name | Type | Required | Remarks |
|---|---|---|---|---|
| Return status | status | String | Yes | "success" indicates success, "error" indicates failure. |
| Current page number | pageNo | INT | Yes | |
| Entries per page | pageSize | INT | Yes | |
| Total pages | totalPages | INT | Yes | |
| Total entries | totalRecords | INT | Yes | |
| Data | data | array | Yes | Queried data. |
| Error message | message | String | No | Returned when status is "error". |
data
| Field Description | Field Name | Type | Required | Remarks |
|---|---|---|---|---|
| Document unique ID | DocumentID | CHAR | ||
| Order type flag | shopCode | VARCHAR(10) | ||
| Shop name | shopName | VARCHAR(500) | ||
| POS machine number | posNo | VARCHAR(500) | Fixed value: 1 | |
| Terminal number | deviceNo | VARCHAR(500) | Fixed value: 1 | |
| Transaction number | tradeNo | VARCHAR(500) | ||
| Receipt number | invoiceNumber | VARCHAR(500) | Yes | |
| POS unique order number | posTradeNo | VARCHAR(500) | Yes | |
| Sales type | saleType | VARCHAR(500) | Yes | |
| Event time (payment sent time) | tradeTime | datetime | 500 | Yes |
| Business date (settlement time) | businessDate | date | 500 | Yes |
| Payment method code | payTypeCode | VARCHAR(500) | Yes | 1: Voucher (deprecated) 15: Citic Card (deprecated) 16: Citic Alipay (deprecated) 17: Citic WeChat (deprecated) 18: Citic QR Code (deprecated) 51: Cash 52: QR Payment (POS cashier QR code) 53: Xiaomao Card 58: Scan Payment 59: QR Payment (Yisheng cashier QR code, deprecated) 60: E-Money (deprecated) 61: Mobile POS (customer QR code scanned by Yisheng POS machine) 63: New World Activity Voucher 64: Others (POS only allows the methods marked in red) |
| Payment method name | payTypeNm | VARCHAR(500) | Yes | |
| Card type | cardType | VARCHAR(500) | ||
| Amount | amount | Double | 500 | Yes |
| Internal payment order number | posPayNo | VARCHAR(500) | Yes | |
| Merchant order number | merchantOrderNo | VARCHAR(500) | Yes | |
| Platform transaction number | platformTradeNo | VARCHAR(500) | Yes | |
| Peripheral identifier | SysFlg | CHAR(1) | 1-POS 2-SCHD 3-E-order 4-Shopex 5-UCO 6-LeQee 7-Judgment 8-Purchase | |
| Timestamp (current time) | Timestamp | datetime | Yes |
4.10.3 Return Value Examples
Success:
{
"status": "success",
"pageNo": 1,
"pageSize": 2,
"totalPages": 1,
"totalRecords": 1,
"data": [
{
"DocumentID": "DOC123456",
"shopCode": "SC001",
"shopName": "旗舰店",
"posNo": "1",
"deviceNo": "1",
"tradeNo": "TRADE123456",
"invoiceNumber": "INV123456",
"posTradeNo": "POSTRADE123456",
"saleType": "普通销售",
"tradeTime": "2024-11-26T10:30:00",
"businessDate": "2024-11-26",
"payTypeCode": "51",
"payTypeNm": "现金",
"cardType": "普通会员卡",
"amount": 150.75,
"posPayNo": "PAY123456",
"merchantOrderNo": "MORD123456",
"platformTradeNo": "PLTTRADE123456",
"SysFlg": "1",
"Timestamp": "2024-11-26T10:30:00"
}
]
}
Failure:
{
"status": "error",
"message": ""
}4.11 SAP confirms the document query
Request URL: /api/v1/outBound/getOrderConfirmation
Description: SAP confirms the document query
Request Type: HTTP GET
4.11.1 Request Parameters
| Field Description | Field Name | Type | Length | Required | Remarks |
|---|---|---|---|---|---|
| Page data entries | pageSize | INT | No | Fetch data by pages, entries per page. Defaults to 50 if not provided. | |
| Page number | pageNo | INT | No | Fetch data by pages, current page number. Starts from 1 (1 is the initial page). Defaults to page 1 if not provided. | |
| Document number | applyNo | VARCHAR | Optional | Example: 1504575834 | |
| SAP Shipto code | sapCustomerCd | VARCHAR | Optional | Example: 2200003451 | |
| SAP order code | sapOrderNo | VARCHAR | Optional | Example: 4203193399 | |
| Update time | updateTime | datetime | Optional | Retrieve data updated after (including) this time. Supports yyyy-MM-dd or yyyy-MM-dd HH:mm:ss. Example: 2023-09-15 18:06:32.447 |
Request Example:
`/api/v1/outBound/getOrderConfirmation?sapOrderNo=4205171130&pageSize=10&pageNo=1&updateTime=2024-10-31T12:02:23.767
4.11.2 Response Parameters
| Field Description | Field Name | Type | Required | Remarks |
|---|---|---|---|---|
| Return status | status | String | Yes | "success" indicates success, "error" indicates failure. |
| Current page number | pageNo | INT | Yes | |
| Entries per page | pageSize | INT | Yes | |
| Total pages | totalPages | INT | Yes | |
| Total entries | totalRecords | INT | Yes | |
| Data | data | array | Yes | Queried data. |
| Error message | message | String | No | Returned when status is "error". |
data
| Field Description | Field Name | Type | Required | Remarks |
|---|---|---|---|---|
| Document number | APPLYNO | char | RC-000035-005 | |
| SAP Shipto code | SAP_CUSTOMERCD | char | 2200003675 | |
| SAP order code | SAPORDERNO | char | 4205176582 | |
| product code | PRODUCTCD | char | 34501010 | |
| SAP Product Code | SAPPRODUCTCD | char | 34501010102CN | |
| Material identification number | DETERMINECODE | char | 34501010101CN | |
| Acknowledged quantity | ADMQNTY | int | 2 | |
| Update time | UPDATETIME | Datetime | 2024-12-23 12:00:42.720 |
4.11.3 Return Value Examples
Success:
{
"status": "success",
"pageNo": 1,
"pageSize": 10,
"totalPages": 1,
"totalRecords": 1,
"data": [
{
"APPLYNO": "4205171130 ",
"SAP_CUSTOMERCD": "2200004677",
"SAPORDERNO": "4205171130 ",
"PRODUCTCD": "34500509 ",
"SAPPRODUCTCD": "34500509101CN",
"DETERMINECODE": "34500509101CN",
"ADMQNTY": 30,
"UPDATETIME": "2024-10-31T12:02:23.767"
}
]
}
Failure:
{
"status": "error",
"message": ""
}