schm-mdm-eapi
home
schm-mdm-eapi
Interface Description: Retrieve MDM data through MuleSoft interfaces, such as master data, quota data, etc.
DEV Environment URL (Development): https://schm-api-dev.shiseido.cn/schm-mdm-eapi
UAT Environment URL (Testing): https://schm-api-test.shiseido.cn/schm-mdm-eapi
PROD Environment URL (Production): https://schm-api.shiseido.cn/schm-mdm-eapi
1.Authentication
All request headers must include the following key-value parameters for authentication. You need to request these credentials from the administrator.
client_id: fa98****3452
client_secret: 108b****41f2
2.Interface Overview:
Endpoint | 描述 |
---|---|
/master/customer | Retrieve Customer master data |
/master/product | Retrieve Product master data |
/master/hygienePermit | Retrieve Product master data |
/master/vendor | Retrieve Product master data |
/master/quota | Retrieve Quota master data |
/master/quotaCalculate | Retrieve Quota Calculation master data |
/master/stockOnHandPlant | Stock-on-hand master data |
/master/productPrice | Retrieve Product Price master data |
/master/inboundDelivery | Retrieve SAP Inbound Delivery master data |
/master/materialSuitMain | Retrieve Store Virtual Suit and other Material master data |
/master/materialSuitSub | Retrieve Store Virtual Suit Details master data |
/master/businessCustomer | Get customer Master data (fro business) master data |
/master/cusEmployeeMapping | Retrieve Store Staff-Store Relationship master data |
/master/empstruct | Retrieve Headquarter Staff Sales Role master data |
/master/structMaster | Retrieve Brand and Regional Structure master data |
/master/materialSuitInfo | Retrieve Material Group Set Relationships |
/master/subUnit | Retrieve Office Main Table |
/master/brand | Master data: local brand |
/master/localbeamtd1 | Master data: Local beauty method 1 |
/master/localbeamtd2 | Master data: Local beauty method 2 |
/master/localbeamtd3 | Master data: Local beauty method 3 |
/master/custSubCategory | Master data: Custom classification subcategories |
/master/custSubLineCategory | Master data: Product custom classification relationship table |
The full call address is the corresponding environment URL + interface endpoint. For example, the endpoint to retrieve Customer master data in the testing environment is:
https://schm-api-test.shiseido.cn/schm-mdm-eapi/master/customer
3.Interface Call Instructions
3.1 Retrieve Customer Master Data
Endpoint: /master/customer
Description: Retrieve Customer Master Data
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
updateTime | N | Retrieve data updated after (including) the specified time. Format: yyyy-MM-dd (e.g., 2024-05-01) or yyyy-MM-dd HH:mm:ss (e.g., 2024-05-01 09:30:00). |
Request example:
/master/customer?pageSize=20&pageNo=10&updateTime=2024-05-01
Response Parameters:
Field | Type | Length | Description | Example |
---|---|---|---|---|
COMPANYCD | char | 3 | Company code | 785 |
DELFLG | char | 1 | Termination flag (1: terminated) | 1 |
CUSTOMERCD | char | 10 | Customer code (Ship to) | 4100000000 |
SHOPSIGNNM | char | 80 | Shop sign name | Wuhan Watsons personal goods Store Co., LTD |
SHOPADR | char | 80 | Address (Ship to) | No. B503, No. B504, No. B606, No. 5, Building B, No. 48, Budu Avenue, Hanyang District, Wuhan |
SIDECD | char | 3 | Province code | 001 |
SIDENM | char | 40 | Province | Beijing |
AREACD | char | 3 | City code | 001 |
AREANM | char | 40 | City | Beijing |
SHOPPOSTCD | char | 10 | Postal code | 100000 |
SHOPTEL | char | 30 | Phone number | |
SHOPFAX | char | 30 | Fax number | |
NAME_CO | char | 80 | C/O contract person | |
CustomerGroup1 | char | 3 | POS distinction 201 SMILE POS 202 PS POS 203 E-order 204 CS POS 205 SCHD 206 Others 207 OMS 208 ONECX | 203 |
PODFLG | char | 1 | POD flag | 1 |
PODCONFIRMTIME | char | 11 | POD auto-confirm timestamp | |
FSS_LOCATIONID | char | 60 | FSS Sloc number | |
UPDATETIME | char | 8 | Update time | |
OldCUSTOMERCD | char | 10 | Code of surrounding stores | 2200004137 |
SalesCompany | char | 3 | sales company | 9Z2 |
Sample Response:
[
{
"COMPANYCD": "785",
"DELFLG": "0",
"CUSTOMERCD": "2200004137",
"SHOPSIGNNM": "LM天猫官方旗舰店(新)",
"SHOPADR": "上海市金山区天工路285弄恒信科技产业园28号口",
"SIDECD": "003",
"SIDENM": "上海市",
"AREACD": "076",
"AREANM": null,
"SHOPPOSTCD": "310051",
"SHOPTEL": "18916792980",
"SHOPFAX": null,
"NAME_CO": null,
"CustomerGroup1": "207",
"PODFLG": "1",
"PODCONFIRMTIME": "720000",
"FSS_LOCATIONID": "785BW001",
"UPDATETIME": "2024-06-04T23:00:37.08",
"OldCUSTOMERCD": "2200004137"
},
{
"COMPANYCD": "785",
"DELFLG": "0",
"CUSTOMERCD": "2200004137",
"SHOPSIGNNM": "LM天猫官方旗舰店(新)",
"SHOPADR": "上海市金山区天工路285弄恒信科技产业园28号口",
"SIDECD": "003",
"SIDENM": "上海市",
"AREACD": "076",
"AREANM": null,
"SHOPPOSTCD": "310051",
"SHOPTEL": "18916792980",
"SHOPFAX": null,
"NAME_CO": null,
"CustomerGroup1": null,
"PODFLG": "1",
"PODCONFIRMTIME": "720000",
"FSS_LOCATIONID": "785BW001",
"UPDATETIME": "2024-06-04T23:00:37.047",
"OldCUSTOMERCD": "2200004137"
},
{
"COMPANYCD": "785",
"DELFLG": "0",
"CUSTOMERCD": "2200003705",
"SHOPSIGNNM": "NARS上海久光中心",
"SHOPADR": "上海市静安区共和新路2188号大宁久光中心1楼M102号铺NARS专柜",
"SIDECD": "003",
"SIDENM": "上海市",
"AREACD": "076",
"AREANM": null,
"SHOPPOSTCD": "200040",
"SHOPTEL": null,
"SHOPFAX": null,
"NAME_CO": null,
"CustomerGroup1": "202",
"PODFLG": "1",
"PODCONFIRMTIME": "0",
"FSS_LOCATIONID": null,
"UPDATETIME": "2024-06-03T23:00:34.547",
"OldCUSTOMERCD": "10700057"
}
]
3.2 Retrieve Product Master Data
Endpoint: /master/product
Description: Retrieve Product master data
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
MDMUPDATETIME | N | Retrieve data updated after (including) the specified time. Format: yyyy-MM-dd (e.g., 2024-05-01) or yyyy-MM-dd HH:mm:ss (e.g., 2024-05-01 09:30:00). |
SAPPRODUCTCD | N | Search by SAP product codes, separated by commas if multiple. |
BRAND | N | Search by brand codes, separated by commas if multiple. |
InvalidFLG | N | Search by Invalid Flag (11D). |
Request example:
/master/product?pageSize=20&pageNo=10&MDMUPDATETIME=2024-05-01&SAPPRODUCTCD=10111379301,10111379302
Response Parameters:
Field | Type | Length | Description | Example |
---|---|---|---|---|
COMPANYCD | CHAR | 3 | Company code | |
SAPPRODUCTCD | CHAR | 18 | SAP Product Code | |
PRODUCTCD | CHAR | 8 | Product code | |
PRODCHINM | CHAR | 100 | Product Chinese name | |
PRODENGNM | CHAR | 100 | Product name | |
PRODFLG | CHAR | 2 | Product distinguishing mark | |
PRODFLGNM | CHAR | 20 | Product distinguishing name | |
BRAND | char | 2 | Brand code | |
BRANDNM | CHAR | 80 | Product level name | |
LINE | CHAR | 4 | LINE | |
LINENM | CHAR | 80 | New brand name | |
SUBLINE | CHAR | 4 | SUBLINE | |
SUBLINENM | CHAR | 80 | New product family name | |
MDMUPDATETIME | DATETIME | MDM update time | ||
PRODBARCODE1 | CHAR | 18 | Product bar code | |
MAILINNO | INT | Packing specification | ||
Length | NVARCHAR | 13 | Length | |
Width | NVARCHAR | 13 | breadth | |
Height | NVARCHAR | 13 | Altitude | |
BusinessVolume | NVARCHAR | 13 | volume | |
PK_MAILINNO | INT | Medium size | ||
PK_Length | NVARCHAR | 13 | Medium package length | |
PK_Width | NVARCHAR | 13 | Middle package width | |
PK_Height | NVARCHAR | 13 | Medium packing height | |
PK_BusinessVolume | NVARCHAR | 13 | Medium package volume | |
MAILINNOBIG | INT | Large package size | ||
KAR_Length | NVARCHAR | 13 | Large package length | |
KAR_Width | NVARCHAR | 13 | Large package width | |
KAR_Height | NVARCHAR | 13 | Large package height | |
KAR_BusinessVolume | NVARCHAR | 13 | Large package volume | |
MEINS | CHAR | 3 | Basic unit of measure | |
PRODUCTAVAIL | INT | Global shelf life | ||
LifeDateFlag | CHAR | 1 | Period identification | |
LocalPRODUCTAVAIL | INT | Local shelf life | ||
BATCHFLG | CHAR | 1 | Batch management mark | |
NetContent | float | Net content | ||
NetContentUnits | CHAR | 3 | Net content unit | |
ReferenceFLG | char | 1 | One thing, one code | |
InvalidFLG | CHAR | 1 | 11D Invalid identifier | |
SALETYPE1 | CHAR | 3 | Sales type1 | |
SALETYPE1NM | CHAR | 80 | Sales type1 Name | |
SALETYPE2 | CHAR | 4 | Sales type2 | |
SALETYPE2NM | CHAR | 80 | Sales type2 name | |
SALETYPE3 | CHAR | 6 | Sales Type 3 | |
SALETYPE3NM | CHAR | 80 | Sales Type 3 Name | |
DETERMINECODE | CHAR | 13 | Material identification number | |
STARTYMD | DATETIME | Sales start date | ||
RPRICEMNY | MONEY | Retail unit price | ||
NoUseFlg | CHAR | 1 | You are advised to stop using labels for surrounding materials | |
ORDERSTOPTIME | DATETIME | Closing date of bets | ||
RelabelFLG | CHAR | 1 | Labeling mark | |
MaterialType | CHAR | 4 | Material type | |
ENDYMD | DATETIME | Sales stop date | ||
LOCALBEAMTDCD1 | CHAR | 1 | Spot Beauty Method 1 code | |
LOCALBEAMTDCD1NM | CHAR | 80 | 1 place beauty law | |
LOCALBEAMTDCD2 | CHAR | 2 | Spot Beauty Method 2 code | |
LOCALBEAMTDCD2NM | CHAR | 80 | Local beauty method 2 | |
LOCALBEAMTDCD3 | CHAR | 3 | Spot Beauty Method 3 code | |
LOCALBEAMTDCD3NM | CHAR | 80 | Local beauty method 3 | |
LOCALBRANDCD | CHAR | 4 | Local brand code | |
LOCALBRANDNM | CHAR | 20 | Local brand name | |
PRODUCTHIERARCHYLV4 | CHAR | 2 | The New Beauty Method 1 | |
PRODUCTHIERARCHYLV4NM | CHAR | 80 | New beauty method 1 | |
PRODUCTHIERARCHYLV45 | CHAR | 4 | New Beauty Law 2 | |
PRODUCTHIERARCHYLV45NM | CHAR | 80 | New beauty method 2 | |
PRODUCTHIERARCHYLV456 | CHAR | 6 | New beauty regimen 3 | |
PRODUCTHIERARCHYLV456NM | CHAR | 80 | New beauty method 3 | |
PRODINFLG | CHAR | 1 | Area mark | |
DELFLG | CHAR | 1 | Delete flag | |
OrderENDYMD | DATETIME | Closing date | ||
DETERMINEFLG | CHAR | 1 | Material identification mark | |
MSTAE | CHAR | 2 | 7857 Material Status | |
associate_Z001 | varchar | 13 | Associated with Z001 material identification number | |
POSM_AUTO_FLG | CHAR | 1 | POSM calculates FLG | 0- Automatically calculate the value; 1- Manually calculate the value; 2- Remove products from shelves; 3- No need for value; 9- No automatic calculation for now |
POSMValue | money | 1 | POSM value |
Sample Response:
[
{
"COMPANYCD": "785",
"SAPPRODUCTCD": "10113681802CN",
"PRODUCTCD": "13681",
"PRODCHINM": "吾诺保湿调理乳(滋润型)",
"PRODENGNM": "VGB.UNOSKINCARETANKMOIST",
"PRODFLG": "01",
"PRODFLGNM": "成品",
"BRAND": "5A",
"BRANDNM": "UNO",
"LINE": "5AHE",
"LINENM": "UNOPERSONALCARE",
"SUBLINE": "5AHE10",
"SUBLINENM": "UNOPERSONALCARE",
"MDMUPDATETIME": "2023-12-05T07:35:23.183",
"PRODBARCODE1": "4909978136819",
"MAILINNO": 0,
"Length": "0.000",
"Width": "0.000",
"Height": "0.000",
"BusinessVolume": "0.000",
"PK_MAILINNO": 36,
"PK_Length": "25.000",
"PK_Width": "54.000",
"PK_Height": "16.500",
"PK_BusinessVolume": "22275.000",
"MAILINNOBIG": null,
"KAR_Length": null,
"KAR_Width": null,
"KAR_Height": null,
"KAR_BusinessVolume": null,
"MEINS": "EA",
"PRODUCTAVAIL": 1,
"LifeDateFlag": "D",
"LocalPRODUCTAVAIL": 1095,
"BATCHFLG": "1",
"NetContent": 160,
"NetContentUnits": "ML",
"ReferenceFLG": "0",
"InvalidFLG": "0",
"SALETYPE1": "10",
"SALETYPE1NM": "SALEABLEPRODUCT",
"SALETYPE2": "1010",
"SALETYPE2NM": "Basic",
"SALETYPE3": "101010",
"SALETYPE3NM": "Single-basic",
"DETERMINECODE": "10113681803CN",
"STARTYMD": "2019-02-01T00:00:00",
"RPRICEMNY": 78,
"NoUseFlg": null,
"ORDERSTOPTIME": "2023-01-01T00:00:00",
"RelabelFLG": "0",
"MaterialType": "Z001",
"ENDYMD": null,
"LOCALBEAMTDCD1": "1",
"LOCALBEAMTDCD1NM": "护肤",
"LOCALBEAMTDCD2": "NN",
"LOCALBEAMTDCD2NM": "无",
"LOCALBEAMTDCD3": "008",
"LOCALBEAMTDCD3NM": "护肤-乳液",
"LOCALBRANDCD": "7001",
"LOCALBRANDNM": "FT",
"PRODUCTHIERARCHYLV4": "C1",
"PRODUCTHIERARCHYLV4NM": null,
"PRODUCTHIERARCHYLV45": "C130",
"PRODUCTHIERARCHYLV45NM": null,
"PRODUCTHIERARCHYLV456": "C13020",
"PRODUCTHIERARCHYLV456NM": null,
"PRODINFLG": "0",
"DELFLG": "0",
"OrderENDYMD": null,
"DETERMINEFLG": "0",
"MSTAE": "4H"
},
{
"COMPANYCD": "785",
"SAPPRODUCTCD": "10113685801CN",
"PRODUCTCD": "13685",
"PRODCHINM": "吾诺保湿调理乳(清爽型)",
"PRODENGNM": "VGA.UNOSKINCARETANKOILCONTROL",
"PRODFLG": "01",
"PRODFLGNM": "成品",
"BRAND": "5A",
"BRANDNM": "UNO",
"LINE": "5AHE",
"LINENM": "UNOPERSONALCARE",
"SUBLINE": "5AHE10",
"SUBLINENM": "UNOPERSONALCARE",
"MDMUPDATETIME": "2023-12-05T07:35:23.183",
"PRODBARCODE1": "4909978136857",
"MAILINNO": 0,
"Length": "0.000",
"Width": "0.000",
"Height": "0.000",
"BusinessVolume": "0.000",
"PK_MAILINNO": 36,
"PK_Length": "25.000",
"PK_Width": "54.000",
"PK_Height": "16.500",
"PK_BusinessVolume": "22275.000",
"MAILINNOBIG": null,
"KAR_Length": null,
"KAR_Width": null,
"KAR_Height": null,
"KAR_BusinessVolume": null,
"MEINS": "EA",
"PRODUCTAVAIL": 1,
"LifeDateFlag": "D",
"LocalPRODUCTAVAIL": 1095,
"BATCHFLG": "1",
"NetContent": 160,
"NetContentUnits": "ML",
"ReferenceFLG": "1",
"InvalidFLG": "0",
"SALETYPE1": "10",
"SALETYPE1NM": "SALEABLEPRODUCT",
"SALETYPE2": "1010",
"SALETYPE2NM": "Basic",
"SALETYPE3": "101010",
"SALETYPE3NM": "Single-basic",
"DETERMINECODE": "10113685803CN",
"STARTYMD": "2019-02-01T00:00:00",
"RPRICEMNY": 78,
"NoUseFlg": null,
"ORDERSTOPTIME": "2023-01-01T00:00:00",
"RelabelFLG": "0",
"MaterialType": "Z001",
"ENDYMD": null,
"LOCALBEAMTDCD1": "1",
"LOCALBEAMTDCD1NM": "护肤",
"LOCALBEAMTDCD2": "NN",
"LOCALBEAMTDCD2NM": "无",
"LOCALBEAMTDCD3": "008",
"LOCALBEAMTDCD3NM": "护肤-乳液",
"LOCALBRANDCD": "7001",
"LOCALBRANDNM": "FT",
"PRODUCTHIERARCHYLV4": "C1",
"PRODUCTHIERARCHYLV4NM": null,
"PRODUCTHIERARCHYLV45": "C130",
"PRODUCTHIERARCHYLV45NM": null,
"PRODUCTHIERARCHYLV456": "C13020",
"PRODUCTHIERARCHYLV456NM": null,
"PRODINFLG": "0",
"DELFLG": "0",
"OrderENDYMD": null,
"DETERMINEFLG": "0",
"MSTAE": "4H"
},
{
"COMPANYCD": "785",
"SAPPRODUCTCD": "10113685802CN",
"PRODUCTCD": "13685",
"PRODCHINM": "吾诺保湿调理乳(清爽型)",
"PRODENGNM": "VGB.UNOSKINCARETANKOILCONTROL",
"PRODFLG": "01",
"PRODFLGNM": "成品",
"BRAND": "5A",
"BRANDNM": "UNO",
"LINE": "5AHE",
"LINENM": "UNOPERSONALCARE",
"SUBLINE": "5AHE10",
"SUBLINENM": "UNOPERSONALCARE",
"MDMUPDATETIME": "2023-12-05T07:35:23.183",
"PRODBARCODE1": "4901872449729",
"MAILINNO": 0,
"Length": "0.000",
"Width": "0.000",
"Height": "0.000",
"BusinessVolume": "0.000",
"PK_MAILINNO": 36,
"PK_Length": "25.000",
"PK_Width": "54.000",
"PK_Height": "16.500",
"PK_BusinessVolume": "22275.000",
"MAILINNOBIG": null,
"KAR_Length": null,
"KAR_Width": null,
"KAR_Height": null,
"KAR_BusinessVolume": null,
"MEINS": "EA",
"PRODUCTAVAIL": 1,
"LifeDateFlag": "D",
"LocalPRODUCTAVAIL": 1095,
"BATCHFLG": "1",
"NetContent": 160,
"NetContentUnits": "ML",
"ReferenceFLG": "0",
"InvalidFLG": "0",
"SALETYPE1": "10",
"SALETYPE1NM": "SALEABLEPRODUCT",
"SALETYPE2": "1010",
"SALETYPE2NM": "Basic",
"SALETYPE3": "101010",
"SALETYPE3NM": "Single-basic",
"DETERMINECODE": "10113685803CN",
"STARTYMD": "2019-02-01T00:00:00",
"RPRICEMNY": 78,
"NoUseFlg": null,
"ORDERSTOPTIME": "2023-01-01T00:00:00",
"RelabelFLG": "0",
"MaterialType": "Z001",
"ENDYMD": null,
"LOCALBEAMTDCD1": "1",
"LOCALBEAMTDCD1NM": "护肤",
"LOCALBEAMTDCD2": "NN",
"LOCALBEAMTDCD2NM": "无",
"LOCALBEAMTDCD3": "008",
"LOCALBEAMTDCD3NM": "护肤-乳液",
"LOCALBRANDCD": "7001",
"LOCALBRANDNM": "FT",
"PRODUCTHIERARCHYLV4": "C1",
"PRODUCTHIERARCHYLV4NM": null,
"PRODUCTHIERARCHYLV45": "C130",
"PRODUCTHIERARCHYLV45NM": null,
"PRODUCTHIERARCHYLV456": "C13020",
"PRODUCTHIERARCHYLV456NM": null,
"PRODINFLG": "0",
"DELFLG": "0",
"OrderENDYMD": null,
"DETERMINEFLG": "0",
"MSTAE": "4H"
}
]
3.3 Obtain HygienePermit master data
Endpoint: /master/hygienePermit
Description: Used to obtain HygienePermit master data
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
updateTime | N | The time when the master data was last updated. The interface filters the data updated after this time (including this time). The format is yyyy-MM-dd, for example, 2024-05-01, or yyyy-MM-dd HH:mm:ss, for example, 2024-05-01 09:30:00. Note that this is not the HygienePermitExpiryDate. |
Request example:
/master/hygienePermit?pageSize=20&pageNo=10&updateTime=2024-05-01
Response Parameters:
Field | Type | Length | Description | Example |
---|---|---|---|---|
SAPPRODUCTCD | nvarchar | 13 | product code | 10100047000 |
HygienePermitNumber | nvarchar | 40 | HP information | 国妆特进字J20191876 |
HygienePermitExpiryDate | datetime | expiration time | 2027-10-30 00:00:00.000 | |
UPDATETIME | datetime | Update Date |
Sample Response:
[
{
"SAPPRODUCTCD": "10113448801",
"HygienePermitNumber": "国妆网备进字(沪)2020006339",
"HygienePermitExpiryDate": "2099-12-31T00:00:00",
"PRODCHINM": "怡丽丝尔 肌源焕活 弹力凝粹乳",
"UPDATETIME": "2024-02-01T16:18:38"
},
{
"SAPPRODUCTCD": "10118081102",
"HygienePermitNumber": "国妆网备进字(沪)2020010034",
"HygienePermitExpiryDate": "2099-12-31T00:00:00",
"PRODCHINM": "御银座 柔澈洁颜油 P",
"UPDATETIME": "2024-02-01T16:18:38"
},
{
"SAPPRODUCTCD": "10118178803",
"HygienePermitNumber": null,
"HygienePermitExpiryDate": null,
"PRODCHINM": "CPB-肌肤之钥 光透白焕采妆前乳",
"UPDATETIME": "2024-02-01T16:18:38"
}
]
3.4 Obtain the Vendor master data
Endpoint: /master/vendor
Description: This command is used to obtain the Vendor master data
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
updateTime | N | Master data last updated time (DataYmd), the interface filters the data updated after this time (including this time). The format is yyyy-MM-dd, for example, 2024-05-01, or yyyy-MM-dd HH:mm:ss, for example, 2024-05-01 09:30:00 |
Request example:
/master/vendor?pageSize=20&pageNo=10&updateTime=2024-05-01
Response Parameters:
Field | Type | Length | Description | Example |
---|---|---|---|---|
VendorCode | CHAR | 10 | Vendor | 3100001411 |
AccountGroup | CHAR | 4 | Account Group | Z001 |
Country | CHAR | 3 | Country | CN |
Name1 | CHAR | 70 | Name 1 | Bean Media Group Pty Ltd |
Name2 | CHAR | 70 | Name 2 | |
City | CHAR | 70 | City | 上海市 |
PostalCode | CHAR | 10 | Postal Code | 210000 |
Region | CHAR | 3 | Region | 020 |
Street | CHAR | 70 | Street | 黄浦区淮海中路1号柳林大厦26层 |
Telephone | CHAR | 30 | Telephone | 69504873 |
Fax | CHAR | 31 | Fax | 69504873 |
CompanyCode | CHAR | 3 | Company Code | 785 |
PurchasingOrganization | CHAR | 4 | Purchasing Organization | 2001 |
DataYmd | CHAR | 8 | Update Date | 20220520 |
Sample Response:
[
{
"VendorCode": "0A78200001",
"AccountGroup": "Z007",
"Country": "US",
"Name1": "ADC PLANT",
"Name2": null,
"City": "Groveport",
"PostalCode": "43125",
"Region": "OH",
"Street": "5271 Centerpoint Pkwy",
"Telephone": null,
"Fax": null,
"CompanyCode": "785",
"PurchasingOrganization": "2001",
"DataYmd": "2024-06-03T23:00:42.967"
},
{
"VendorCode": "0A78200000",
"AccountGroup": "Z007",
"Country": "US",
"Name1": "Shiseido Americas Corporation",
"Name2": null,
"City": "New York",
"PostalCode": "10017",
"Region": null,
"Street": "390 Madison Avenue, 19F",
"Telephone": "1-212-805-2300",
"Fax": null,
"CompanyCode": "785",
"PurchasingOrganization": "2001",
"DataYmd": "2024-06-02T23:00:52.503"
},
{
"VendorCode": "0A10000010",
"AccountGroup": "Z007",
"Country": "JP",
"Name1": "SHISEIDO CO JDC East.",
"Name2": null,
"City": "Iruma",
"PostalCode": "3540045",
"Region": "11",
"Street": "Miyoshi, Kamitome, 247",
"Telephone": null,
"Fax": null,
"CompanyCode": "785",
"PurchasingOrganization": "2001",
"DataYmd": "2024-05-27T11:46:19.31"
}
]
3.5 Obtain the master data of quota management
Endpoint: /master/quota
Description: This parameter is used to obtain the master data of quota management
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
QuotaYMD | Y | Quota date (QuotaYMD). The format is yyyy-MM-dd. This parameter is used to query quota data of a month. Therefore, set the time to the first day of the month, for example, 2024-05-01 |
QuotaChannel | Y | Query by channel. Multiple query conditions can be separated by commas (,) |
BRAND | N | Search by brand is optional. Multiple search conditions can be separated by commas (,) |
DETERMINECODE | N | You can search by material identification number. Multiple search conditions can be separated by commas (,) |
Request example:
/master/quota?pageSize=20&pageNo=10&BRAND=41&QuotaYMD=2024-01-01&QuotaChannel=202
Response Parameters:
Field | Type | Length | Description | Example |
---|---|---|---|---|
QuotaChannel | VARCHAR | 3 | Channel 202: POS (Department Store POS) 2A2: CN_CHAIN STORE 2A3: CN_DISTRIBUTOR 2A6: OMS-CN_BRAND.COM (Official Website) 2A7: OMS-CN_EC_RETAIL_TMALL (Tmall) 2A9: OMS-CN_EC_RETAIL_TIKTOK (Douyin) 2B0: OMS-CN_EC_RETAIL_OTHERS 2B1: CN_EC_WHOLES_TMALL 2B2: CN_EC_WHOLES_JD 2B3: CN_EC_WHOLES_TIKTOK 2B4: CN_EC_WHOLES_OTHERS 2B9: OUTLETS 2C0: CN_AIRPORT STORE 2C6: CN_BEAUTY STORE 2C7: CN_PHARMACY | 206 |
BRAND | CHAR | 2 | Brand | 41 |
DETERMINECODE | VARCHAR | 13 | Material Determination Code | 74253430801 |
InitialQuota | INT | Initial Quota | 100 | |
UpdateInitialQuota | INT | Manually Adjusted Quota | 100 | |
Quota | INT | Quota | 100 | |
UPDATEMAN | VARCHAR | 20 | Updated By | EAI |
UPDATETIME | DATETIME | 8 | Data Update Time | 2024-06-03 12:11:34.000 |
CREATEMAN | VARCHAR | 20 | Created By | EAI |
CREATETIME | DATETIME | 8 | Creation Time | 2024-06-03 12:11:34.000 |
EAI_UPDATETIME | DATETIME | EAI Calculation Update Time | 2024-06-04 15:00:00.000 | |
QuotaYMD | DATETIME | Quota Date | 2023-01-01 00:00:00.000 |
Sample Response:
[
{
"QuotaChannel": "202",
"BRAND": "46",
"DETERMINECODE": "34502473101CN",
"InitialQuota": null,
"UpdateInitialQuota": 1000,
"Quota": 943,
"UPDATEMAN": "Excel导入",
"UPDATETIME": "2024-07-15T11:55:04",
"CREATEMAN": "Excel导入",
"CREATETIME": "2024-07-15T11:05:06",
"EAI_UPDATETIME": "2024-07-29T14:00:59.703",
"QuotaYMD": "2024-07-01T00:00:00"
},
{
"QuotaChannel": "202",
"BRAND": "46",
"DETERMINECODE": "34503753101CN",
"InitialQuota": null,
"UpdateInitialQuota": 300,
"Quota": 3,
"UPDATEMAN": "30010301",
"UPDATETIME": "2024-07-18T10:20:07",
"CREATEMAN": "Excel导入",
"CREATETIME": "2024-07-15T11:05:07",
"EAI_UPDATETIME": "2024-07-19T17:23:29.753",
"QuotaYMD": "2024-06-01T00:00:00"
}
]
3.6 Obtain the master data of quota calculation
Endpoint: /master/quotaCalculate
Description: This parameter is used to obtain the master data of quota calculation
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
updateTime | N | Update Time (UPDATETIME), the last update time. The interface filters data updated after (including) this time. Format: yyyy-MM-dd, e.g., 2024-05-01, or yyyy-MM-dd HH:mm:ss, e.g., 2024-05-01 09:30:00 |
APPLYYMD | Y | Query by quota date. Format: yyyy-MM-dd, e.g., 2024-05-01. Filters data from this date (inclusive) onwards |
QuotaChannel | Y | Query by channel |
APPLYNO | N | Optional query by document number |
STATUS | N | Optional query by document status |
TemplateFlg | N | Optional query by template upload flag |
Request example:
/master/quotaCalculate?pageSize=20&pageNo=10&APPLYYMD=2024-01-01&QuotaChannel=206
Response Parameters:
Field | Type | Length | Description | Example(Sample is normally deducted) | Example(Only EAI uses the reverse calculation Sample) |
---|---|---|---|---|---|
ID | Auto-increment primary key | 58 | 59 | ||
APPLYNO | char | 35 | Document number | RC0016339129 | RC0016339129 |
BusinessType | VARCHAR | 3 | Business type 10 - Order (Quota reduction) 11 - Return to warehouse (Quota increase) 99 - Template import | 11 | 11 |
APPLYYMD | datetime | Quota date. Used to match quota month yyyy-mm-dd, taking the current month (quota calculation considers the current month). The quota date for outgoing stock deducts the quota for the application date's month | 2023-01-16 | 2023-01-16 | |
QuotaChannel | VARCHAR | 3 | Channel 202: POS (Department Store POS) 203: E-order (Watsons) 204: CS POS (Hidden) 205: SCHD (Distributor) 206: Others (Hidden) 2A6: OMS-CN_BRAND.COM (Official Website) 2A7: OMS-CN_EC_RETAIL_TMALL (Tmall) 2A9: OMS-CN_EC_RETAIL_TIKTOK (Douyin) 2B0: OMS-CN_EC_RETAIL_OTHERS 2B9: OUTLETS | 206 | 206 |
BRAND | char | 2 | Brand | 14 | 14 |
SAP_CUSTOMERCD | VARCHAR | 10 | SAP Ship-to code | 2200003434 | 2200003434 |
DETERMINECODE | char | 13 | Material determination number | 74253430801 | 74253430801 |
ActualQNTY | INT | Actual allocated quota quantity Quantity pushed to SAP, also the quantity involved in calculations | 100 | -100 | |
STATUS | char | 1 | Document status 1 - Order 2 - Outbound 3 - POD 7 - Template import 8 - Reverse calculation (used for filtering in query history) 9 - Quota below minimum order quantity | 1 | 8 |
NOTE | VARCHAR | 500 | Remarks. Used to describe the scenario | Quota insufficient, allocated all remaining quota | Return ID: 【58】Quota deduction |
UPDATETIME | datetime | 8 | Update time | 2024-06-04 11:08:19.387 | 2024-06-04 11:08:51.720 |
TemplateFlg | char | 1 | Template upload flag 1 - Template upload 0 - Document calculation | 0 | 0 |
Sample Response:
Pending replenishment
3.7 Obtain factory-level inventory in stock
Endpoint: /master/stockOnHandPlant
Description: Used to obtain factory-level inventory in the library
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
updateTime | N | Update Time (UPDATETIME), the last update time. The interface filters data updated after (including) this time. Format: yyyy-MM-dd, e.g., 2024-05-01, or yyyy-MM-dd HH:mm:ss, e.g., 2024-05-01 09:30:00 |
SAP_PLANT | Y | Query by factory |
FineFlg | N | Can be queried by library bit code |
SAPPRODUCTCD | N | Can be queried by SAP product code, multiple query conditions can be separated by comma (,) |
Request example:
/master/stockOnHandPlant?pageSize=20&pageNo=10&SAP_PLANT=7857&FineFlg=W001
Response Parameters:
Field | Type | Length | Description | Example |
---|---|---|---|---|
SAP_PLANT | CHAR | 4 | Plant | 7857 |
FineFlg | CHAR | 4 | Storage Location Code | W001 |
SAPPRODUCTCD | CHAR | 40 | SAP Product Code | 10100011000CN |
CHARG | CHAR | 10 | Batch Number | 2502 |
BatchENDYMD | DATETIME | Batch Expiry Date | 20250201 | |
MEINS | NVARCHAR | 3 | Base Unit of Measure | EA |
CLABS | INT | Non-Restricted Stock | 261 | |
MaterialType | CHAR | 4 | SAP Material Type | Z002 |
STATUS | CHAR | 16 | Stock Status | Unrestricted |
ATPBT | INT | Available Stock | 243 | |
UPDATETIME | DATETIME | Update Time | 2024-06-04 11:08:19.387 | |
PRODUCTCD | CHAR | 10 | Material Code | 10100011 |
DETERMINECODE | CHAR | 13 | Material Determination Number | 10100011000CN |
Sample Response:
[
{
"SAP_PLANT": "7857",
"FineFlg": "W002",
"SAPPRODUCTCD": "89847500105CN ",
"CHARG": "2503 ",
"BatchENDYMD": "2025-03-01T00:00:00",
"MEINS": "EA",
"CLABS": 1,
"MaterialType": "Z002",
"STATUS": "Unrestricted ",
"ATPBT": 1,
"UPDATETIME": "2024-07-29T00:06:58.973",
"PRODUCTCD": "89847500 ",
"DETERMINECODE": "89847500105CN"
},
{
"SAP_PLANT": "7857",
"FineFlg": "W002",
"SAPPRODUCTCD": "89847500105CN ",
"CHARG": "2341I ",
"BatchENDYMD": "2025-12-07T00:00:00",
"MEINS": "EA",
"CLABS": 1,
"MaterialType": "Z002",
"STATUS": "Unrestricted ",
"ATPBT": 1,
"UPDATETIME": "2024-07-29T00:06:58.953",
"PRODUCTCD": "89847500 ",
"DETERMINECODE": "89847500105CN"
}
]
3.8 Get product unit price master data
Endpoint: /master/productPrice
Description: For product unit price
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
updateTime | N | Update Time (UPDATETIME), the last update time. The interface filters data updated after (including) this time. Format: yyyy-MM-dd, e.g., 2024-05-01, or yyyy-MM-dd HH:mm:ss, e.g., 2024-05-01 09:30:00 |
STARTYMD | N | Enquiries can be made on the start date of sales |
SAPPRODUCTCD | N | Can be queried by SAP product code |
Request example:
/master/productPrice?pageSize=20&pageNo=10&updateTime=2024-05-01&SAPPRODUCTCD=10121965801CN
Response Parameters:
Field | type | Length | Description | Example |
---|---|---|---|---|
SAPPRODUCTCD | SAP Product Code | CHAR | 13 | 10121965801CN |
STARTYMD | Sales start date | DATETIME | 20240501 | |
RPRICEMNY | Retail unit price | MONEY | 2300.0000 | |
UPDATETIME | Update Time | DATETIME | 2024-06-04 11:08:19.387 |
Sample Response:
[
{
"SAPPRODUCTCD": "300007010 ",
"STARTYMD": "2024-07-16T00:00:00",
"RPRICEMNY": 3880,
"UPDATETIME": "2024-07-15T23:00:17.69"
}
]
3.9 Get SAP entry indicator master data
Endpoint: /master/inboundDelivery
Description: Used to query SAP import instructions
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
InStcNo | N | Warehousing number/delivery order number |
SAPPRODUCTCD | N | material number |
APPLYNO | N | Surrounding POS order number |
Timestamp | N | The data update time is in the format yyyy-MM-dd, for example, 2024-05-01, or yyyy-MM-dd HH:mm:ss, for example, 2024-05-01 09:30:00 |
Request example:
/master/inboundDelivery?pageSize=20&pageNo=10&Timestamp=2024-05-01&APPLYNO=10121965801CN
Response Parameters:
Field | Description | Type | Length | Example |
---|---|---|---|---|
DocumentID | Unique Document Identifier | VARCHAR | 60 | |
InStcNo | Goods Receipt Number / Delivery Note Number | VARCHAR | 10 | |
AUART | Order Type | VARCHAR | 4 | |
AdmYMD | Delivery Date | datetime | ||
SAP_VENDORCODE | Vendor Code | VARCHAR | 10 | |
SAP_VENDORNAME | Vendor Name | VARCHAR | 80 | |
SAP_COUNTRY | Country | VARCHAR | 3 | |
BOLNR | Delivery Note | VARCHAR | 35 | |
InvoiceNo | Shipment Invoice Number | VARCHAR | 35 | |
COSNR | Line Item Number of Internal Delivery | VARCHAR | 6 | |
SAPPRODUCTCD | Material Number | VARCHAR | 18 | |
DESCRIBE | Material Description | VARCHAR | 80 | |
CHARG | Batch Number | VARCHAR | 10 | |
PLACECD | Goods Receipt Location Number | VARCHAR | 4 | |
LGORT | Storage Location Code | VARCHAR | 4 | |
InQnty | Quantity | INT | ||
VRKME | Base Unit of Measure | VARCHAR | 3 | |
BELNR | Purchase Order Number | VARCHAR | 10 | |
VGPOS | Purchase Order Item Number | VARCHAR | 6 | |
HIPOS | Parent Item Number | VARCHAR | 6 | |
PLACECD_FR | Outbound Storage Location Description | VARCHAR | 70 | |
LocationID | Outbound Storage Location Description | VARCHAR | 42 | |
BWART | Movement Type | VARCHAR | 3 | |
APPLYNO | Surrounding POS Order Number | VARCHAR | 35 | |
APPLYNO_SO | SAP Sales Order Number | VARCHAR | 12 | |
ShiptoMemoIn | 785B Special Shop-to Remark (In) | VARCHAR | 17 | |
ShiptoMemoOut | 785B Special Shop-to Remark (Out) | VARCHAR | 17 | |
Timestamp | Timestamp (Current Time) | datetime |
Sample Response:
[
{
"DocumentID": "7b777b80-64de-11ef-99e0-2a9785477593",
"InStcNo": "4101637150",
"AUART": "Z4EL",
"AdmYMD": "2024-08-28T00:00:00",
"SAP_VENDORCODE": "0A78500010",
"SAP_VENDORNAME": "Itochu main DC",
"SAP_COUNTRY": "CN",
"BOLNR": null,
"InvoiceNo": "4500220653",
"COSNR": "000010",
"SAPPRODUCTCD": "10217284803CN",
"DESCRIBE": "UTM P I CONCENTRATE 3 50ML",
"CHARG": "3132Q",
"PLACECD": "785J",
"LGORT": "W001",
"InQnty": 6,
"VRKME": "EA",
"BELNR": "4550135230",
"VGPOS": "000010",
"HIPOS": null,
"PLACECD_FR": "7857 Itochu Logistics",
"LocationID": "W001 良品仓Main Location",
"BWART": "101",
"APPLYNO": "RC-000024-001",
"APPLYNO_SO": "4101637142",
"ShiptoMemoIn": "2200003124",
"ShiptoMemoOut": "2200003124",
"Timestamp": "2024-08-28T09:40:19"
},
{
"DocumentID": "7b777b80-64de-11ef-99e0-2a9785477593",
"InStcNo": "4101637150",
"AUART": "Z4EL",
"AdmYMD": "2024-08-28T00:00:00",
"SAP_VENDORCODE": "0A78500010",
"SAP_VENDORNAME": "Itochu main DC",
"SAP_COUNTRY": "CN",
"BOLNR": null,
"InvoiceNo": "4500220653",
"COSNR": "000020",
"SAPPRODUCTCD": "10217284803CN",
"DESCRIBE": "UTM P I CONCENTRATE 3 50ML",
"CHARG": "3132R",
"PLACECD": "785J",
"LGORT": "W001",
"InQnty": 5,
"VRKME": "EA",
"BELNR": "4550135230",
"VGPOS": "000020",
"HIPOS": null,
"PLACECD_FR": "7857 Itochu Logistics",
"LocationID": "W001 良品仓Main Location",
"BWART": "101",
"APPLYNO": "RC-000024-001",
"APPLYNO_SO": "4101637142",
"ShiptoMemoIn": "2200003124",
"ShiptoMemoOut": "2200003124",
"Timestamp": "2024-08-28T09:40:19"
}
]
3.10 Obtain store virtual sets and other material master data
Endpoint: /master/materialSuitMain
Description: Used to query other materials such as store virtual sets
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
OwnerId | N | Brand number |
GoodsCode | N | Product ID |
UpdateDate | N | The data update time is in the format yyyy-MM-dd, for example, 2024-05-01, or yyyy-MM-dd HH:mm:ss, for example, 2024-05-01 09:30:00 |
Request example:
/master/materialSuitMain?pageSize=20&pageNo=10&UpdateDate=2024-05-01&OwnerId=10121965801CN
Response Parameters:
Field | Description | Type | Length | Example |
---|---|---|---|---|
OwnerId | Brand Code | varchar | 4 | 11 |
GoodsCode | Product Code | varchar | 20 | COP00020 |
GoodsName | Product Name (Chinese) | varchar | 100 | 镭射瓶复购券 |
BrandId | Brand | varchar | 10 | 11 |
BRANDNM | Brand Name | CHAR | 80 | CLE DE PEAU BEAUTE |
LineId | Line | varchar | 10 | 1107 |
LINENM | New Brand Name | CHAR | 80 | CLE DE PEAU BEAUTE |
SublineId | SubLine | varchar | 10 | 0710 |
SUBLINENM | New Product Series Name | CHAR | 80 | CPB |
BEAMTDCD1 | Beauty Method 1 | varchar | 10 | 90 |
BEAMTDCD2 | Beauty Method 2 | varchar | 10 | 9090 |
BEAMTDCD3 | Beauty Method 3 | varchar | 10 | 909090 |
SalePrice | Sale Price | decimal(12,4) | 155.0000 | |
EffectiveDate | Effective Date | Datetime | 2019-12-04 11:26:28.000 | |
GoodsSubType | POS Product Subcategory | varchar | 2 | 6 |
IsIncludeProdNumcd | Whether Set Contains Product Numbers | int | 0 | |
DelFlg | Delete Flag | varchar | 1 | 0 |
UpdateDate | Update Date | Datetime | 2023-01-03 17:25:43.000 | |
SourceDec | Source Description | varchar | 10 | POS |
Sample Response:
[
{
"OwnerId": "10",
"GoodsCode": "COP00203",
"GoodsName": "抽奖加赠礼-NARS黑色羽绒化妆包",
"BrandId": "10",
"BRANDNM": null,
"LineId": "1070",
"LINENM": null,
"SublineId": "7005",
"SUBLINENM": null,
"BEAMTDCD1": "90",
"BEAMTDCD2": "9090",
"BEAMTDCD3": "909090",
"SalePrice": 0,
"EffectiveDate": "2024-08-15T19:01:04",
"GoodsSubType": "6",
"IsIncludeProdNumcd": "0",
"DelFlg": "0",
"UpdateDate": "2024-08-15T19:01:04",
"SourceDec": "POS"
},
{
"OwnerId": "10",
"GoodsCode": "COP00202",
"GoodsName": "抽奖加赠礼-NARS红色帆布袋",
"BrandId": "10",
"BRANDNM": null,
"LineId": "1070",
"LINENM": null,
"SublineId": "7005",
"SUBLINENM": null,
"BEAMTDCD1": "90",
"BEAMTDCD2": "9090",
"BEAMTDCD3": "909090",
"SalePrice": 0,
"EffectiveDate": "2024-08-15T19:00:36",
"GoodsSubType": "6",
"IsIncludeProdNumcd": "0",
"DelFlg": "0",
"UpdateDate": "2024-08-15T19:00:36",
"SourceDec": "POS"
}
]
3.11 Get the master data of the store virtual set details
Endpoint: /master/materialSuitSub
Description: Used to query the details of the store virtual package
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
OwnerId | N | Brand Code |
GoodsCode | N | Product Code |
UpdateDate | N | Data Update Time, format: yyyy-MM-dd (e.g., 2024-05-01), or yyyy-MM-dd HH:mm:ss (e.g., 2024-05-01 09:30:00) |
Request example:
/master/materialSuitSub?pageSize=20&pageNo=10&UpdateDate=2024-05-01&OwnerId=10121965801CN
Response Parameters:
Field | Description | Type | Length | Example |
---|---|---|---|---|
OwnerId | Brand Code | varchar | 4 | 10 |
GoodsCode | Set Product Code | varchar | 20 | GP100001 |
DetailGoodsCode | Detail Product Code / Product Group Code | varchar | 20 | 10101340 |
Qty | Quantity of Current Detail Product | int | 1 | |
IsProdNumcd | Is Product Group | int | 0 | |
UpdateDate | Update Time | Datetime | 2019-10-29 12:00:29.000 |
Sample Response:
[
{
"OwnerId": "41",
"GoodsCode": "SP410230",
"DetailGoodsCode": "113544",
"Qty": 2,
"IsProdNumcd": "0",
"UpdateDate": "2024-06-05T18:19:51"
},
{
"OwnerId": "10",
"GoodsCode": "GP103031",
"DetailGoodsCode": "1015B832",
"Qty": 1,
"IsProdNumcd": "0",
"UpdateDate": "2024-05-29T15:58:36"
},
{
"OwnerId": "10",
"GoodsCode": "GP103030",
"DetailGoodsCode": "10000E",
"Qty": 1,
"IsProdNumcd": "0",
"UpdateDate": "2024-05-29T15:49:25"
}
]
3.12 Get customer Master data (fro business) master data
Endpoint: /master/businessCustomer
Description: Used to query customer master data (fro business) master data
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
CUSTOMERCD | N | Peripheral Store Code |
SUBUNITCD | N | Affiliated Office Code |
SUBOFFICE | N | Secondary Office |
CustomerBrand | N | Store Brand |
JYFLG | N | Contract Termination Indicator |
SALEPATN | N | Customer Classification |
SAP_CUSTOMERCD | N | ShipTo Code |
MDMUPDATETIME | N | Data Update Time, format yyyy-MM-dd, or yyyy-MM-dd HH:mm:ss |
Request example:
/master/businessCustomer?pageSize=20&pageNo=10&MDMUPDATETIME=2024-05-01&SAP_CUSTOMERCD=1012
Response Parameters:
Field | Description | Type | Length | Example | ||||||
---|---|---|---|---|---|---|---|---|---|---|
COMPANYCD | char | 4 | Company Code | 785 | ||||||
CUSTOMERCD | char | 60 | Surrounding Store Code | 10100313 | ||||||
SUBUNITCD | char | 3 | Sub-Office Code | 101 | ||||||
SUBUNITNM | char | 40 | Sub-Office Name | SHI Office | ||||||
SUBOFFICE | char | 5 | Secondary Office | 00003 | ||||||
SUBOFFICENM | char | 40 | Secondary Office Name | Tianjin | ||||||
SIDECD | char | 3 | Province Code | 002 | ||||||
SIDENM | char | 40 | Province | Tianjin City | ||||||
AREACD | char | 3 | City Code | 003 | ||||||
AREANM | char | 40 | City | Tianjin | ||||||
CUSTOMERNM | char | 280 | Shipto Name | SHI Tianjin Hisense - Shanghai Wuyan Direct Delivery | ||||||
CUSTRANK | char | 1 | Store Level | K1 | ||||||
TRASTAYMD | datetime | Start Date of Cooperation | 2022-10-20 00:00:00.000 | |||||||
ENDYMD | datetime | End Date | 2022-12-31 00:00:00.000 | |||||||
CustomerBrand | char | 18 | Store Belonging Brand | 10 | ||||||
CUSTOMERBRANDNM | char | 40 | Store Belonging Brand Name | SHISEIDO | ||||||
MDMUPDATETIME | datetime | Update Time | 2023-07-18 10:03:02.530 | |||||||
CUSTOMERNMJ | varchar | 80 | Store Abbreviation | NULL | ||||||
Longitude | char | 15 | Longitude | NULL | ||||||
Latitude | char | 15 | Latitude | NULL | ||||||
SAP_CHANNELTYPE | char | 3 | SAP Channel Type | 52 | ||||||
SAP_CHANNELTYPEENNM | char | 80 | SAP Channel Type Name | Department store (Wholesale) (SCH, SHK only) | ||||||
JYFLG | char | 1 | Termination Classification | 1 | ||||||
LOCALCHANNELCD1 | char | 1 | Primary Local Channel Code | 1 | ||||||
Industry | char | 2 | Store Channel (for CMI Report) | 1 | ||||||
IndustryNM | varchar | 11 | Store Channel Name | FSS | SALEPATN | char | 2 | Customer Classification | K1 | |
TOKUISAKICD | char | 8 | Department Store Group Code | 0001 | ||||||
STOREGROUPNM | char | 60 | Department Store Group Name | Baitian | ||||||
UNITCUSTOMERCD | char | 10 | Unified Store Code | 12dps01663 | ||||||
ExCUSTOMERCD | char | 10 | External Store Code | |||||||
SAP_CUSTOMERCD | char | 10 | ShipTo Code | 10100313 | ||||||
SHOPSIGNNM | char | 60 | Store Sign Name | SHI Tianjin Haixin - Shanghai Wuyan Straight Hair | ||||||
SHOPADR | char | 80 | Store Address | No. 188 Jiefang North Road, Haidian District, Tianjin, Haixin Plaza, 1st Floor, Shiseido Counter | ||||||
SOLDTO | char | 10 | Soldto Code | 2100006705 | ||||||
SOLDTONM | char | 280 | Soldto Name | Huan Tai Department Store Co., Ltd., Xiantai, Hubei Province | ||||||
SHOPTEL | CHAR | 30 | Store Phone Number | 13800000000 |
Sample Response:
[
{
"COMPANYCD": "785 ",
"CUSTOMERCD": "0A86600004 ",
"SUBUNITCD": null,
"SUBUNITNM": null,
"SUBOFFICE": null,
"SUBOFFICENM": null,
"SIDECD": null,
"SIDENM": null,
"AREACD": "905",
"AREANM": "Singapore ",
"CUSTOMERNM": "Shiseido Singapore Co. (Pte.) Ltd.Bollore Logistics Singapore",
"CUSTRANK": null,
"TRASTAYMD": null,
"ENDYMD": null,
"CustomerBrand": null,
"CUSTOMERBRANDNM": null,
"MDMUPDATETIME": "2024-09-06T01:10:33.683",
"CUSTOMERNMJ": null,
"Longitude": null,
"Latitude": null,
"SAP_CHANNELTYPE": "L1 ",
"SAP_CHANNELTYPEENNM": "Shiseido Group Companies ",
"JYFLG": "0",
"LOCALCHANNELCD1": null,
"Industry": null,
"IndustryNM": null,
"SALEPATN": null,
"TOKUISAKICD": null,
"STOREGROUPNM": null,
"UNITCUSTOMERCD": null,
"ExCUSTOMERCD": null,
"SAP_CUSTOMERCD": "0A86600004",
"SHOPSIGNNM": "Shiseido Singapore Co. (Pte.) Ltd.Bollore Logistics Singapor",
"SHOPADR": null,
"SHOPTEL": "13800000000"
}
]
3.13 Store personnel, store relationship master data
Endpoint: /master/cusEmployeeMapping
Description: Used to query the relationship between store personnel and store
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
EmployeeId | N | employee ID number |
UpdateDate | N | Update time in the format yyyy-MM-dd, for example, 2024-05-01, or yyyy-MM-dd HH:mm:ss, for example, 2024-05-01 09:30:00 |
Request example:
/master/cusEmployeeMapping?pageSize=20&pageNo=10&UpdateDate=2024-05-01&EmployeeId=1012
Response Parameters:
Field | Description | Type | Length | Example |
---|---|---|---|---|
OwnerId | Brand Number | varchar | 4 | 11 |
EmployeeId | Employee ID | varchar | 10 | 00007789 |
StoreId | Store ID | varchar | 10 | 00300063 |
EmployeeType | Employee Category | varchar | 4 | 05 |
UpdateDate | Update Time | Datetime | 2024-08-20 08:00:33.000 | |
AgentManager | Is Agent Manager | int | 0 | |
ddposition | office or position | varchar | 20 |
Sample Response:
[
{
"OwnerId": "11",
"EmployeeId": "30015031",
"StoreId": null,
"EmployeeType": "03",
"UpdateDate": "2024-09-12T08:00:18",
"AgentManager": "0"
},
{
"OwnerId": "11",
"EmployeeId": "30016204",
"StoreId": null,
"EmployeeType": "03",
"UpdateDate": "2024-09-12T08:00:18",
"AgentManager": "0"
},
{
"OwnerId": "11",
"EmployeeId": "30016804",
"StoreId": null,
"EmployeeType": "03",
"UpdateDate": "2024-09-12T08:00:18",
"AgentManager": "0"
}
]
3.14 Headquarters personnel sales role master data
Endpoint: /master/empstruct
Description: This command is used to query the sales roles of headquarters personnel
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
BRANDCD | N | Brand Code |
EMPCODE | N | Brand Code |
REGIONCODE | N | Region Code |
REGION_LEVEL | N | Region Level |
UPDATETIME | N | Update time in the format yyyy-MM-dd, for example, 2024-05-01, or yyyy-MM-dd HH:mm:ss, for example, 2024-05-01 09:30:00 |
Request example:
/master/empstruct?pageSize=20&pageNo=10&UPDATETIME=2024-05-01&BRANDCD=1012
Response Parameters:
Field | Description | Type | Length | Example |
---|---|---|---|---|
BRANDCD | Brand | CHAR | 2 | 10 |
BRANDNM | Brand Name | CHAR | 80 | SHISEIDO |
EMPCODE | Employee Code | CHAR | 80 | 00000529 |
REGIONCODE | Region Code | CHAR | 10 | 001 |
REGION_LEVEL | Region Level | CHAR | 1 | 1 |
EMPROLECD | Role Code | CHAR | 3 | 001 |
EMPROLENM | Role Name | CHAR | 40 | SM |
UPDATETIME | Update Time | DATETIME | 2022-02-14 14:17:34.820 |
Sample Response:
[
{
"BRANDCD": "10",
"BRANDNM": "SHISEIDO ",
"EMPCODE": "QT007827",
"REGIONCODE": "00005 ",
"REGION_LEVEL": "3",
"EMPROLECD": "002",
"EMPROLENM": "AM ",
"UPDATETIME": "2024-09-09T13:37:52"
},
{
"BRANDCD": "41",
"BRANDNM": "IPSA ",
"EMPCODE": "30011331",
"REGIONCODE": "10300047 ",
"REGION_LEVEL": "4",
"EMPROLECD": "004",
"EMPROLENM": "SS ",
"UPDATETIME": "2023-08-21T16:01:46"
}
]
3.15 Brand region architecture master data
Endpoint: /master/structMaster
Description: Used to query the brand region structure
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
BRANDCD | N | brand |
AREABUNO | N | Sales department code |
REGIONCODE | N | zone code |
UPDATETIME | N | Update time in the format yyyy-MM-dd, for example, 2024-05-01, or yyyy-MM-dd HH:mm:ss, for example, 2024-05-01 09:30:00 |
Request example:
/master/structMaster?pageSize=20&pageNo=10&UPDATETIME=2024-05-01&BRANDCD=1012
Response Parameters:
Field | Description | Type | Length | Example |
---|---|---|---|---|
BRANDCD | Brand | Varchar | 2 | 10 |
BRANDNM | Brand Name | Varchar | 80 | SHISEIDO |
AREABUNO | Sales Department Code | Varchar | 3 | 001 |
AREABUNAME | Sales Department Name | Varchar | 50 | SHI一区 |
REGIONCODE | Region Code | Varchar | 10 | 00007 |
REGIONNAME | Region Name | Varchar | 40 | 黑龙江 |
UPDATETIME | Update Time | DATETIME | 2024-01-30 18:23:23.390 |
Sample Response:
[
{
"BRANDCD": "10",
"BRANDNM": "SHISEIDO",
"AREABUNO": "002",
"AREABUNAME": "SHI二区",
"REGIONCODE": "00001 ",
"REGIONNAME": "北京A ",
"UPDATETIME": "2023-11-09T19:32:33.607"
},
{
"BRANDCD": "41",
"BRANDNM": null,
"AREABUNO": "039",
"AREABUNAME": null,
"REGIONCODE": "00040 ",
"REGIONNAME": "EC ",
"UPDATETIME": "2023-10-02T17:56:24.727"
}
]
3.16 The physical group sets the relationship between the main part and the sub-part
Endpoint: /master/materialSuitInfo
Description: This command is used to query the relationship between the main components and sub-components
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
brand | N | Brand |
set_type | N | Set Type |
material_type | N | Material Type |
material_number | N | Set Product Code |
sub_material_number | N | Sub-item Product Code |
sub_material_type | N | Sub-item Material Type |
update_date | N | Update Time, format: yyyy-MM-dd (e.g., 2024-05-01) or yyyy-MM-dd HH:mm:ss (e.g., 2024-05-01 09:30:00) |
Request example:
/master/materialSuitInfo?pageSize=20&pageNo=10&update_date=2024-05-01&brand=1012
Response Parameters:
Field | Description | Type | Length | Example |
---|---|---|---|---|
brand | Brand | nvarchar | 20 | 11 |
BRANDNM | Brand Name | CHAR | 80 | CLE DE PEAU BEAUTE |
set_type | Set Type | 01 | ||
material_type | Material Type | nvarchar | 10 | Z001 |
material_number | Set Product Code | nvarchar | 20 | 10179057803 |
suit_name | Set Name | nvarchar | 100 | LocalZ001单个组套非计划1 |
sub_cost_price | Set Retail Price | numeric | 20,2 | 0.00 |
sub_material_number | Sub-item Product Code | nvarchar | 100 | 10179059801 |
DETERMINECODE | Material Determination Code | CHAR | 13 | 10179059801 |
sub_material_name | Sub-item Product Name | nvarchar | 100 | 洗颜专科 凝润深透 保湿柔肤露(清爽型) |
sub_material_type | Sub-item Material Type | nvarchar | 20 | Z001 |
sub_quantity | Sub-item Quantity | numeric | 20,2 | 6.00 |
is_give | Is Gift | nvarchar | 20 | 1 |
apply_user_cd | Applicant Code | nvarchar | 50 | 00002049 |
update_date | Update Time | datetime2 | 7 | 2023-10-27 17:25:34.8300000 |
Sample Response:
[
{
"brand": "11",
"BRANDNM": "CLE DE PEAU BEAUTE ",
"set_type": "01",
"material_type": "Z002",
"material_number": "10100317000CN",
"suit_name": "CPB 光采赋活日间防护霜 SS",
"set_retail_unit_price": 0,
"sub_material_number": "10100317000CN",
"DETERMINECODE": "10100317000CN",
"sub_material_name": "CPB 光采赋活日间防护霜 SS",
"sub_material_type": "Z002",
"sub_quantity": 1,
"is_give": "0",
"apply_user_cd": "00002049",
"update_date": "2024-09-03T17:00:11.594"
},
{
"brand": "11",
"BRANDNM": "CLE DE PEAU BEAUTE ",
"set_type": "01",
"material_type": "Z002",
"material_number": "10100317000CN",
"suit_name": "CPB 光采赋活日间防护霜 SS",
"set_retail_unit_price": 0,
"sub_material_number": "10100318000CN",
"DETERMINECODE": "10100318000CN",
"sub_material_name": "CPB-肌肤之钥 光采赋活夜间修护乳 SS ",
"sub_material_type": "Z002",
"sub_quantity": 1,
"is_give": "0",
"apply_user_cd": "00002049",
"update_date": "2024-09-03T17:00:11.594"
}
]
3.17 Office master form
Endpoint: /master/subUnit
Description: Used to query the main office table
Request Type: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
SUBUNITCD | N | Office code |
UPDATETIME | N | Update time in the format yyyy-MM-dd, for example, 2024-05-01, or yyyy-MM-dd HH:mm:ss, for example, 2024-05-01 09:30:00 |
Request example:
/master/subUnit?pageSize=20&pageNo=10&update_date=2024-05-01&brand=1012
Response Parameters:
Field | Description | Type | Length | Example |
---|---|---|---|---|
SUBUNITCD | Office Code | Varchar | 3 | 246 |
SUBUNITNM | Office Name | Varchar | 80 | PM天津弘方化妆品有限公司 |
DELFLG | Delete Flag | Varchar | 50 | 0 |
UNITAGENTCD | Unified Agent Code | Varchar | 6 | A021 |
UPDATETIME | Update Time | datetime | 2023-06-14 23:00:12.073 |
Sample Response:
[
{
"SUBUNITCD": "101",
"SUBUNITNM": "SHI办事处 ",
"DELFLG": "0",
"UNITAGENTCD": null,
"UPDATETIME": "2023-06-14T23:00:10.92"
},
{
"SUBUNITCD": "102",
"SUBUNITNM": "CPB办事处 ",
"DELFLG": "0",
"UNITAGENTCD": null,
"UPDATETIME": "2023-06-14T23:00:11.057"
}
]
3.18 Master data: local brand
Endpoint: /master/brand
Description: use to query local brand
Request Method: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
BRANDCD | N | Local brand code |
DELFLG | N | Delete identity |
UPDATETIME | N | Update Time, format: yyyy-MM-dd (e.g., 2024-05-01) or yyyy-MM-dd HH:mm:ss (e.g., 2024-05-01 09:30:00) |
Request example:
/master/brand?pageSize=20&pageNo=10&UPDATETIME=2024-05-01&BRANDCD=1012
Response Parameters
Field | Description | Type | Length | Example |
---|---|---|---|---|
BRANDCD | Local brand code | Varchar | 3 | 1001 |
BRANDNM | Local brand name | Varchar | 40 | SHI |
DELFLG | Delete flags: 0- valid, 1- delete | char | 1 | 0 |
UPDATETIME | datetime | 2023-06-14 23:00:12.073 | ||
BRANDENGNM | Local brand english name | varchar | 100 | 11 |
Sample Response
[
{
"BRANDCD": "1001",
"BRANDNM": "SHI ",
"DELFLG": "0",
"UPDATETIME": "2019-05-16T10:15:56.287",
"BRANDENGNM": "11"
},
{
"BRANDCD": "1102",
"BRANDNM": "Radiance Trio ",
"DELFLG": "0",
"UPDATETIME": "2019-05-16T10:15:56.29",
"BRANDENGNM": null
},
{
"BRANDCD": "1103",
"BRANDNM": "Supreme ",
"DELFLG": "0",
"UPDATETIME": "2019-05-16T10:15:56.29",
"BRANDENGNM": "11"
}
]
3.19 Master data: Local beauty method 1
Endpoint: /master/localbeamtd1
Description: use to query Local beauty method 1
Request Method: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
LOCALBEAMTDCD1 | N | Spot Beauty Method 1 code |
DELFLG | N | Delete identity |
UPDATETIME | N | Update Time, format: yyyy-MM-dd (e.g., 2024-05-01) or yyyy-MM-dd HH:mm:ss (e.g., 2024-05-01 09:30:00) |
Request example:
/master/localbeamtd1?pageSize=20&pageNo=10&UPDATETIME=2024-05-01&LOCALBEAMTDCD1=1
Response Parameters
Field | Description | Type | Length | Example |
---|---|---|---|---|
LOCALBEAMTDCD1 | Spot Beauty Method 1 code | Varchar | 3 | 1 |
LOCALBEAMTDENNM1 | Spot Beauty Method 1 name en | char | 80 | Skin Care |
LOCALBEAMTDCHINM1 | Spot Beauty Method 1 name cn | char | 80 | 护肤 |
PRODUCTCODE | Financial tax classification code | char | 10 | 107022302 |
DELFLG | Delete flags: 0- valid, 1- delete | char | 1 | 0 |
UPDATETIME | datetime | 2023-06-14 23:00:12.073 |
Sample Response
[
{
"LOCALBEAMTDCD1": "2",
"LOCALBEAMTDENNM1": "Makeup ",
"LOCALBEAMTDCHINM1": "彩妆 ",
"PRODUCTCODE": "107022304 ",
"DELFLG": "0",
"UPDATETIME": "2019-05-04T14:40:15.683"
},
{
"LOCALBEAMTDCD1": "3",
"LOCALBEAMTDENNM1": "Body ",
"LOCALBEAMTDCHINM1": "美体 ",
"PRODUCTCODE": "107022302 ",
"DELFLG": "0",
"UPDATETIME": "2019-05-04T14:40:15.687"
},
{
"LOCALBEAMTDCD1": "4",
"LOCALBEAMTDENNM1": "Hair ",
"LOCALBEAMTDCHINM1": "美发 ",
"PRODUCTCODE": "107022303 ",
"DELFLG": "0",
"UPDATETIME": "2019-05-04T14:40:15.687"
}
]
3.20 Master data: Local beauty method 2
Endpoint: /master/localbeamtd2
Description: use to query Local beauty method 2
Request Method: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | Retrieve data by pages, specifying the number of entries per page. Default is 10. |
pageNo | N | Retrieve data by pages, specifying the current page number. Pagination starts from 0 (0 is the first page). Default is 0. |
LOCALBEAMTDCD2 | N | Spot Beauty Method 2 code |
DELFLG | N | Delete identity |
UPDATETIME | N | Update Time, format: yyyy-MM-dd (e.g., 2024-05-01) or yyyy-MM-dd HH:mm:ss (e.g., 2024-05-01 09:30:00) |
Request example:
/master/localbeamtd2?pageSize=20&pageNo=10&UPDATETIME=2024-05-01&LOCALBEAMTDCD2=1
Response Parameters
Field | Description | Type | Length | Example |
---|---|---|---|---|
LOCALBEAMTDCD2 | Spot Beauty Method 2 code | Varchar | 3 | 1 |
LOCALBEAMTDENNM2 | Spot Beauty Method 2 name en | char | 80 | Face |
LOCALBEAMTDCHINM2 | Spot Beauty Method 2 name cn | char | 80 | 脸部 |
DELFLG | Delete flags: 0- valid, 1- delete | char | 1 | 0 |
UPDATETIME | datetime | 2023-06-14 23:00:12.073 |
Sample Response
[
{
"LOCALBEAMTDCD2": "10",
"LOCALBEAMTDENNM2": "Face ",
"LOCALBEAMTDCHINM2": "脸部 ",
"DELFLG": "0",
"UPDATETIME": "2019-05-04T14:46:34.837"
},
{
"LOCALBEAMTDCD2": "20",
"LOCALBEAMTDENNM2": "Eye ",
"LOCALBEAMTDCHINM2": "眼部 ",
"DELFLG": "0",
"UPDATETIME": "2019-05-04T14:46:34.84"
},
{
"LOCALBEAMTDCD2": "30",
"LOCALBEAMTDENNM2": "Lip ",
"LOCALBEAMTDCHINM2": "唇部 ",
"DELFLG": "0",
"UPDATETIME": "2019-05-04T14:46:34.84"
},
{
"LOCALBEAMTDCD2": "40",
"LOCALBEAMTDENNM2": "Cheek ",
"LOCALBEAMTDCHINM2": "面颊 ",
"DELFLG": "0",
"UPDATETIME": "2019-05-04T14:46:34.84"
}
]
3.21 Master data: Local beauty method 3
Endpoint: /master/localbeamtd3
Description: use to query Local beauty method 3
Request Method: HTTP GET
Request Parameters:
Field Name | Required | Description | |
---|---|---|---|
pageSize | N | gets the data by paging, displaying data entries on each page. That is, page size. Default 10 | |
pageNo | N | Get the data by page break, current page number. Page breaks start at 0 (0 is the initial page). The default is 0 | |
LOCALBEAMTDCD1 | N | Local Beauty Method 1 code | |
LOCALBEAMTDCD3 | N | Local Beauty Method 3 code | |
DELFLG | N | Deletes the | identifier |
UPDATETIME | N | Indicates the update time. The format is yyyy-MM-dd, for example, 2024-05-01 or yyyy-MM-dd HH:mm:ss, for example, 2024-05-01 09:30:00 |
Request example:
/master/localbeamtd3?pageSize=20&pageNo=10&UPDATETIME=2024-05-01&LOCALBEAMTDCD1=1
Response Parameters
Field | Description | Type | Length | Example |
---|---|---|---|---|
LOCALBEAMTDCD1 | Spot Beauty Method 1 code | Varchar | 1 | 1 |
LOCALBEAMTDCD3 | Spot Beauty Method 3 code | Varchar | 3 | 001 |
LOCALBEAMTDENNM3 | Spot Beauty Method 3 name en | char | 80 | Cleansing Cream |
LOCALBEAMTDCHINM3 | Spot Beauty Method 3 name cn | char | 80 | 护肤-洁面 |
DELFLG | Delete flags: 0- valid, 1- delete | char | 1 | 0 |
UPDATETIME | datetime | 2023-06-14 23:00:12.073 |
Sample Response
[
{
"LOCALBEAMTDCD1": "1",
"LOCALBEAMTDCD3": "001",
"LOCALBEAMTDENNM3": "Cleansing Cream ",
"LOCALBEAMTDCHINM3": "护肤-洁面 ",
"DELFLG": "0",
"UPDATETIME": "2019-05-04T15:17:35.353"
},
{
"LOCALBEAMTDCD1": "1",
"LOCALBEAMTDCD3": "002",
"LOCALBEAMTDENNM3": "Cleansing Gel ",
"LOCALBEAMTDCHINM3": "护肤-洁面啫喱 ",
"DELFLG": "0",
"UPDATETIME": "2019-05-04T15:17:35.353"
},
{
"LOCALBEAMTDCD1": "1",
"LOCALBEAMTDCD3": "003",
"LOCALBEAMTDENNM3": "Cleansing Soap ",
"LOCALBEAMTDCHINM3": "护肤-洁面皂 ",
"DELFLG": "0",
"UPDATETIME": "2019-05-04T15:17:35.357"
}
]
3.22 Master data: Custom classification subcategories
Endpoint: /master/custSubCategory
Description: use to query Custom classification subcategories
Request Method: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | gets the data by paging, displaying data entries on each page. That is, page size. Default 10 |
pageNo | N | Get the data by page break, current page number. Page breaks start at 0 (0 is the initial page). The default is 0 |
OwnerId | N | brand |
CateID | N | Class ID |
SubCateID | N | Subclass ID |
UPDATETIME | N | Indicates the update time. The format is yyyy-MM-dd, for example, 2024-05-01 or yyyy-MM-dd HH:mm:ss, for example, 2024-05-01 09:30:00 |
Request example:
/master/localbeamtd3?pageSize=20&pageNo=10&UPDATETIME=2024-05-01&LOCALBEAMTDCD1=1
Response Parameters
Field | Description | Type | Length | Example |
---|---|---|---|---|
OwnerId | brand | Varchar | 4 | 14 |
CateID | Class ID | Varchar | 20 | 11 |
SubCateID | Subclass ID | char | 20 | 1101 |
SubCateName | Subclass name | char | 20 | Cleansing Cream |
UPDATETIME | Update time | datetime | 2023-06-14 23:00:12.073 |
Sample Response
[
{
"OwnerId": "14",
"CateID": "11",
"SubCateID": "1101",
"SubCateName": "点金霜",
"UPDATETIME": "2021-11-18T00:00:00"
},
{
"OwnerId": "14",
"CateID": "11",
"SubCateID": "1102",
"SubCateName": "金腰子",
"UPDATETIME": "2022-02-14T08:12:11.433"
}
]
3.23 Master data: Product custom classification relationship table
Endpoint: /master/custSubLineCategory
Description: use to query Product custom classification relationship table
Request Method: HTTP GET
Request Parameters:
Field Name | Required | Description |
---|---|---|
pageSize | N | gets the data by paging, displaying data entries on each page. That is, page size. Default 10 |
pageNo | N | Get the data by page break, current page number. Page breaks start at 0 (0 is the initial page). The default is 0 |
OwnerId | N | brand |
YearMonth | N | year & month |
GoodsCode | N | Subclass ID |
CateID | N | Class ID |
SubCateID | N | Commodity code |
UPDATETIME | N | Indicates the update time. The format is yyyy-MM-dd, for example, 2024-05-01 or yyyy-MM-dd HH:mm:ss, for example, 2024-05-01 09:30:00 |
Request example:
/master/localbeamtd3?pageSize=20&pageNo=10&UPDATETIME=2024-05-01&LOCALBEAMTDCD1=1
Response Parameters
Field | Description | Type | Length | Example |
---|---|---|---|---|
OwnerId | brand | Varchar | 4 | 14 |
YearMonth | year & month | datetime | 11 | |
CateID | Class ID | Varchar | 20 | 11 |
SubCateID | Subclass ID | char | 20 | 1101 |
GoodsCode | Commodity code | char | 40 | |
GoodsName | Trade name | char | 40 | |
UPDATETIME | Update time | datetime | 2023-06-14 23:00:12.073 |
Sample Response
[
{
"OwnerId": "14",
"YearMonth": "2022-01-01T00:00:00",
"CateID": "11",
"SubCateID": "1101",
"GoodsCode": "45604",
"GoodsName": "悠莱 生机明眸 金致紧塑眼霜 ",
"UPDATETIME": "2022-01-25T12:37:21.61"
},
{
"OwnerId": "14",
"YearMonth": "2022-01-01T00:00:00",
"CateID": "11",
"SubCateID": "1101",
"GoodsCode": "45699",
"GoodsName": "悠莱 生机明眸金致紧塑眼霜(新年限定版) ",
"UPDATETIME": "2022-01-25T12:37:21.613"
}
]