schm-pos-nccs-eapi

(0 reviews)

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 EndpointDescription
/caseEntryCustomer 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 DescriptionField NameTypeLengthRequiredRemarks
Brand IDOwnerIdString4YesBrand of the store corresponding to the ticket
POS Customer Service Ticket NumberTicketNoString64YesUnique key for all brands (not the customer service system ticket number)
Acceptance MethodAcceptMethodCodeString10YesDefault is "返品" (Return)
Acceptance Method NameAcceptMethodNameString100No
Delivering Party CodeStoreIdString10YesStore ID
Delivering Party NameStoreNameString60NoStore Name
Case HandlerEmployeeIdString10Yes
Case Handler NameEmployeeNameString20No
Handler Contact PhoneAcceptedPhoneString30Yes
DepartmentDeptCodeString10NoFixed value assigned by the backend AP (EC, store)
Acceptance DateAcceptDateDateTimeNo
Purchase Transaction NumberBillNointYes
Purchase POS Machine NumberPosIdintYes
Customer NameCustomerNameString10Yes
Age CodeAgeCodeString10Yes
Age NameAgeNameString100No
Gender CodeGenderCodeString10Yes
Gender NameGenderNameString100No
Phone NumberMobileString50Yes
Member IDMemberNoString13No
Nationality CodeNationalityCodeString10No
Nationality NameNationalityNameString100No
Region Code (Customer's Province)ProvinceCodeString10Yes
Region NameProvinceNameString100No
Ethnicity CodeNationCodeString10No
Ethnicity NameNationNameString100No
AddressAddressString500No
Case Type CodeTicketTypeCodeString10YesDefault is "顾客案件" (Customer Case)
Case Type NameTicketTypeNameString100No
Information Source CodeInfoSourceCodeString10YesDefault is "客户" (Customer)
Information Source NameInfoSourceNameString100No
Information Feature CodeInfoFeatureCodeString10NoDefault is "不满意" (Dissatisfied)
Information Feature NameInfoFeatureNameString100No
Corresponding Result CodeProcessResultCodeString10Yes
Corresponding Result NameProcessResultNameString100NoTwo options: "退货" (Return), "换货" (Exchange)
Product ListGoodsListArrayYesArray of GoodsInfo objects, but currently only one item.
Reflected InformationSymptomClassListArrayYesArray of SymptomClass objects
Inquiry InformationInquireContentDataInquireContentYesInquireContent object

Product Information (GoodsInfo):

Field DescriptionField NameTypeLengthRequiredRemarks
Product IDGoodsCodeString8Yes
Product NameGoodsNameString100No
Production Batch NumberProductBatchNoString50Yes
Expiry DateExpiredDateDateTimeNo
Purchase DateBuyDateDateTimeNo

Reflected Information (Allergic Symptoms) SymptomClass:

Field DescriptionField NameTypeLengthRequiredRemarks
Symptom Class 1 NameSymptomClass1NameString100No
Symptom Class 2 CodeSymptomClass2CodeString10Yes
Symptom Class 2 NameSymptomClass2NameString100No
Symptom Class 3 CodeSymptomClass3CodeString10Yes
Symptom Class 3 NameSymptomClass3NameString100No
Is Primary Symptom CodeCardinalSymptomFlagCodeString10Yes
Is Primary Symptom NameCardinalSymptomFlagNameString10No

Inquiry Information (InquireContent):

Field DescriptionField NameTypeLengthRequiredRemarks
Symptom Occurrence DateSymptomDateDateTimeYes
Symptom Occurrence Area Code (1)SymptomParts1CodeString10Yes
Symptom Occurrence Area Name (1)SymptomParts1NameString100No
Symptom Occurrence Area Code (2)SymptomParts2CodeString10No
Symptom Occurrence Area Name (2)SymptomParts2NameString100No
Symptom Occurrence Area Code (3)SymptomParts3CodeString10No
Symptom Occurrence Area Name (3)SymptomParts3NameString100No
Other Damage CodeOtherSymptomCodeString10Yes
Other Damage NameOtherSymptomNameString100No
Skin Symptom CodeSkinSymptomCodeString10Yes
Skin Symptom NameSkinSymptomNameString100No
Other Skin Symptom ContentSkinSymptomOtherContentString200No
Preliminary Judgment CodePreliminaryResultCodeString10Yes
Preliminary Judgment NamePreliminaryResultNameString100No
Other Preliminary Judgment ContentPreliminaryResultOtherContentString200No
Is First Time Using Allergic Product CodeFirstUsedCodeString10Yes
Is First Time Using Allergic Product NameFirstUsedNameString100No
Start Usage DateBeginUsedDateDateTimeYes
Usage CountUsedCountintNo
Usage Frequency (times/day)UsedFrequencyintNo
Stop Usage Status CodeStopUsedCodeString10No
Stop Usage Status NameStopUsedNameString100No
Stop Usage DateStopUsedDateDateTimeYes
Recovery Status Code (Symptom Transition Period)RecoveryStatusCodeString10Yes
Recovery Status Name (Symptom Transition Period)RecoveryStatusNameString100No
Recovery Status - Unknown DescriptionRecoveryStatusUnknownContentString200No
Recovery DateRecoveryDateDateTimeNo
Medical Diagnosis CodeMedicalDiagnosisCodeString10No
Medical Diagnosis NameMedicalDiagnosisNameString100No
Medical Diagnosis DateMedicalDiagnosisDateDateTimeNo
Diagnosis Report Available CodeDiagnosisReportCodeString10No
Diagnosis Report Available NameDiagnosisReportNameString100No
Medical Diagnosis ReportDiagnosisReportListArrayNoImages of medical diagnosis report, file key uploaded to OSS
Diagnosing Medical Institution NameMedicalInstitutionNameString100No
Allergy Constitution / Allergy Experience CodeAllergyCodeString10No
Allergy Constitution / Allergy Experience NameAllergyNameString100No
Allergy Constitution Allergy Experience ContentAllergyContentString200No
Corresponding Type CodeConsultTypeCodeString10Yes
Corresponding Type NameConsultTypeNameString100No
Inquiry Period CodeInquireDateCodeString10Yes
Inquiry Period ExplanationInquireDateNameString100No
Detailed Reflection (Background)InquireDetailStringUnlimitedYes
Allergy PhotosAllergyImageListArrayNoAllergy 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 DescriptionField NameTypeRequiredRemarks
Return CodeErrorCodeStringYes"0" indicates success
Error MessageMessageStringNoUnique key for all brands
Customer Service System Ticket NumberCSTicketNoStringNo

3.5 Example of Return Values

{
    "ErrorCode": "0",
    "Message": "",
    "CSTicketNo": "xxxxxxxxxx"
}

Reviews