schm-sap-inbound-eapi

schm-sap-inbound-eapi

API Description: Mule receives SAP data for EAI
DEV URL (Development Environment): https://schm-api-dev.shiseido.cn/schm-sap-inbound-eapi/api/v1
UAT URL (Testing Environment): https://schm-api-test.shiseido.cn/schm-sap-inbound-eapi/api/v1
PROD URL (Production Environment): https://schm-api.shiseido.cn/schm-sap-inbound-eapi/api/v1

1. Authentication

All request headers must include the following key-value parameters as authentication information. You need to apply to the administrator for this information.

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-inbound-eapi/healthCheck
UAT Environment URL: https://schm-api-test.shiseido.cn/schm-sap-inbound-eapi/healthCheck
PROD Environment URL: https://schm-api.shiseido.cn/schm-sap-inbound-eapi/healthCheck

3. API Overview:

The complete URL is the corresponding environment URL + API endpoint, e.g.:

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

4. API Usage Instructions

4.1 ASN Outbound Data

API Endpoint: /inbound/asn
API Description: ASN outbound data
Request Method: HTTP POST

4.1.1 Parameter Description

4.1.2 Parameter Example

Note: Parameters should be passed in the original XML file format.

<?xml version="1.0" encoding="UTF-8" standalone="no"?><ns0:MT_SCH_POS_ASN xmlns:ns0="urn:shiseido.cn:4059:SCH:POS:ASN"><FileName>4000004059_ASN_20240924160445_a9498b857a4b11ef830b000006277757.xml</FileName><ASNHead><DeliveryNO>4405818696</DeliveryNO><DeliveryType>Z4LF</DeliveryType><OutStcYMD>20240919</OutStcYMD><APPLYNO>#</APPLYNO><CUSTOMERCD>2200003471</CUSTOMERCD><SAP_CREATEDATE>20240919</SAP_CREATEDATE><SAP_CREATETIME>093022</SAP_CREATETIME><PODStatus>C</PODStatus><ASNItem><POSNR>000010</POSNR><SAPPRODUCTCD>10217770802CN</SAPPRODUCTCD><PLACECD>7857</PLACECD><LGORT>W001</LGORT><ActualQty>2.000</ActualQty><PODActualQty>2.000</PODActualQty><DIEFQnty>0.000</DIEFQnty><MEINS>EA</MEINS><SAPAPPLYNO>4204953098</SAPAPPLYNO><VGPOS>000010</VGPOS><CHARG>4148EK</CHARG><ExpiryDate>20270527</ExpiryDate><PSTYV>TAN</PSTYV></ASNItem><ASNItem><POSNR>000020</POSNR><SAPPRODUCTCD>10116781801CN</SAPPRODUCTCD><PLACECD>7857</PLACECD><LGORT>W001</LGORT><ActualQty>10.000</ActualQty><PODActualQty>10.000</PODActualQty><DIEFQnty>0.000</DIEFQnty><MEINS>EA</MEINS><SAPAPPLYNO>4204953098</SAPAPPLYNO><VGPOS>000020</VGPOS><CHARG>3220PB</CHARG><ExpiryDate>20260808</ExpiryDate><PSTYV>TAN</PSTYV></ASNItem><ASNItem><POSNR>000030</POSNR><SAPPRODUCTCD>10119696802CN</SAPPRODUCTCD><PLACECD>7857</PLACECD><LGORT>W001</LGORT><ActualQty>10.000</ActualQty><PODActualQty>10.000</PODActualQty><DIEFQnty>0.000</DIEFQnty><MEINS>EA</MEINS><SAPAPPLYNO>4204953098</SAPAPPLYNO><VGPOS>000030</VGPOS><CHARG>4102G1</CHARG><ExpiryDate>20270411</ExpiryDate><PSTYV>TAN</PSTYV></ASNItem><ASNItem><POSNR>000040</POSNR><SAPPRODUCTCD>10117161802CN</SAPPRODUCTCD><PLACECD>7857</PLACECD><LGORT>W001</LGORT><ActualQty>20.000</ActualQty><PODActualQty>20.000</PODActualQty><DIEFQnty>0.000</DIEFQnty><MEINS>EA</MEINS><SAPAPPLYNO>4204953098</SAPAPPLYNO><VGPOS>000040</VGPOS><CHARG>4179S5</CHARG><ExpiryDate>20270627</ExpiryDate><PSTYV>TAN</PSTYV></ASNItem></ASNHead></ns0:MT_SCH_POS_ASN>

4.1.3 Return Value Description

4.1.4 Return Value Examples

// Success Example
{
    "status": "success",
    "DocumentIDs": ["e32df223333sadfewf"]
}
// Error Example
{
    "status": "error",
    "message": ""
}

4.2 Billing Document

Request Endpoint: /inbound/billing
API Description: Billing Document
Request Type: HTTP POST

4.2.1 Parameter Description

4.2.2 Parameter Example

Note: Parameters should be passed in the original XML format.

<?xml version="1.0" encoding="UTF-8" standalone="no"?><ns0:MT_SCH_POS_Billing xmlns:ns0="urn:shiseido.cn:7222:SCH:POS:Billing"><FileName>4000007222_Billing_20240924160903_430155b17a4c11ef9d00000006277757.xml</FileName><Billing><BillingNo>4805365087</BillingNo><BillingType>Z4S1</BillingType><SAP_SALESORGANIZATION>9Z21</SAP_SALESORGANIZATION><SAP_DISTRIBUTIONCHANNEL>11</SAP_DISTRIBUTIONCHANNEL><BillingYMD>20240924</BillingYMD><SAP_REGION>320</SAP_REGION><COMPANYCD>9Z2</COMPANYCD><SAP_PayerCD>23</SAP_PayerCD><SAP_SoldToCD>2100002932</SAP_SoldToCD><SAP_PayerNM>重庆百货大楼股份有限公司</SAP_PayerNM><CITY>重庆</CITY><SAP_LANGUAGE>ZH</SAP_LANGUAGE><LOCATION1>重庆市渝中区青年路18号10.11.14楼</LOCATION1><ContactNumber>023-63840281</ContactNumber><AccountingNO>4805365087</AccountingNO><SAPCUSTOMERCD>2200003284</SAPCUSTOMERCD><OriginBillingNO>4805364838</OriginBillingNO><Item><POSEX>000010</POSEX><BilledQuantity>1.000</BilledQuantity><Salesunit>EA</Salesunit><Netweight>293.000</Netweight><SAPPRODUCTCD>10119146803CN</SAPPRODUCTCD><ItemDescription>资生堂 悦薇珀翡紧颜亮肤乳</ItemDescription><PLANT>7857</PLANT><NetValue>1489865.04</NetValue><TaxAmount>193682.46</TaxAmount><PRODBARCODE1>729238191464</PRODBARCODE1><SAPORDERNO>4101984602</SAPORDERNO><POSEX_SO>000010</POSEX_SO><DeliveryNO>4101984602</DeliveryNO><COSNR>000010</COSNR><Materialentered>10119146803CN</Materialentered><WHOLEMNY>1683547.5</WHOLEMNY></Item></Billing></ns0:MT_SCH_POS_Billing>

4.2.3 Return Value Description

4.2.4 Example of Return Values

// Success Example
{
    "status": "success",
    "DocumentIDs": ["e32df223333sadfewf"]
}

// Error Example
{
    "status": "error",
    "message": ""
}

4.3 OrderConfirmation Confirmation Data

Request Endpoint: /inbound/business
Endpoint Description: OrderConfirmation Confirmation Data
Request Type: HTTP POST

4.3.1 Parameter Description

4.3.2 Parameter Example

Note: Pass parameters in the original XML file format.

<?xml version="1.0" encoding="UTF-8" standalone="no"?><ns0:MT_SCH_POS_SalesOrderConfirmation xmlns:ns0="urn:shiseido.cn:4650:SCH:POS:SalesOrderConfirmation"><FileName>4000004650_SalesOrderConfirmation_20240924164004_9828faeb7a5011efc578000006277756.xml</FileName><AckHead><SAPAPPLYNO>4204985229</SAPAPPLYNO><APPLYTYPE>Z4OR</APPLYTYPE><SAP_SALESORGANIZATION>9Z21</SAP_SALESORGANIZATION><COMPANYCD>9Z2</COMPANYCD><SalesOffice>CN01</SalesOffice><SalesGroup>301</SalesGroup><CustomerGroup1>Z202</CustomerGroup1><VDATU>20240924</VDATU><SOLDTOCODE>2100002543</SOLDTOCODE><SAP_CUSTOMERCD>2200003572</SAP_CUSTOMERCD><SAP_DOORCUSTOMER>2200003572</SAP_DOORCUSTOMER><APPLYNO>RC103000862024910</APPLYNO><APPLYYMD>20240924</APPLYYMD><CURCY>CNY</CURCY><DATE>20240924</DATE><TIME>043705</TIME><CREATETIME>20240924164004</CREATETIME><VSART>01</VSART><BETRG>4274.34</BETRG><AckItem><POSNR>000010</POSNR><SAPPRODUCTCD>15143249101CN</SAPPRODUCTCD><MaterialEntered>15143249101CN</MaterialEntered><ExchangeRate>1.00000</ExchangeRate><QNTY>21.000</QNTY><MEINS>EA</MEINS><PSTYV>TAPA</PSTYV><PLACECD>7857</PLACECD><NETVALUE>0.00</NETVALUE><Planning><APPLYRQNTY>21</APPLYRQNTY><ANMINQNTY>21.000</ANMINQNTY><ConfirmedDate>20240924</ConfirmedDate></Planning></AckItem><AckItem><POSNR>000011</POSNR><SAPPRODUCTCD>15143249101CN</SAPPRODUCTCD><MaterialEntered>15143249101CN</MaterialEntered><QNTY>21.000</QNTY><MEINS>EA</MEINS><PSTYV>TAN</PSTYV><PLACECD>7857</PLACECD><NETVALUE>3205.75</NETVALUE><Planning><APPLYRQNTY>21</APPLYRQNTY><ANMINQNTY>21.000</ANMINQNTY><ConfirmedDate>20240924</ConfirmedDate></Planning><Condition><ConditionType>ZRPI</ConditionType><Amount>230.00</Amount><ConditionAmount>4830.00</ConditionAmount><Currency>CNY</Currency><PREIS>EA</PREIS></Condition><Condition><ConditionType>ZTM1</ConditionType><Amount>-25.000</Amount><ConditionAmount>1068.59</ConditionAmount></Condition><Condition><ConditionType>MWST</ConditionType><Amount>13.000</Amount><ConditionAmount>416.75</ConditionAmount></Condition></AckItem></AckHead></ns0:MT_SCH_POS_SalesOrderConfirmation>

4.3.3 Return Value Description

4.3.4 Return Value Example

// Success Example
{
    "status": "success",
    "DocumentIDs": ["e32df223333sadfewf"]
}
// Error Example
{
    "status": "error",
    "message": ""
}

4.4 Direct Store Inbound Data

Request Interface: /inbound/delivery
Interface Description: Direct Store Inbound Data
Request Type: HTTP POST

4.4.1 Parameter Description

4.4.2 Parameter Example

Note: Parameters should be passed in the original XML file format.

<?xml version="1.0" encoding="UTF-8" standalone="no"?><ns0:MT_SCH_POS_InboundDelivery xmlns:ns0="urn:shiseido.cn:4043:SCH:POS:InboundDelivery"><FileName>4000004043_POS_20230615174625_7e25b23a0b6111eec941000006ab72d6.xml</FileName><IBDHead><DeliveryNO>4101009019</DeliveryNO><DeliveryType>Z4EL</DeliveryType><InStcYmd>2023</InStcYmd><SAP_VENDORCODE>0A78500010</SAP_VENDORCODE><SAP_VENDORNAME>Itochu main DC</SAP_VENDORNAME><APPLYTYPE_PO>Z4UB</APPLYTYPE_PO><APPLYNO_SO>4100997197</APPLYNO_SO><APPLYNO>#</APPLYNO><IBDItem><COSNR>000010</COSNR><SAPPRODUCTCD>10115502801CN</SAPPRODUCTCD><DESCRIBE>CPB RADIANT CUSHION FD I10</DESCRIBE><PLACECD>785Y</PLACECD><LGORT>FC13</LGORT><ActualQty>40.000</ActualQty><MEINS>EA</MEINS><APPLYNO_STO>4550080089</APPLYNO_STO><VGPOS>00001</VGPOS><CHARG>3005EN</CHARG><ExpiryDate>20260105</ExpiryDate></IBDItem><IBDItem><COSNR>000020</COSNR><SAPPRODUCTCD>10116297101CN</SAPPRODUCTCD><DESCRIBE>JSA.CPB SY LOTION N</DESCRIBE><PLACECD>785Y</PLACECD><LGORT>FC13</LGORT><ActualQty>10.000</ActualQty><MEINS>EA</MEINS><APPLYNO_STO>4550080089</APPLYNO_STO><VGPOS>00002</VGPOS><CHARG>2136EB</CHARG><ExpiryDate>20250516</ExpiryDate></IBDItem><IBDItem><COSNR>000030</COSNR><SAPPRODUCTCD>10217769801CN</SAPPRODUCTCD><DESCRIBE>CPB TRANSLUCENT LOOSE POWDER N2</DESCRIBE><PLACECD>785Y</PLACECD><LGORT>FC13</LGORT><ActualQty>2.000</ActualQty><MEINS>EA</MEINS><APPLYNO_STO>4550080089</APPLYNO_STO><VGPOS>00003</VGPOS><CHARG>2505</CHARG><ExpiryDate>20250501</ExpiryDate></IBDItem><IBDItem><COSNR>000040</COSNR><SAPPRODUCTCD>10118178802CN</SAPPRODUCTCD><DESCRIBE>CPB BRIGHTENING ENHANCER VEIL</DESCRIBE><PLACECD>785Y</PLACECD><LGORT>FC13</LGORT><ActualQty>10.000</ActualQty><MEINS>EA</MEINS><APPLYNO_STO>4550080089</APPLYNO_STO><VGPOS>00004</VGPOS><CHARG>2306TA</CHARG><ExpiryDate>20251102</ExpiryDate></IBDItem></IBDHead></ns0:MT_SCH_POS_InboundDelivery>

4.4.3 Return Value Description

4.4.4 Return Value Example

Success
{
    "status": "success",
    "DocumentIDs": ["e32df223333sadfewf"]
}
Failure
{
    "status": "error",
    "message": ""
}

4.5 Purchase Order Number Callback

Request API: /inbound/outboundStock
API Description: Purchase Order Number Callback
Request Type: HTTP POST

4.5.1 Parameter Description

4.5.2 Parameter Example

Note: Pass parameters in the original XML file format.

<?xml version="1.0" encoding="UTF-8" standalone="no"?><ns1:MT_SCH_IntraMart_OutboundStockMvmtGR xmlns:ns1="urn:shiseido.cn:5695:SCH:IntraMart:OutboundStockMvmtGR"><FileName>4000005695_OutboundStockMvmtGR_20240105110012_8afe082bab7611ee9335000006277757.xml</FileName><DocHead><DocDate>20240105</DocDate><PostingDate>20240105</PostingDate><CreateDate>20240104</CreateDate><CreateTime>220008</CreateTime><BKTXT>PO2311207</BKTXT><ProDoc>5003780718</ProDoc><ProDocYear>2024</ProDocYear><DocItem><Lineno>0001</Lineno><VendorCode>2100003079</VendorCode><PONo>4560010994</PONo><POItemno>00010</POItemno><NPSPONo>PO2311207</NPSPONo><SAPPRODUCTCD>78702537101</SAPPRODUCTCD><Qnty>10000.000</Qnty><ERFME>EA</ERFME><Plant>785B</Plant><LGORT>W001</LGORT><MoveType>101</MoveType></DocItem></DocHead></ns1:MT_SCH_IntraMart_OutboundStockMvmtGR>

4.5.3 Return Value Description

4.5.4 Return Value Example

Success
{
    "status": "success",
    "DocumentIDs": ["e32df223333sadfewf"]
}
Failure
{
    "status": "error",
    "message": ""
}