schm-pos-nccs-eapi
home
schm-pos-nccs-eapi
API Description: Customer Service Ticket Information API
DEV URL (Development Environment): https://schm-api-dev.shiseido.cn/schm-pos-nccs-eapi
UAT URL (Testing Environment): https://schm-api-test.shiseido.cn/schm-pos-nccs-eapi
PROD URL (Production Environment): https://schm-api.shiseido.cn/schm-pos-nccs-eapi
1. Authentication
All requests must include the following key-value parameters as authentication information. You will need to request this information from the administrator.
client_id: fa98****3452
client_secret: 108b****41f2
2. API Overview:
Request Endpoint | Description |
---|---|
/caseEntry | Customer service ticket information API |
The complete request URL consists of the environment URL and the endpoint, for example:
https://schm-api-test.shiseido.cn/schm-pos-nccs-eapi/caseEntry
3. API Call Instructions
3.1 Customer Service Ticket Information API
Request Endpoint: /caseEntry
API Description: Customer service ticket information API
Request Type: HTTP POST
3.2 Parameter Description
Field Name | Type | Required | Field Description |
---|---|---|---|
AcceptMethodCode | String | Y | Acceptance method (enumeration value) |
StoreId | String | Y | Delivery party code |
Shipto | String | N | Store code |
EmployeeId | String | Y | Case acceptor |
AcceptedPhone | String | Y | Contact number of the acceptor |
DeptCode | String | N | Department to which it belongs |
AcceptDate | String | N | Acceptance date (time format: yyyy-MM-dd HH:mm:ss) |
CustomerName | String | Y | Customer name |
AgeCode | String | Y | Age (enumeration value) |
GenderCode | String | Y | Gender (enumeration value) |
Mobile | String | Y | Mobile phone number |
MemberNo | String | N | Member ID |
NationalityCode | String | N | Nationality (enumeration value, default: China) |
ProvinceCode | String | Y | Region (enumeration value) |
NationCode | String | N | Ethnicity (enumeration value, default: Han) |
Address | String | N | Address |
TicketTypeCode | String | Y | Case type (enumeration value, default: customer case) |
InfoFeatureCode | String | Y | Information characteristics (enumeration value) |
InfoSourceCode | String | Y | Information source (enumeration value) |
ProcessResultCode | String | Y | Corresponding result |
TicketNo | String | Y | POS customer service ticket number |
GoodsList | Array | Y | Please fill in the parameters according to the instructions below |
SymptomClassList | Array | Y | Please fill in the parameters according to the instructions below |
InquireContentData | ObjectMap | Y | Please fill in the parameters according to the instructions below |
Product Information (GoodsList):
Field Name | Type | Required | Field Description |
---|---|---|---|
GoodsCode | String | Y | Product code Product Name |
GoodsName | String | N | Product Name |
ProductBatchNo | String | Y | Production mark |
ExpiredDate | String | N | Expiry date (in time format: yyyy-MM-dd HH:mm:ss) |
BuyDate | String | N | Purchase date (in time format: yyyy-MM-dd HH:mm:ss) |
Reflected Information (SymptomClassList):
Field Name | Type | Required | Field Description |
---|---|---|---|
SymptomClass1Code | String | Y | Content classification (cascade enumeration) |
SymptomClass2Code | String | Y | Content classification 2 (cascade enumeration) |
SymptomClass3Code | String | Y | Content classification 3 (cascade enumeration) |
Inquiry Information (InquireContentData ):
Field Name | Type | Required | Field Description |
---|---|---|---|
RecoveryStatusUnknownContent | String | N | Recovery status (Symptom transition period) Additional information |
SymptomDate | String | Y | Date of symptom occurrence (time format: yyyy-MM-dd HH:mm:ss) |
SymptomParts1Code | String | Y | Location of symptom occurrence (1) (select enumeration value) |
SymptomParts2Code | String | N | Location of symptom occurrence (2) (select enumeration value) |
SymptomParts3Code | String | N | Location of symptom occurrence (3) (select enumeration value) |
OtherSymptomCode | String | Y | Other damages (select enumeration value) |
SkinSymptomCode | String | Y | Lesion morphology (select enumeration value) |
SkinSymptomOtherContent | String | N | Other additional information for lesion morphology |
PreliminaryResultCode | String | Y | Initial judgment (select enumeration value) |
PreliminaryResultOtherContent | String | N | Other additional information for initial judgment |
FirstUsedCode | String | Y | Was the sensitizing product used for the first time? (select enumeration value) |
BeginUsedDate | String | Y | Start time of use (time format: yyyy-MM-dd HH:mm:ss) |
UsedCount | String | N | Number of uses |
UsedFrequency | String | N | Frequency of use (times/day) |
StopUsedCode | String | N | Status of use cessation |
StopUsedDate | String | Y | Date of cessation of use (time format: yyyy-MM-dd HH:mm:ss) |
RecoveryStatusCode | String | Y | Recovery status (Symptom transition period) |
RecoveryDate | String | N | Recovery date (time format: yyyy-MM-dd HH:mm:ss) |
MedicalDiagnosisCode | String | N | Received medical examination |
MedicalDiagnosisDate | String | N | Medical examination date (time format: yyyy-MM-dd HH:mm:ss) |
DiagnosisReportCode | String | N | Was there a diagnosis certificate? (select enumeration value) |
DiagnosisReportList | List | N | Diagnosis certificate (attachment address) |
MedicalInstitutionName | String | N | Name of the medical institution for diagnosis |
AllergyCode | String | N | Allergic constitution · Allergic experience (select enumeration value) |
AllergyContent | String | N | Content of allergic constitution and experience |
ConsultTypeCode | String | Y | Corresponding types (select enumeration value) |
InquireDateCode | String | Y | Consultation period (select enumeration value) |
InquireDetail | String | Y | Detailed description (background) |
AllergyImageList | List | N | Allergy photos (attachment address) |
UseAgainCode | String | Y | Have you used it again? (select enumeration value) |
UseAgainReactionCode | String | N | Reaction when using it again (select enumeration value) |
UseAgainDate | String | N | Date of using it again (time format: yyyy-MM-dd HH:mm:ss) |
3.3 Example of Parameters
{
"OwnerId": "10",
"TicketNo": "CS240528GS5Dk201",
"AcceptMethodCode": "5",
"AcceptMethodName": "返品",
"StoreId": "00300023",
"StoreName": "SHI 第一八佰伴",
"EmployeeId": "00007672",
"EmployeeName": "叶伊俐",
"AcceptedPhone": "13688996699",
"DeptCode": "store",
"AcceptDate": "2024-4-30",
"BillNo": "888888",
"PosId": "1",
"CustomerName": "陈女士",
"AgeCode": "03",
"AgeName": "20 岁~29 岁",
"GenderCode": "1",
"GenderName": "女性",
"Mobile": "18812345678",
"MemberNo": "M1000167038",
"NationalityCode": "49",
"NationalityName ": "中国",
"ProvinceCode": "3",
"ProvinceName": "上海",
"NationCode": "2",
"NationName": "汉族",
"Address": "上海市南京东路 88 号",
"TicketTypeCode": "1",
"TicketTypeName": "顾客案件",
"InfoSourceCode": "1",
"InfoSourceName": "客户",
"InfoFeatureCode": "3",
"InfoFeatureName": "不满意",
"ProcessResultCode": "1",
"ProcessResultName": "退货",
"GoodsList": [
{
"GoodsCode": "10042",
"GoodsName": "SWL 资生堂透白美肌亮润柔肤水(清爽型)",
"ProductBatchNo": "2023121866666",
"ExpiredDate": "2026-03-25",
"BuyDate": "2024-02-14"
}
],
"SymptomClassList": [
{
"SymptomClass1Code": "012",
"SymptomClass1Name": "身体异常",
"SymptomClass2Code": "111",
"SymptomClass2Name": "皮肤・毛发・眼部异常",
"SymptomClass3Code": "041",
"SymptomClass3Name": "发红",
"CardinalSymptomFlagCode": "1",
"CardinalSymptomFlagName": "是"
}
],
"InquireContentData": {
"SymptomDate": "2024-04-25",
"SymptomParts1Code": "003",
"SymptomParts1Name": "全脸",
"SymptomParts2Code": "011",
"SymptomParts2Name": "眉毛",
"SymptomParts3Code": "",
"SymptomParts3Name": "",
"OtherSymptomCode": "1",
"OtherSymptomName": "全身性",
"SkinSymptomCode": "1",
"SkinSymptomName": "红斑",
"SkinSymptomOtherContent": "",
"PreliminaryResultCode": "2",
"PreliminaryResultName": "化妆品光感性皮炎",
"PreliminaryResultOtherContent": "",
"FirstUsedCode": "1",
"FirstUsedName": "是",
"BeginUsedDate": "2024-4-23",
"UsedCount": "6",
"UsedFrequency": "2",
"StopUsedCode": "1",
"StopUsedName": "使用中止",
"StopUsedDate": "2024-4-26",
"RecoveryStatusCode": "2",
"RecoveryStatusName": "好转",
"RecoveryStatusUnknownContent": "",
"RecoveryDate": "2024-4-28",
"MedicalDiagnosisCode": "1",
"MedicalDiagnosisName": "接受诊察",
"MedicalDiagnosisDate": "2024-4-27",
"DiagnosisReportCode": "1",
"DiagnosisReportName": "有",
"DiagnosisReportList": [
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png"
],
"MedicalInstitutionName": "上海市第十人民医院",
"AllergyCode": "0",
"AllergyName": "无",
"AllergyContent": "",
"ConsultTypeCode": "1",
"ConsultTypeName": "身体对应-无面谈",
"InquireDateCode": "1",
"InquireDateName": "初次购买后",
"InquireDetail": "XX 年 X 月 X 日收到 XXX(地区)XXX(人)寄来的皮肤过敏报告书:顾客 XXX(小姐、女士、先生)于 XX 年 X 月 X 日在 XXXXX(店名)购买 XXXXXX(产品名、制造记号)。什么时候使用?什么时候出现过敏?过敏症状?反映日期?使用方法?有无与其他品牌混用?是否第一次使用我司产品?是否是过敏性体质(有无化妆品过敏史)?有无医院诊断书?诊断为什么?店头已做退(换:具体产品)货处理。(如没有诊断证明的)无医院开具的诊断证明, 经 XXX( 地方工作人员) 签字确认, 顾客脸部确有明显症状,给予退货处理。 ",
"AllergyImageList": [
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png",
"NCCS\\POS\\xxxx.png"
]
}
}
3.4 Return Value Description
Field Description | Field Name | Type | Required | Remarks |
---|---|---|---|---|
Return Code | ErrorCode | String | Yes | "0" indicates success |
Error Message | Message | String | No | Unique key for all brands |
Customer Service System Ticket Number | CSTicketNo | String | No |
3.5 Example of Return Values
{
"ErrorCode": "0",
"Message": "",
"CSTicketNo": "xxxxxxxxxx"
}