schm-pos-nccs-eapi
API Reference (Chinese Version)
schm-pos-nccs-eapi
接口描述: 客服工单信息接口
DEV地址(开发环境): https://schm-api-dev.shiseido.cn/schm-pos-nccs-eapi
UAT地址(测试环境): https://schm-api-test.shiseido.cn/schm-pos-nccs-eapi
PROD地址(生产环境): https://schm-api.shiseido.cn/schm-pos-nccs-eapi
1.身份认证
所有请求头必须包含以下键值参数作为身份验证信息。您需要向管理员申请这些信息。
client_id: fa98****3452
client_secret: 108b****41f2
2.接口总览:
请求接口 | 描述 |
---|---|
/caseEntry | 客服工单信息接口 |
完整调用地址为对应环境地址+接口地址,例如:
https://schm-api-test.shiseido.cn/schm-pos-nccs-eapi/caseEntry
3.接口调用说明
3.1 客服工单信息接口
请求接口: /caseEntry
接口描述: 客服工单信息接口
请求类型: HTTP POST
3.2 参数说明
字段名称 | 类型 | 必填 | 字段说明 |
---|---|---|---|
AcceptMethodCode | String | 是 | 受理方法(传枚举值) |
StoreId | String | 是 | 送达方代码 |
Shipto | String | 否 | 商店代码 |
EmployeeId | String | 是 | 案件受理者 |
AcceptedPhone | String | 是 | 受理人联系电话 |
DeptCode | String | 否 | 所属部门 |
AcceptDate | String | 否 | 受理日期(时间格式 yyyy-MM-dd HH:mm:ss) |
CustomerName | String | 是 | 客户姓名 |
AgeCode | String | 是 | 年龄(传枚举值) |
GenderCode | String | 是 | 性别(传枚举值) |
Mobile | String | 是 | 手机号 |
MemberNo | String | 否 | 会员ID |
NationalityCode | String | 否 | 国籍(传枚举值,默认中国) |
ProvinceCode | String | 是 | 地区(传枚举值) |
NationCode | String | 否 | 民族(传枚举值,默认汉族) |
Address | String | 否 | 地址 |
TicketTypeCode | String | 是 | 案件类型(传枚举值,默认顾客案件) |
InfoFeatureCode | String | 是 | 信息特征(传枚举值) |
InfoSourceCode | String | 是 | 信息源(传枚举值) |
ProcessResultCode | String | 是 | 对应结果 |
TicketNo | String | 是 | POS客服工单号 |
GoodsList | List | 是 | 参照下方 |
SymptomClassList | List | 是 | 参照下方 |
InquireContentData | ObjectMap | 是 | 参照下方 |
商品信息 GoodsList:
字段名称 | 类型 | 必填 | 字段说明 |
---|---|---|---|
GoodsCode | String | 是 | 商品代码 |
GoodsName | String | 否 | 商品名称 |
ProductBatchNo | String | 是 | 生产记号 |
ExpiredDate | String | 否 | 到期日期(时间格式 yyyy-MM-dd HH:mm:ss) |
BuyDate | String | 否 | 购入日期(时间格式 yyyy-MM-dd HH:mm:ss) |
反映信息(过敏症状)SymptomClassList:
字段名称 | 类型 | 必填 | 字段说明 |
---|---|---|---|
SymptomClass1Code | String | 是 | 内容分类(级联枚举) |
SymptomClass2Code | String | 是 | 内容分类2(级联枚举) |
SymptomClass3Code | String | 是 | 内容分类3(级联枚举) |
询问信息 InquireContentData:
字段名称 | 类型 | 必填 | 字段说明 |
---|---|---|---|
RecoveryStatusUnknownContent | String | 否 | 恢复状态(症状转换期)其他补充 |
SymptomDate | String | 是 | 症状发生日期(时间格式 yyyy-MM-dd HH:mm:ss) |
SymptomParts1Code | String | 是 | 症状发生部位(1)(传枚举值) |
SymptomParts2Code | String | 否 | 症状发生部位(2)(传枚举值) |
SymptomParts3Code | String | 否 | 症状发生部位(3)(传枚举值) |
OtherSymptomCode | String | 是 | 其他损害(传枚举值) |
SkinSymptomCode | String | 是 | 皮损形态(传枚举值) |
SkinSymptomOtherContent | String | 否 | 皮损形态其他补充 |
PreliminaryResultCode | String | 是 | 初步判断(传枚举值) |
PreliminaryResultOtherContent | String | 否 | 初步判断其他补充 |
FirstUsedCode | String | 是 | 是否第一次使用致敏产品(传枚举值) |
BeginUsedDate | String | 是 | 开始使用时间(时间格式 yyyy-MM-dd HH:mm:ss) |
UsedCount | String | 否 | 使用次数 |
UsedFrequency | String | 否 | 使用频率(次/天) |
StopUsedCode | String | 否 | 使用停止状况 |
StopUsedDate | String | 是 | 使用中止日期(时间格式 yyyy-MM-dd HH:mm:ss) |
RecoveryStatusCode | String | 是 | 恢复状态(症状转换期) |
RecoveryDate | String | 否 | 恢复日期(时间格式 yyyy-MM-dd HH:mm:ss) |
MedicalDiagnosisCode | String | 否 | 接受医疗机关诊察 |
MedicalDiagnosisDate | String | 否 | 医疗机关诊察日期(时间格式yyyy-MM-dd HH:mm:ss) |
DiagnosisReportCode | String | 否 | 有无诊断书(传枚举值) |
DiagnosisReportList | List | 否 | 医疗诊断书(附件地址) |
MedicalInstitutionName | String | 否 | 接受诊断医疗机关名称 |
AllergyCode | String | 否 | 过敏体质·过敏经验(传枚举值) |
AllergyContent | String | 否 | 过敏体质过敏经验内容 |
ConsultTypeCode | String | 是 | 对应种类(传枚举值) |
InquireDateCode | String | 是 | 咨询时期(传枚举值) |
InquireDetail | String | 是 | 详细反映(背景) |
AllergyImageList | List | 否 | 过敏照片(附件地址) |
UseAgainCode | String | 是 | 再次使用了么(传枚举值 ) |
UseAgainReactionCode | String | 否 | 再次使用时的反应(传枚举值) |
UseAgainDate | String | 否 | 再次使用日期(时间格式 yyyy-MM-dd HH:mm:ss) |
3.3 参数示例
{
"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 返回值说明
字段描述 | 字段名称 | 类型 | 必填 | 备注 | |
---|---|---|---|---|---|
返回 Code | ErrorCode | String | 是 | "0" 表示成功 | |
错误消息 | Message | String | 全品牌唯一 Key | ||
客服系统工单号 | CSTicketNo | String |
3.5 返回值示例
{
"ErrorCode": "0",
"Message": "",
"CSTicketNo": "xxxxxxxxxx"
}