schm-shuyun-crm-papi

schm-shuyun-crm-papi

Interface description: shuyun CRM intends to process the business data read and write requests of each subsystem by means of open data service API interface.
UAT_URL: https://schm-api-test.shiseido.cn/schm-shuyun-crm-papi
PROD_URL: https://schm-api.shiseido.cn/schm-shuyun-crm-papi

1.Authentication Information

All request headers must contain the following key-value parameters as authentication information. You need to apply for this information from the administrator.

client_id: fa98****3452
client_secret: 108b****41f2

Original system parameters such as appKey, partyId, time, and sign do not need to be passed manually by the client. They are added automatically by mulesoft.

System parameters for automatic filling of test environment:

partyId: 65653

appKey: oms-server-client

2.API Description:

3.Member API

3.1. member registration

Interface Request: /member/register
Interface Description: For registered members
Request method: HTTP POST

Request Body Description:

customizedProperties

bindingExtProperties

Request body example

{
    "memberType": "shuyun",
    "memberName": "会员1",
    "gender": "F",
    "cardNo": "132156",
    "identityCard": "165465",
    "birthYear": "1998",
    "birthDay": "01-01",
    "country": "china",
    "provinceCode": "310000",
    "provinceName": "上海",
    "cityCode": "310100",
    "cityName": "上海市",
    "districtCode": "310107",
    "districtName": "普陀区",
    "address": "上海市徐汇区天钥桥路1001号",
    "job": "teacher",
    "shopCode": "shuyun",
    "shopName": "数云",
    "shopTypeCode": "shuyun",
    "registerTime": "2021-07-13 08:36:03",
    "customizedProperties": {
        "registerSource": "线下活动",
        "customizedTag": "{“爱好”:”篮球”}",
        "checkPolicyStatus": "1",
        "referrerMobile": "15021228866",
        "isGetInfoByEmail": "1",
        "isGetInfoBySMS": "1",
        "isGetInfoByServiceSMS": "1",
        "memberSalutation": "王女士",
        "memberStatus": "FREEZE",
        "sportsPreference": "篮球",
        "makeUpPreference": "口红",
        "desc": "备注",
        "customerSouce": "123",
        "metabolism": "11",
        "resistance": "11"
    },
    "bindingExtProperties": {
        "unionId": "unionId28154751841"
    },
    "mobile": "15021228866",
    "email": "1001@shuyun.com",
    "nick": "shuyun001",
    "channelType": "TAOBAO",
    "appTypeCode": "EBRAND",
    "appTypeName": "会员通",
    "customerNo": "string"
}

Response Body Description:

Return status code：

200：请求成功
201：注册会员成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

Response body example

Successful response Example:

{
"memberId": "0040a85608844820900558fc2671cb7c",
"cardNo": "0040a85608844820900558fc2671cb7c",
"status": "NEW"
}

error Example:

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.2. Query Member information

Interface Request: /member/query
Interface Description: Application Scenario and Description: memberId,mobile,cardNo Parameter query sequence memberId is preferred, followed by mobile, and followed by cardNo
Request method: HTTP GET

Request Body Description:

Response Body Description:

MemberBinding：

customizedProperties：

Response body example

{
"memberType": "shuyun",
"memberName": "会员 1",
"gender": "F",
"cardNo": "132156",
"identityCard": "165465",
"birthYear": "1998",
"birthDay": "01-01",
"country": "china",
"provinceCode": "310000",
"provinceName": "上海",
"cityCode": "310100",
"cityName": "上海市",
"districtCode": "310107",
"districtName": "普陀区",
"address": "上海市徐汇区天钥桥路 1001 号",
"job": "teacher",
"shopCode": "shuyun",
"shopName": "数云",
"shopTypeCode": "shuyun",
"registerTime": "2021-10-13T12:26:58.386+08:00",
"customizedProperties": {
"registerSource": "线下活动",
"customizedTag": "{“爱好”:”篮球”}",
"belongBC": "10001",
"belongShop": "10001",
"checkPolicyStatus": "1",
"referrerMobile": "15021228866",
"isGetInfoByEmail": "1",
"isGetInfoBySMS": "1",
"isGetInfoByServiceSMS": "1",
"wxOpenId": "NJkoIOJNBUOh",
"isSubscribe": "1"
"memberSalutation": "王女士",
"memberStatus": "FREEZE"，
"sportsPreference": "篮球"，
"makeUpPreference": "口红"
},
"mobile": "15021228866",
"email": "1001@shuyun.com",
"memberId": "0040a85608844820900558fc2671cb7c",
"memberBinding": [
{
"memberType": "shuyun",
"customerNo": "1001",
"mixMobile": "5608844820900558fc2671cb7c",
"appId": "appId28154751841",
"openId": "o3_wb5J_b7llpR5sWiDmRWZZnWes",
"shopCode": "shopcode1001",
"shopName": "01 门店",
"shopTypeCode": "01shop",
"appTypeCode": "EBRAND",
"appTypeName": "会员通",
"channelType": "TAOBAO",
"relType": 0,
"unionId": "string"
}
],
"firstRegisterChannelType": "POS",
"firstRegisterChannelTypeDesc": "线下",
"age": 18,
"wechatNick": "清风",
"headImgUrl": "http://111xx",
"unionId": "o-shjxsjidsdih"
}

Return status code：

200：请求成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example:

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.3. Query member points

Interface Request: /member/loyalty/point
Interface Description: Query member points
Request method: HTTP GET

Request Body Description:

Response Body Description:

Response body example

{
 "point": 100
}

Return status code：

200：请求成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.4. Query membership level

Interface Request: /member/loyalty/grade
Interface Description: Used to query membership level
Request method: HTTP GET

Request Body Description:

Response Body Description:

Response body example

{
 "effectiveTime": "2021-10-13T12:26:58.386+08:00",
 "expiredTime": "2021-10-13T12:26:58.386+08:00",
 "id": 0,
 "name": "string"
}

Return status code：

200：请求成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.5. Query member points change record

Interface Request: /member/point/records
Interface Description: For querying member points change records
Request method: HTTP GET

Request Body Description:

Response Body Description:

PointRecord:

Response body example

[
{
"memberId": "string",
"point": 0,
"totalPoint": "string",
"changeType": "SEND",
"description": "备注",
"effectiveTime": "2021-10-13T12:26:58.386+08:00",
"expiredTime": "2021-10-13T12:26:58.386+08:00",
"changeTime": "2021-10-13T12:26:58.386+08:00",
"changeMode": "MANUAL",
"id": "12dwdw",
"traceId": "12dwdw",
"channel": "TAOBAO",
"KZZD1": "活动积分",
"KZZD2": " 线下活动",
"KZZD3": " E0001"
}
]

Return status code：

200：请求成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.6. Query membership level change records

Interface Request: /member/grade/record
Interface Description: Used to query membership level change records
Request method: HTTP GET

Request Body Description:

Response Body Description:

GradeRecord:

Response body example

[
 {
 "changeTime": "2021-10-13T12:26:58.386+08:00",
 "changeType": "UPGRADE",
 "effectiveTime": "2021-10-13T12:26:58.386+08:00",
 "expiredTime": "2021-10-13T12:26:58.386+08:00",
 "gradeId": 0,
 "gradeName": "string",
 "memberId": "0040a85608844820900558fc2671cb7c",
 "originEffectiveTime": "2021-10-13T12:26:58.386+08:00",
 "originExpiredTime": "2021-10-13T12:26:58.386+08:00",
 "originalGradeId": 0,
 "originalGradeName": "string"
 }
]

Return status code：

200：请求成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.7. Change member points

Interface Request: /member/point
Interface Description: Used to change member points
Request method: HTTP PUT

Request Body Description:

header:

Body:

parameter example

{
"memberId": "0040a85608844820900558fc2671cb7c",
"point": 20,
"effectTime": "2021-07-13 08:36:03",
"expiredTime": "2021-07-13 08:36:03",
"changeType": "SEND",
"description": "备注",
"channelType": "POS",
"memberType": "shuyun",
"shopCode": "10001",
"KZZD1": "活动积分",
"KZZD2": ”线下活动",
"KZZD3": "E0001"
}

Return status code：

200：请求成功
201: Created
204: 修改会员积分成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.8. Freeze member points

Interface Request: /member/freezePoint
Interface Description: Used to freeze member points
Request method: HTTP POST

Request Body Description:

header:

Body:

parameter example

{
"memberId": "0040a85608844820900558fc2671cb7c",
"description": "备注",
"channelType": "SHUYUN",
"memberType": "shuyun",
"shopCode": "string",
"idempotentMode": 0,
"point": 20
}

Return status code：

200：请求成功
201: Created
204: 操作积分成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.9. Unfreeze member points

Interface Request: /member/unfreezePoint
Interface Description: Unfreeze member points
Request method: HTTP POST

Request Body Description:

header:

Body:

parameter example

{
"memberId": "0040a85608844820900558fc2671cb7c",
"description": "备注",
"channelType": "SHUYUN",
"memberType": "shuyun",
"shopCode": "string",
"idempotentMode": 0
}

Return status code：

200：请求成功
201: Created
204: 操作积分成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.10. Consume member's frozen points

Interface Request: /member/freezeDeductPoint
Interface Description: Consume member's frozen points
Request method: HTTP POST

Request Body Description:

header:

Body:

parameter example

{
"memberId": "0040a85608844820900558fc2671cb7c",
"description": "备注",
"channelType": "SHUYUN",
"memberType": "shuyun",
"shopCode": "string",
"idempotentMode": 0
}

Return status code：

200：请求成功
201: Created
204: 操作积分成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.11. Modify Member Information

Interface Request: /member/update
Interface Description: Modify Member Information
Request method: HTTP PUT

Request Body Description:

updateMember:

customizedProperties:

parameter example

{
"memberId": "0040a85608844820900558fc2671cb7c",
"channelType": "TAOBAO",
"memberType": "shuyun",
"memberName": "数云",
"gender": "F",
"email": "1001@shuyun.com",
"identityCard": "101100",
"birthYear": "1900",
"birthDay": "01-01",
"country": "china",
"provinceCode": "310000",
"provinceName": "上海",
"cityCode": "310100",
"cityName": "上海市",
"districtCode": "310107",
"districtName": "普陀区",
"address": "上海市徐汇区天钥桥路 1001 号",
"job": "teacher",
"contactTel": "18500002312",
"headImgUrl": "http://www.xxx.com/url?id=101",
"customizedProperties": {
"registerSource": "线下活动",
"customizedTag": "{“爱好”:”篮球”}",
"belongBC": "10001",
"belongShop": "10001"
"checkPolicyStatus": "1",
"referrerMobile": "15021228866",
"isGetInfoByEmail": "1",
"isGetInfoBySMS": "1",
"isGetInfoByServiceSMS": "1",
"memberSalutation": "王女士"，
"sportsPreference": "篮球"，
"makeUpPreference": "口红"
}
}

Return status code：

201: Created
204: 修改会员成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.12. Modify the member's mobile phone number

Interface Request: /member/modify/mobile
Interface Description: This parameter is used to change the mobile phone number of a member. Only the mobile phone number that is not registered can be changed
Request method: HTTP PUT

Request Body Description:

parameter example

{
"memberId": "0040a85608844820900558fc2671cb7c",
"memberType": "cpbomni",
"newMobile": "13100000000"
}

Return status code：

200: 修改成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.13. Update Member Privacy Policy (customized)

Interface Request: /member/modify/policy
Interface Description: Update member privacy policy loading and privacy policy time
Request method: HTTP POST

Request Body Description:

parameter example

{
"memberId": "0040a85608844820900558fc2671cb7c",
"memberType": "shuyun",
"checkPolicyStatus": "1",
"policyStatusUpdateTime": "2021-07-13 08:36:03"
}

Return status code：

200: 请求成功
201: Created
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.14. Query Member Properties Interface (custom)

Interface Request: /member/getAttributs/page
Interface Description: Query member properties interface, you can query joint member information
Request method: HTTP GET

Request Body Description:

Response Body Description:

memberAttributs:

Response body example

[
{
 "memberId": "0040a85608844820900558fc2671cb7c ",
 "memberType": "shuyun",
 "attributeCode": "huadi",
 "attributeName": "华帝联名会员",
 "updateTime": "2021-10-13T12:26:58.386+08:00",
 "createTime": "2021-10-13T12:26:58.386+08:00"
}
]

Return status code：

200: 请求成功
201: Created
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.15. Modify Member status interface (Custom)

Interface Request: /member/updateMemberStatus
Interface Description: Modify Member status
Request method: HTTP POST

Request Body Description:

Return status code：

200: 请求成功
201: Created
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.16. Query Member consumption channel interface (customized)

Interface Request: /member/purchase/channe
Interface Description: Query member consumption channel interface
Request method: HTTP GET

Request Body Description:

Response Body Description:

Response body example

{
 "memberId": "M1140ZRS59S3G",
 "purchaseChannel": ["TAOBAO","POS","ECMP","GW","ECMPcom"]
}

Return status code：

200: 请求成功
201: Created
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.17. Enquire the amount required for the next level of membership Interface (customized)

Interface Request: /member/loyalty/grade/nextGradeAmount
Interface Description: Check the amount required for the next level of membership
Request method: HTTP GET

Request Body Description:

Response Body Description:

Response body example

{
 "currentGradeId": 60040,
 "currentGradeName": "银钻卡",
 "memberId": "M1140ZRS59S3G",
 "consumeAmount": 170.0,
 "needAmount": 2830.0,
 "nextGradeId": "60041",
 "nextGradeName": "金卡",
 "nextGradeNeedAmount": 3000.0,
 "updatedTime": "2022-04-16T17:44:24.055+08:00"
}

Return status code：

200: 请求成功
201: Created
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.18. Query member information based on channel id (customized)

Interface Request: /customer/queryByChannelId
Interface Description: Query basic member information according to channel Id
Request method: HTTP GET

Request Body Description:

Response Body Description:

SimpleMemberDto:

Response body example

{
 "memberType": "shuyun",
 "memberId": "shuyun",
 "memberName": "小小",
 "gender": "F",
 "identityCard": "101100",
 "dateOfBirth": "1998-01-01",
 "mobile": "18909890000",
 "cardNo": "1727832",
 "email": "1001@shuyun.com",
 "marriageStatus": "Y",
 "registerTime": "2021-12-30T02:24:02.202Z",
 "shopCode": "shopcode1001",
 "shopName": "01 门店"
}

Return status code：

200: 成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

3.19. Query member points about to expire in the current month (customized)

Interface Request: /member/invalid/point
Interface Description: Used to query members' points that will expire in the current month
Request method: HTTP GET

Request Body Description:

Response Body Description:

Response body example

{
 "point": 100
}

Return status code：

200: 请求成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

4.Member Collection Level API (Custom)

4.1. Check the level of member collection

Interface Request: /member/loyalty/accountGrade
Interface Description: Used to query the membership level of a specified account
Request method: HTTP GET

Request Body Description:

Response Body Description:

Response body example

{
 "effectiveTime": "2021-10-13T12:26:58.386+08:00",
 "expiredTime": "2021-10-13T12:26:58.386+08:00",
 "id": 0,
 "name": "string"
}

Return status code：

200: 请求成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

4.2. Query the membership level change record of the specified account

Interface Request: /member/accountGrade/record
Interface Description: Used to query the membership level change record of the specified account
Request method: HTTP GET

Request Body Description:

Response Body Description:

GradeRecord:

Response body example

[
 {
 "changeTime": "2021-10-13T12:26:58.386+08:00",
 "changeType": "UPGRADE",
 "effectiveTime": "2021-10-13T12:26:58.386+08:00",
 "expiredTime": "2021-10-13T12:26:58.386+08:00",
 "gradeId": 0,
 "gradeName": "string",
 "memberId": "0040a85608844820900558fc2671cb7c",
 "originEffectiveTime": "2021-10-13T12:26:58.386+08:00",
 "originExpiredTime": "2021-10-13T12:26:58.386+08:00",
 "originalGradeId": 0,
 "originalGradeName": "string"
 }
]

Return status code：

200: 成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

5.Member past points API

5.1. Query members' past points

Interface Request: /member/past/point
Interface Description: Used to query members' past points
Request method: HTTP GET

Request Body Description:

Response Body Description:

Response body example

{
 "point": 100
}

Return status code：

200: 成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

5.2. Query the member's past points change record

Interface Request: /member/past/point/records
Interface Description: It is used to query the change records of members' past points
Request method: HTTP GET

Request Body Description:

Response Body Description:

PointRecord:

Response body example

[
{
"memberId": "string",
"point": 0,
"totalPoint": "string",
"changeType": "SEND",
"description": "备注",
"effectiveTime": "2021-10-13T12:26:58.386+08:00",
"expiredTime": "2021-10-13T12:26:58.386+08:00",
"changeTime": "2021-10-13T12:26:58.386+08:00",
"changeMode": "MANUAL",
"id": "12dwdw",
"traceId": "12dwdw",
"channel": "TAOBAO",
"KZZD1": "活动积分",
"KZZD2": " 线下活动",
"KZZD3": " E0001"
}
]

Return status code：

200: 请求成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

5.3. Change member's past points

Interface Request: /member/past/pointchange
Interface Description: Used to change members' past points
Request method: HTTP PUT

Request Body Description:

header:

Body:

parameter example

{
"memberId": "0040a85608844820900558fc2671cb7c",
"accountType": "CPBPAST",
"point": 20,
"effectTime": "2021-07-13 08:36:03",
"expiredTime": "2021-07-13 08:36:03",
"changeType": "SEND",
"description": "备注",
"channelType": "POS",
"memberType": "shuyun",
"shopCode": "10001",
"KZZD1": "活动积分",
"KZZD2": ”线下活动",
"KZZD3": "E0001"
}

Return status code：

200: 请求成功
201: Created
204: 修改会员积分成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

6.Member order API

6.1. Query member order information

Interface Request: /order/{memberType}/page
Interface Description: Used to query member order information
Request method: HTTP GET

Request Body Description:

Response Body Description:

Response body example

{
"currentPage": 0,
"pageSize": 0,
"totalCount": 0,
"totalPage": 0,
"data": [
{
"memberType": "shuyun",
"orderId": "087989aaf6af4e58897794d18axxxxx",
"originOrderId": "087989aaf6af4e58897794d18axxxxx",
"customerNo": "T000001",
"shopCode": "SHOP001",
"shopName": "SHOP001",
"memberId": "1c25f18ad274493882d01660e3exxxxx",
"shopTypeCode": "TAOBAO",
"orderType": "NORMAL",
"orderStatus": "FINISHED",
"channelType": "TAOBAO",
"totalQuantity": 1,
"totalFee": 85,
"payment": 85,
"freight": 10,
"discountRate": 0.85,
"discountFee": 15,
"receiverName": "abc",
"receiverMobile": "18900000000",
"receiverTelephone": "18900000000",
"receiverProvince": "上海",
"receiverCity": "上海",
"receiverDistrict": "浦东新区",
"receiverAddress": "南京东路 100 号",
"receiverZipCode": "200000",
"couponNo": "C123456",
"couponFee": 15,
"guideCode": "001",
"description": "无",
"orderTime": "2021-10-13T12:26:58.386+08:00",
"payTime": "2021-10-13T12:26:58.386+08:00",
"finishTime": "2021-10-13T12:26:58.386+08:00",
"receiveTime": "2021-10-13T12:26:58.386+08:00",
"shippingTime": "2021-10-13T12:26:58.386+08:00",
"exchangeTime": "2021-10-13T12:26:58.386+08:00",
"refundTime": "2021-10-13T12:26:58.386+08:00",
"pointFlag": 1,
"orderItems": [
{
"orderItemId": "bf3a654f1afa4859bb5c0e8846bxxxxx",
"originOrderItemId": "bf3a654f1afa4859bb5c0e8846bxxxxx",
"productCode": "P001",
"productName": "P001",
"totalFee": 85,
"payment": 85,
"quantity": 1,
"channelType": "TAOBAO",
"status": "FINISHED",
"skuId": "S001",
"shopTypeCode": "TAOBAO",
"tagPrice": 100,
"retailPrice": 100,
"discountRate": 0.85,
"discountFee": 15,
"orderType": "NORMAL",
"finishTime": "2021-10-13T12:26:58.386+08:00",
"payTime": "2021-10-13T12:26:58.386+08:00",
"orderTime": "2021-10-13T12:26:58.386+08:00",
"picture": [
"https://allpro.saas.top/FsB-uzzX4WtCzpDuVuwqp2OdNbQ?e=1547742055&token=yNjhOp7gnH4St9yP72OlwuQ6JUNQf49pxAuGWYFt
:1eZIUjRKIekGuMGG-c-s7UqNF1Y=;"
],
"customizedProperties": {
"string": "update"
}
}
],
"customizedProperties": {
 "ticketNum": "123456789",
 "salesMode": "123456789",
 "presaleFlag": "123456789",
 "presaleStoreId": "123456789",
 "presalePosId": "123456789",
 "presaleBillNo": "123456789",
 "presaleReturnStoreId": "123456789",
 "presaleReturnPosId": "123456789",
 "presaleReturnBillNo": "123456789",
 "orderSource": "10"
},
"id": "string"
}
]
}

Return status code：

200: 成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

6.2. Check member order details

Interface Request: /order/{memberType}/{orderId}
Interface Description: Used to query the details of the main order and suborder
Request method: HTTP GET

Request Body Description:

Response Body Description:

orderInfo:

customizedProperties:

|ticketNum|String| |100|小票号|
|salesMode|String| |10|销售type，可选值为0（常规销售）、1（团购）|
|presaleFlag|String| |10|预售区分，可选值为0（普通）、1（预售）、2（提货）|
|presaleStoreId|String| |32|预售店铺编号|
|presalePosId|String| |32|预售POS机号|
|presaleBillNo|String| |32|预售小票号|
|presaleReturnStoreId|String| |32|预售退货店铺编号|
|presaleReturnPosId|String| |32|预售退货POS机号|
|presaleReturnBillNo|String| |32|预售退货小票号|
|orderSource|String| |64|订单来源，枚举type字段，具体枚举值参考枚举字典文档|

Response body example

{
 "memberType": "shuyun",
 "orderId": "087989aaf6af4e58897794d18axxxxx",
 "originOrderId": "087989aaf6af4e58897794d18axxxxx",
 "customerNo": "T000001",
 "shopCode": "SHOP001",
 "shopName": "SHOP001",
 "memberId": "1c25f18ad274493882d01660e3exxxxx",
 "shopTypeCode": "TAOBAO",
 "orderType": "NORMAL",
 "orderStatus": "FINISHED",
 "channelType": "TAOBAO",
 "totalQuantity": 1,
 "totalFee": 85,
 "payment": 85,
 "freight": 10,
 "discountRate": 0.85,
 "discountFee": 15,
 "receiverName": "abc",
 "receiverMobile": "18900000000",
 "receiverTelephone": "18900000000",
 "receiverProvince": "上海",
 "receiverCity": "上海",
 "receiverDistrict": "浦东新区",
 "receiverAddress": "南京东路 100 号",
 "receiverZipCode": "200000",
 "couponNo": "C123456",
 "couponFee": 15,
 "guideCode": "001",
 "description": "无",
 "orderTime": "2021-10-13T12:26:58.386+08:00",
 "payTime": "2021-10-13T12:26:58.386+08:00",
 "finishTime": "2021-10-13T12:26:58.386+08:00",
 "receiveTime": "2021-10-13T12:26:58.386+08:00",
 "shippingTime": "2021-10-13T12:26:58.386+08:00",
 "exchangeTime": "2021-10-13T12:26:58.386+08:00",
 "refundTime": "2021-10-13T12:26:58.386+08:00",
 "pointFlag": 1,
"orderItems": [
 {
 "orderItemId": "bf3a654f1afa4859bb5c0e8846bxxxxx",
 "originOrderItemId": "bf3a654f1afa4859bb5c0e8846bxxxxx",
 "productCode": "P001",
 "productName": "P001",
 "totalFee": 85,
 "payment": 85,
 "quantity": 1,
 "channelType": "TAOBAO",
 "status": "FINISHED",
 "skuId": "S001",
 "shopTypeCode": "TAOBAO",
 "tagPrice": 100,
 "retailPrice": 100,
 "discountRate": 0.85,
 "discountFee": 15,
 "orderType": "NORMAL",
 "finishTime": "2021-10-13T12:26:58.386+08:00",
 "payTime": "2021-10-13T12:26:58.386+08:00",
 "orderTime": "2021-10-13T12:26:58.386+08:00",
 "picture": [
 "https://allpro.saas.top/FsB-uzzX4WtCzpDuVuwqp2OdNbQ?e=1547742055&token=yNjhOp7gnH4St9yP72OlwuQ6JUNQf49pxAuGWYFt
:1eZIUjRKIekGuMGG-c-s7UqNF1Y=;"
 ],
 "customizedProperties": {
 "string": "update"
 }
 }
 ],
 "customizedProperties": {
 "ticketNum": "123456789",
 "salesMode": "123456789",
 "presaleFlag": "123456789",
 "presaleStoreId": "123456789",
 "presalePosId": "123456789",
 "presaleBillNo": "123456789",
 "presaleReturnStoreId": "123456789",
 "presaleReturnPosId": "123456789",
 "presaleReturnBillNo": "123456789",
 "orderSource": "10"
 },
 "id": "string"
}

Return status code：

200: 成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

6.3. Order save or update

Interface Request: /order/save
Interface Description: Order save or update
Request method: HTTP POST

Request Body Description:

Order:

customizedProperties:

parameter example

{
"memberType": "shuyun",
"orderId": "087989aaf6af4e58897794d18axxxxx",
"originOrderId": "087989aaf6af4e58897794d18axxxxx",
"customerNo": "T000001",
"shopCode": "SHOP001",
"shopName": "SHOP001",
"memberId": "1c25f18ad274493882d01660e3exxxxx",
"shopTypeCode": "TAOBAO",
"orderType": "NORMAL",
"orderStatus": "FINISHED",
"channelType": "TAOBAO",
"totalQuantity": 1,
"totalFee": 85,
"payment": 85,
"freight": 10,
"discountRate": 0.85,
"discountFee": 15,
"receiverName": "abc",
"receiverMobile": "18900000000",
"receiverTelephone": "18900000000",
"receiverProvince": "上海",
"receiverCity": "上海",
"receiverDistrict": "浦东新区",
"receiverAddress": "南京东路 100 号",
"receiverZipCode": "200000",
"couponNo": "C123456",
"couponFee": 15,
"guideCode": "001",
"description": "无",
"orderTime": "2021-07-13 08:36:03",
"payTime": "2021-07-13 08:36:03",
"finishTime": "2021-07-13 08:36:03",
"receiveTime": "2021-07-13 08:36:03",
"shippingTime": "2021-07-13 08:36:03",
"exchangeTime": "2021-07-13 08:36:03",
"refundTime": "2021-07-13 08:36:03",
"pointFlag": 1,
"orderItems": [
{
"orderItemId": "bf3a654f1afa4859bb5c0e8846bxxxxx",
"originOrderItemId": "bf3a654f1afa4859bb5c0e8846bxxxxx",
"productCode": "P001",
"productName": "P001",
"totalFee": 85,
"payment": 85,
"quantity": 1,
"channelType": "TAOBAO",
"status": "FINISHED",
"skuId": "S001",
"shopTypeCode": "TAOBAO",
"tagPrice": 100,
"retailPrice": 100,
"discountRate": 0.85,
"discountFee": 15,
"orderType": "NORMAL",
"finishTime": "2021-07-13 08:36:03",
"payTime": "2021-07-13 08:36:03",
"orderTime": "2021-07-13 08:36:03",
"picture": [
"https://allpro.saas.top/FsB-uzzX4WtCzpDuVuwqp2OdNbQ?e=1547742055&token=yNjhOp7gnH4St9yP72OlwuQ6JUNQf49pxAuGWYFt
:1eZIUjRKIekGuMGG-c-s7UqNF1Y=;"
],
"customizedProperties": {
"string": "update"
}
}
],
"customizedProperties": {
"ticketNum": "123456789",
 "salesMode": "123456789",
 "presaleFlag": "123456789",
 "presaleStoreId": "123456789",
 "presalePosId": "123456789",
"presaleBillNo": "123456789",
"presaleReturnStoreId": "123456789",
"presaleReturnPosId": "123456789",
"presaleReturnBillNo": "123456789",
"orderSource": "10"
}
}

Return status code：

200: 成功
201: Created
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

7.Voucher API

7.1. Check the list of card voucher programs

Interface Request: /offer/project/list
Interface Description: This parameter is used to query the card item list. The field returned by the actual interface is consistent with the definition of the voucher type
Request method: HTTP POST

Request Body Description:

parameter example

{
 "memberType": "shuyun",
 "channelType": "KYLIN_GUIDE",
 "currentPage": 1,
 "pageSize": 10,
 "status": "VALID",
 "name": "xxx",
 "projectIds": "[11,12]",
 "updateTime": "2021-10-10 11:00:00"
}

Response Body Description:

Response body example

{
 "currentPage": 0,
 "pageSize": 0,
 "data": [
 {
 "instanceId": "001",
 "status": "VALID",
 "memberId": "32345464545",
 "projectId": "1001",
 "couponCode": "couponCode",
 "projectType": "CASH",
 "projectName": "新会员券",
 "validTime": "2022-05-30T02:59:48.190Z",
 "expireTime": "2022-05-30T02:59:48.190Z",
 "effectText": "12 元、8.5 折",
 "ruleText": "具体规则",
 "grantTime": "2022-05-30T02:59:48.190Z",
 "useTime": "2022-05-30T02:59:48.190Z",
 "selectorRule": {
 "productScope": [
 "P001",
 "P002",
 "P003"
 ],
 "excludeProduct": [
 "P001",
 "P002",
 "P003"
 ],
 "receiveProductScope": [
 "P001",
 "P002",
 "P003"
 ],
 "applicationShop": [
 "S001",
 "S002",
 "S003"
 ]
 },
 "customizedProperties": {
 "couponType": "Initiative",
 "multiLayer": "0",
 "applicableGrade1": "1",
 "applicableGrade2": "0",
 "applicableGrade3": "0",
 "applicableGrade4": "0",
 "applicableGrade5": "0",
 "ownerShop": "1",
 "limitOwnerShop": "0",
 "orderAmount": 100,
 "orderNumber": 2,
 "points": 100,
 "isMobileCheck": "1",
 "giftName": "精华",
 "giftContent": "精华 20ml",
 "giftValue": "20",
 "activityCounter": "",
 "useRule": "",
 "reminder": "",
 "validyType": "",
 "configuredUsableDays": "",
 "isChangeCoupon": ""
 }
 "presetOrCustomField": {
 "key": "value"
 }
 }
 ]
}

Return status code：

200: 成功
201: Created
204: 操作积分成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

7.2. Check the details of the voucher program

Interface Request: /offer/project/detail
Interface Description: This parameter is used to query the details of the card item. The field returned by the actual interface must be consistent with the definition of the coupon type
Request method: HTTP GET

Request Body Description:

Response Body Description:

project:

selectorRule:

customizedProperties:

Response body example

{
 "projectId": "001",
 "type": "cashEffect",
 "status": "VALID",
 "name": "数云项目",
 "validTime": "2020-11-30T16:48:03+08:00",
 "expireTime": "2020-11-30T16:48:03+08:00",
 "totalCount": "100",
 "effectText": "12 元、8.5 折",
 "ruleText": "具体规则",
"selectorRule": {
 "productScope": [
 "P001",
 "P002",
 "P003"
 ],
 "excludeProduct": [
 "P001",
 "P002",
 "P003"
 ],
 "receiveProductScope": [
 "P001",
 "P002",
 "P003"
 ],
 "applicationShop": [
 "S001",
 "S002",
 "S003"
 ]
 },
 "customizedProperties": {
 "couponType": "Initiative",
 "multiLayer": "0",
 "applicableGrade1": "1",
 "applicableGrade2": "0",
 "applicableGrade3": "0",
 "applicableGrade4": "0",
 "applicableGrade5": "0",
 "ownerShop": "1",
 "limitOwnerShop": "0",
 "orderAmount": 100,
 "orderNumber": 2,
 "points": 100,
 "isMobileCheck": "1",
 "giftName": "精华",
 "giftContent": "精华 20ml",
 "giftValue": "20",
 "activityCounter": "",
 "useRule": "",
 "reminder": "",
 "validyType": "",
 "configuredUsableDays": "",
 "isChangeCoupon": ""
 },
 "updateTime": "2020-11-30T16:48:03+08:00"
}

Return status code：

200: 成功
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

7.3. Card issue with idempotent (Single member sheet)

Interface Request: /offer/instance/grant
Interface Description: It is recommended to limit the entry fields of voucher issuance to the fields defined by [card item] to avoid misunderstandings when using subsequent data (the card interface will remember all the fields described in the body and extension fields, without restriction).
Request method: HTTP POST

Request Body Description:

header:

Body:

params:

parameter example

{
 "channelType": "KYLIN_GUIDE",
 "memberType": "shuyun",
 "memberId": "10001",
 "projectId": "1001",
 "params": {
 "campaignId": "100001",
 "selectShopCode": "100001"，
 "orderId": "100001"，
 "sharedBy": "100001"，
 "sharedCouponCode": "100001"
}
}

Response Body Description:

Response body example

{
"success": true,
"msg": "xxx",
"instanceIds": "11,22",
"instanceInfos": [
{
 "instanceId": "001",
 "couponCode": "SDSDSZ1",
 "projectId": "1001",
 "status": "GRANTED",
 "grantTime": "2021-12-15T17:10:01.218+08:00"
}
]
}

Return status code：

200: 请求成功
201: Created
401：api-gateway 鉴权失败
403: 禁止访问
404: 请求的 URL 不存在

error Example

{
 "module": "Solution Package",
 "service": "openapi",
 "code": "010407",
 "desc": "参数异常",
 "uri": "http://..."
}

7.4. Cancellation of frozen card (single card)

Interface Request: /offer/coupon/writeoff
Interface Description: Used for the verification of frozen card vouchers (single card vouchers), this interface will verify the status and validity of the voucher, and other fields are not restricted
Request method: HTTP POST

Request Body Description:

params:

parameter example

{
"channelType": "KYLIN_GUIDE",
"couponCode": "96800081",
"memberType": "shuyun",
"params": {
 "shopCode": "123",
 "employeeId": "123"
 "counterId": "123"
 "ticketNum": "123"
 "recordId": "123"
 "productCode": "123"
}
}