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 Description | Field Name | Type | Length | Required | Remarks |
---|---|---|---|---|---|
Brand ID | OwnerId | String | 4 | Yes | Brand of the store corresponding to the ticket |
POS Customer Service Ticket Number | TicketNo | String | 64 | Yes | Unique key for all brands (not the customer service system ticket number) |
Acceptance Method | AcceptMethodCode | String | 10 | Yes | Default is "返品" (Return) |
Acceptance Method Name | AcceptMethodName | String | 100 | No | |
Delivering Party Code | StoreId | String | 10 | Yes | Store ID |
Delivering Party Name | StoreName | String | 60 | No | Store Name |
Case Handler | EmployeeId | String | 10 | Yes | |
Case Handler Name | EmployeeName | String | 20 | No | |
Handler Contact Phone | AcceptedPhone | String | 30 | Yes | |
Department | DeptCode | String | 10 | No | Fixed value assigned by the backend AP (EC, store) |
Acceptance Date | AcceptDate | DateTime | No | ||
Purchase Transaction Number | BillNo | int | Yes | ||
Purchase POS Machine Number | PosId | int | Yes | ||
Customer Name | CustomerName | String | 10 | Yes | |
Age Code | AgeCode | String | 10 | Yes | |
Age Name | AgeName | String | 100 | No | |
Gender Code | GenderCode | String | 10 | Yes | |
Gender Name | GenderName | String | 100 | No | |
Phone Number | Mobile | String | 50 | Yes | |
Member ID | MemberNo | String | 13 | No | |
Nationality Code | NationalityCode | String | 10 | No | |
Nationality Name | NationalityName | String | 100 | No | |
Region Code (Customer's Province) | ProvinceCode | String | 10 | Yes | |
Region Name | ProvinceName | String | 100 | No | |
Ethnicity Code | NationCode | String | 10 | No | |
Ethnicity Name | NationName | String | 100 | No | |
Address | Address | String | 500 | No | |
Case Type Code | TicketTypeCode | String | 10 | Yes | Default is "顾客案件" (Customer Case) |
Case Type Name | TicketTypeName | String | 100 | No | |
Information Source Code | InfoSourceCode | String | 10 | Yes | Default is "客户" (Customer) |
Information Source Name | InfoSourceName | String | 100 | No | |
Information Feature Code | InfoFeatureCode | String | 10 | No | Default is "不满意" (Dissatisfied) |
Information Feature Name | InfoFeatureName | String | 100 | No | |
Corresponding Result Code | ProcessResultCode | String | 10 | Yes | |
Corresponding Result Name | ProcessResultName | String | 100 | No | Two options: "退货" (Return), "换货" (Exchange) |
Product List | GoodsList | Array | Yes | Array of GoodsInfo objects, but currently only one item. | |
Reflected Information | SymptomClassList | Array | Yes | Array of SymptomClass objects | |
Inquiry Information | InquireContentData | InquireContent | Yes | InquireContent object |
Product Information (GoodsInfo):
Field Description | Field Name | Type | Length | Required | Remarks |
---|---|---|---|---|---|
Product ID | GoodsCode | String | 8 | Yes | |
Product Name | GoodsName | String | 100 | No | |
Production Batch Number | ProductBatchNo | String | 50 | Yes | |
Expiry Date | ExpiredDate | DateTime | No | ||
Purchase Date | BuyDate | DateTime | No |
Reflected Information (Allergic Symptoms) SymptomClass:
Field Description | Field Name | Type | Length | Required | Remarks |
---|---|---|---|---|---|
Symptom Class 1 Name | SymptomClass1Name | String | 100 | No | |
Symptom Class 2 Code | SymptomClass2Code | String | 10 | Yes | |
Symptom Class 2 Name | SymptomClass2Name | String | 100 | No | |
Symptom Class 3 Code | SymptomClass3Code | String | 10 | Yes | |
Symptom Class 3 Name | SymptomClass3Name | String | 100 | No | |
Is Primary Symptom Code | CardinalSymptomFlagCode | String | 10 | Yes | |
Is Primary Symptom Name | CardinalSymptomFlagName | String | 10 | No |
Inquiry Information (InquireContent):
Field Description | Field Name | Type | Length | Required | Remarks |
---|---|---|---|---|---|
Symptom Occurrence Date | SymptomDate | DateTime | Yes | ||
Symptom Occurrence Area Code (1) | SymptomParts1Code | String | 10 | Yes | |
Symptom Occurrence Area Name (1) | SymptomParts1Name | String | 100 | No | |
Symptom Occurrence Area Code (2) | SymptomParts2Code | String | 10 | No | |
Symptom Occurrence Area Name (2) | SymptomParts2Name | String | 100 | No | |
Symptom Occurrence Area Code (3) | SymptomParts3Code | String | 10 | No | |
Symptom Occurrence Area Name (3) | SymptomParts3Name | String | 100 | No | |
Other Damage Code | OtherSymptomCode | String | 10 | Yes | |
Other Damage Name | OtherSymptomName | String | 100 | No | |
Skin Symptom Code | SkinSymptomCode | String | 10 | Yes | |
Skin Symptom Name | SkinSymptomName | String | 100 | No | |
Other Skin Symptom Content | SkinSymptomOtherContent | String | 200 | No | |
Preliminary Judgment Code | PreliminaryResultCode | String | 10 | Yes | |
Preliminary Judgment Name | PreliminaryResultName | String | 100 | No | |
Other Preliminary Judgment Content | PreliminaryResultOtherContent | String | 200 | No | |
Is First Time Using Allergic Product Code | FirstUsedCode | String | 10 | Yes | |
Is First Time Using Allergic Product Name | FirstUsedName | String | 100 | No | |
Start Usage Date | BeginUsedDate | DateTime | Yes | ||
Usage Count | UsedCount | int | No | ||
Usage Frequency (times/day) | UsedFrequency | int | No | ||
Stop Usage Status Code | StopUsedCode | String | 10 | No | |
Stop Usage Status Name | StopUsedName | String | 100 | No | |
Stop Usage Date | StopUsedDate | DateTime | Yes | ||
Recovery Status Code (Symptom Transition Period) | RecoveryStatusCode | String | 10 | Yes | |
Recovery Status Name (Symptom Transition Period) | RecoveryStatusName | String | 100 | No | |
Recovery Status - Unknown Description | RecoveryStatusUnknownContent | String | 200 | No | |
Recovery Date | RecoveryDate | DateTime | No | ||
Medical Diagnosis Code | MedicalDiagnosisCode | String | 10 | No | |
Medical Diagnosis Name | MedicalDiagnosisName | String | 100 | No | |
Medical Diagnosis Date | MedicalDiagnosisDate | DateTime | No | ||
Diagnosis Report Available Code | DiagnosisReportCode | String | 10 | No | |
Diagnosis Report Available Name | DiagnosisReportName | String | 100 | No | |
Medical Diagnosis Report | DiagnosisReportList | Array | No | Images of medical diagnosis report, file key uploaded to OSS | |
Diagnosing Medical Institution Name | MedicalInstitutionName | String | 100 | No | |
Allergy Constitution / Allergy Experience Code | AllergyCode | String | 10 | No | |
Allergy Constitution / Allergy Experience Name | AllergyName | String | 100 | No | |
Allergy Constitution Allergy Experience Content | AllergyContent | String | 200 | No | |
Corresponding Type Code | ConsultTypeCode | String | 10 | Yes | |
Corresponding Type Name | ConsultTypeName | String | 100 | No | |
Inquiry Period Code | InquireDateCode | String | 10 | Yes | |
Inquiry Period Explanation | InquireDateName | String | 100 | No | |
Detailed Reflection (Background) | InquireDetail | String | Unlimited | Yes | |
Allergy Photos | AllergyImageList | Array | No | Allergy photos, file keys uploaded to OSS |
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"
}