schm-poscrm-papi

Basic Instructions

This interface is based on the Shiseido POSCRM interface and serves as the proxy interface.

This interface eliminates the authentication step of Shiseido POSCRM and can be called directly with plaintext parameters.

The unique authentication information of this interface is client_id and client_secret in the header, which serve as the caller ID.

Each interface has an independent call permission. To use the interface, apply for the interface permission from the administrator.

This document describes in detail the interface development specifications required for third-party system developers to access SCHM-POSCRM.

This interface specification includes general specification and business specification. The general specification describes the common parts that all interfaces must comply with. The business specification describes the detailed data content required by each actual business interface according to the specific service interaction content.

If you have used the four original poscrm interfaces separated from the previous version, please refer to Differences from the original four mulesoft poscrm interfaces

1. This interface is modified and combined from the original four mulesoft poscrm interfaces, member, loyalty, sales, and questionaireandreport. Now a unified request address is used.

2. The service meanings of all parameters and return values of the interface are the same as those of the sent values, but parameters can only be passed in json format.

3. The addresses of the interfaces are almost the same, with minor changes on some interfaces.

1. Interface General Specification

1.1 Interface Address Prefix

UAT address (test environment): https://schm-api-test.shiseido.cn

PROD address (production environment): https://schm-api.shiseido.cn

1.2 Interface Calling Mode

Interfaces use HTTPS to request information. The actual requested address is as follows:

[UAT-address or PROD-address]/schm-poscrm-papi/{version}/{INTERFACE_URL}

The version parameter is v2. INTERFACE_URL must be set to the interface address in the interface description.

For example, for Member Authentication, the test environment request address is: https://schm-api-test.shiseido.cn/schm-poscrm-papi/v2/member/verify

1.3 Permission Specification

To access all interfaces, set key to client_id and client_secret in header. Different interface callers use different parameters. You need to apply for authentication information from the administrator.

For example:

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

The interface authenticates permissions based on the client_id. The system authenticates interface addresses and ownerids in parameters.

1. Request address authentication: The interface uses clinet_id to check whether the interface can be used.
2. ownerId authentication: Each interface passes the ownerId parameter, which indicates the brand ID. The interface checks whether it can operate on the brand using the client_id.

1.4 Business Parameter Description

The interface supports only JSON format. When the interface is invoked, the business parameters are submitted as POST.

It is recommended to add the following header Settings when calling the interface:

Content-Type=application/json

1.5 Return Result Description

The result returned by the interface is directly returned in clear text.

The format of the result returned by the interface is JSON.

Directory

• Interface Description
  • 2.1 Member Authentication
    • 2.1.1 Parameter Description
    • 2.1.2 Parameter Example
    • 2.1.3 Return Result Description
    • 2.1.4 Return Result Example
  • 2.2 Apply For Membership
    • 2.2.1 Parameter Description
    • 2.2.2 Parameter Example
    • 2.2.3 Return Result Description
    • 2.2.4 Return Result Example
  • 2.3 Membership Binding
    • 2.3.1 Parameter Description
    • 2.3.2 Parameter Example
    • 2.3.3 Return Result Description
    • 2.3.4 Return Result Example
  • 2.4 Modify member information
    • 2.4.1 Parameter Description
    • 2.4.2 Parameter Example
    • 2.4.3 Return Result Description
    • 2.4.4 Return Result Example
  • 2.5 Query Member Information
    • 2.5.1 Parameter Description
    • 2.5.2 Parameter Example
    • 2.5.3 Return Result Description
    • 2.5.4 Return Result Example
  • 2.6 Cancellation Of Membership
    • 2.6.1 Parameter Description
    • 2.6.2 Parameter Example
    • 2.6.3 Return Result Description
    • 2.6.4 Return Result Example
  • 2.7 Query Member Points
    • 2.7.1 Parameter Description
    • 2.7.2 Parameter Example
    • 2.7.3 Return Result Description
    • 2.7.4 Return Result Example
  • 2.8 Inquire The Member's Point Record Of The Current Period
    • 2.8.1 Parameter Description
    • 2.8.2 Parameter Example
    • 2.8.3 Return Result Description
    • 2.8.4 Return Result Example
  • 2.9 Adjust Member Points
    • 2.9.1 Parameter Description
    • 2.9.2 Parameter Example
    • 2.9.3 Return Result Description
    • 2.9.4 Return Result Example
  • 2.10 Credit deducted after the gift is redeemed
    • 2.10.1 Parameter Description
    • 2.10.2 Parameter Example
    • 2.10.3 Return Result Description
    • 2.10.4 Return Result Example
  • 2.11 Inquire Member Consumption History
    • 2.11.1 Parameter Description
    • 2.11.2 Parameter Example
    • 2.11.3 Return Result Description
    • 2.11.4 Return Result Example
  • 2.12 Query Membership Level Information
    • 2.12.1 Parameter Description
    • 2.12.2 Parameter Example
    • 2.12.3 Return Result Description
    • 2.12.4 Return Result Example
  • 2.13 Tmall Member Binding/Unbinding
    • 2.13.1 Parameter Description
    • 2.13.2 Parameter Example
    • 2.13.3 Return Result Description
    • 2.13.4 Return Result Example
  • 2.14 Receive Orders From Tmall
    • 2.14.1 Parameter Description
    • 2.14.2 Parameter Example
    • 2.14.3 Return Result Description
    • 2.14.4 Return Result Example
  • 2.15 Check the mileage information purchased by members (NARS))
    • 2.15.1 Parameter Description
    • 2.15.2 Parameter Example
    • 2.15.3 Return Result Description
    • 2.15.4 Return Result Example
  • 2.16 Enquire about members' Redeemable Status (NARS))
    • 2.16.1 Parameter Description
    • 2.16.2 Parameter Example
    • 2.16.3 Return Result Description
    • 2.16.4 Return Result Example
    • 2.16.4 Definition Of Ritual Rules
  • 2.17 Acknowledge event gift reservation (NARS))
    • 2.17.1 Parameter Description
    • 2.17.2 Parameter Example
    • 2.17.3 Return Result Description
    • 2.17.4 Return Result Example
  • 2.18 Acknowledge event gift redemption (NARS))
    • 2.18.1 Parameter Description
    • 2.18.2 Parameter Example
    • 2.18.3 Return Result Description
    • 2.18.4 Return Result Example
  • 2.19 Update Member Privacy Policy Confirmation Status
    • 2.19.1 Parameter Description
    • 2.19.2 Parameter Example
    • 2.19.3 Return Result Description
    • 2.19.4 Return Result Example
  • 2.20 Third-party platform ID binding(Such as SFCCID))
    • 2.20.1 Parameter Description
    • 2.20.2 Parameter Example
    • 2.20.3 Return Result Description
    • 2.20.4 Return Result Example
  • 2.21 Update Member's Store And BC Information
    • 2.21.1 Parameter Description
    • 2.21.2 Parameter Example
    • 2.21.3 Return Result Description
    • 2.21.4 Return Result Example
  • 2.22 Update Member Label
    • 2.22.1 Parameter Description
    • 2.22.2 Parameter Example
    • 2.22.3 Return Result Description
    • 2.22.4 Return Result Example
  • 2.23 Inquire About Member Gifts And Vouchers
    • 2.23.1 Parameter Description
    • 2.23.2 Parameter Example
    • 2.23.3 Return Result Description
    • 2.23.4 Return Result Example
  • 2.24 Query The Promotion Number
    • 2.24.1 Parameter Description
    • 2.24.2 Parameter Example
    • 2.24.3 Return Result Description
    • 2.24.4 Return Result Example
  • 2.25 Add Active Objects In Batches
    • 2.25.1 Parameter Description
    • 2.25.2 Parameter Example
    • 2.25.3 Return Result Description
    • 2.25.4 Return Result Example
  • 2.26 Cancel Member Gift Application Or Point Exchange Reservation
    • 2.26.1 Parameter Description
    • 2.26.2 Parameter Example
    • 2.26.3 Return Result Description
    • 2.26.4 Return Result Example
  • 2.27 Make An Appointment For The Event Gift
    • 2.27.1 Parameter Description
    • 2.27.2 Parameter Example
    • 2.27.3 Return Result Description
    • 2.27.4 Return Result Example
  • 2.28 Apply For A Trial Gift
    • 2.28.1 Parameter Description
    • 2.28.2 Parameter Example
    • 2.28.3 Return Result Description
    • 2.28.4 Return Result Example
  • 2.29 Cancel The Trial Application
    • 2.29.1 Parameter Description
    • 2.29.2 Parameter Example
    • 2.29.3 Return Result Description
    • 2.29.4 Return Result Example
  • 2.30 Member Service Voucher In Advance
    • 2.30.1 Parameter Description
    • 2.30.2 Parameter Example
    • 2.30.3 Return Result Description
    • 2.30.4 Return Result Example
  • 2.31 Verification The Member's Coupon Code
    • 2.31.1 Parameter Description
    • 2.31.2 Parameter Example
    • 2.31.3 Return Result Description
    • 2.31.4 Return Result Example
  • 2.32 Batch Query Membership Coupon Information
    • 2.32.1 Parameter Description
    • 2.32.2 Parameter Example
    • 2.32.3 Return Result Description
    • 2.32.4 Return Result Example
  • 2.33 Member Coupon Basic Information Batch Modification
    • 2.33.1 Parameter Description
    • 2.33.2 Parameter Example
    • 2.33.3 Return Result Description
    • 2.33.4 Return Result Example
  • 2.34 Bulk Publish Coupon
    • 2.34.1 Parameter Description
    • 2.34.2 Parameter Example
    • 2.34.3 Return Result Description
    • 2.34.4 Return Result Example
  • 2.35 Bind/unbind Member Devices
    • 2.35.1 Parameter Description
    • 2.35.2 Parameter Example
    • 2.35.3 Return Result Description
    • 2.35.4 Return Result Example
  • 2.36 Query Member Binding Devices
    • 2.36.1 Parameter Description
    • 2.36.2 Parameter Example
    • 2.36.3 Return Result Description
    • 2.36.4 Return Result Example
  • 2.37 Query Device Order Information
    • 2.37.1 Parameter Description
    • 2.37.2 Parameter Example
    • 2.37.3 Return Result Description
    • 2.37.4 Return Result Example
  • 2.38 Issue Electronic Invoice
    • 2.38.1 Parameter Description
    • 2.38.2 Parameter Example
    • 2.38.3 Return Result Description
    • 2.38.4 Return Result Example
  • 2.39 Store Inventory Query Interface
    • 2.39.1 Parameter Description
    • 2.39.2 Parameter Example
    • 2.39.3 Return Result Description
    • 2.39.4 Return Result Example
  • 2.40 Store Inventory Increase And Decrease Interface
    • 2.40.1 Parameter Description
    • 2.40.2 Parameter Example
    • 2.40.3 Return Result Description
    • 2.40.4 Return Result Example
  • 2.41 Store Online Forward Order Access (place An Order))
    • 2.41.1 Parameter Description
    • 2.41.2 Parameter Example
    • 2.41.3 Return Result Description
    • 2.41.4 Return Result Example
  • 2.42 Store Online Reverse Order Access (return))
    • 2.42.1 Parameter Description
    • 2.42.2 Parameter Example
    • 2.42.3 Return Result Description
    • 2.42.4 Return Result Example
  • 2.43 Obtain Basic Questionnaire Information
    • 2.43.1 Parameter Description
    • 2.43.2 Parameter Example
    • 2.43.3 Return Result Description
    • 2.43.4 Return Result Example
  • 2.44 Upload The Questionnaire Result Information
    • 2.44.1 Parameter Description
    • 2.44.2 Parameter Example
    • 2.44.3 Return Result Description
    • 2.44.4 Return Result Example
  • 2.45 Obtain The Questionnaire Results
    • 2.45.1 Parameter Description
    • 2.45.2 Parameter Example
    • 2.45.3 Return Result Description
    • 2.45.4 Return Result Example
  • 2.46 Upload The Skin Test Report
    • 2.46.1 Parameter Description
    • 2.46.2 Parameter Example
    • 2.46.3 Return Result Description
    • 2.46.4 Return Result Example
  • 2.47 Query The Skin Test Report
    • 2.47.1 Parameter Description
    • 2.47.2 Parameter Example
    • 2.47.3 Return Result Description
    • 2.47.4 Return Result Example
  • 2.48 Updated Skin Test Report Picture
    • 2.48.1 Parameter Description
    • 2.48.2 Parameter Example
    • 2.48.3 Return Result Description
    • 2.48.4 Return Result Example

Interface Description

2.1 Member Authentication

Interface Address: /member/verify
Interface Description: 根据手机号/邮箱/WechatOpenId/WechatUnionId/会员卡号/天猫昵称/EC帐号验证是否CRM会员
Interface Name: EC_MemberVerify
Request mode: HTTP POST submission

2.1.1 Parameter Description

2.1.2 Parameter Example

{
    "OwnerId": "78",
    "UserId": "136XXXX1111",
    "UserIdType": "0",
    "MemberPassword": "xxxxxx"
}

2.1.3 Return Result Description

2.1.4 Return Result Example

{
  "ErrorCode": "",
  "Message": "",
  "MemberNo": "M7800000128"
}

2.2 Apply For Membership

Interface Address: /member/register
Interface Description: 提交必要的信息注册会员。建议在开发阶段，注册会员成功后，再调用“Query Member Information接口”获取并验证注册的信息。
Interface Name: EC_MemberRegist
Request mode: HTTP POST submission

2.2.1 Parameter Description

2.2.2 Parameter Example

{
    "OwnerId": "78",
    "StoreId": "80100006",
    "Name": "张三",
    "Sex": "1",
    "BirthDay": "19870625",
    "Mobile": "19827382762",
    "Telephone": "19827382762",
    "MaritalStatus": "03",
    "ChildrenNumber": 2,
    "Address": "黄河路1号",
    "Zip": "200001",
    "Email": "aaa@bbb.com",
    "RegisteType": "80",
    "IsGetInfoByEmail": "1",
    "Memo": "备注信息XXXXXXXXXXXX",
    "Password": "123456",
    "RegisteCampaingTag": "H5"
}

2.2.3 Return Result Description

2.2.4 Return Result Example

{
  "ErrorCode": "",
  "Message": "",
  "MemberNo": "M7800000128"
}

2.3 Membership Binding

Interface Address: /member/bind
Interface Description: 通过手机号或会员编号与公众号微信openid或UnionId进行绑定
Interface Name: EC_MemberBind
Request mode: HTTP POST submission

2.3.1 Parameter Description

2.3.2 Parameter Example

{
    "OwnerId": "78",
    "BirthDay": "19870625",
    "Mobile": "19827382762",
    "Email": "aaa@bbb.com",
    "Password": "XXXX"
}

2.3.3 Return Result Description

2.3.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "MemberNo": "M7800000128"
}

2.4 Modify member information

Interface Address: /member/update
Interface Description: Modify member information
Interface Name: EC_MemberEdit
Request mode: HTTP POST submission

2.4.1 Parameter Description

2.4.2 Parameter Example

{
    "OwnerId": "78",
    "StoreId": "80100006",
    "MemberNo": "M7800000128",
    "Name": "张三",
    "Sex": "1",
    "BirthDay": "19870625",
    "Mobile": "19827382762",
    "Telephone": "19827382762",
    "MaritalStatus": "03",
    "ChildrenNumber": "2",
    "Address": "黄河路1号",
    "Zip": "200001",
    "Email": "aaa@bbb.com",
    "IsGetInfoByEmail": "1",
    "Memo": "备注信息XXXXXXXXXXXX",
    "Password": "xxxx"
}

2.4.3 Return Result Description

2.4.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "MemberNo": "M7800000128"
}

2.5 Query Member Information

Interface Address: /member/query
Interface Description: 通过会员号/手机号/邮箱/WechatOpenId/WechatUnionId/会员卡号/天猫昵称/EC 帐号Query Member Information
Interface Name: EC_MemberInfoQuery
Request mode: HTTP POST submission

2.5.1 Parameter Description

2.5.2 Parameter Example

{
    "OwnerId": "10",
    "StoreId": "",
    "MemberNo": "YZ008028",
    "IsReturnPoint": "1",
    "IsReturnTags": "1"
}

2.5.3 Return Result Description

2.5.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "MemberInfo": {
        "OwnerId": "10",
        "StoreId": "00300023",
        "MemberNo": "YZ008028",
        "MemberName": "杨利芬",
        "Gender": "2",
        "Birthday": "19901201",
        "Mobile": "13599999999",
        "Telephone": "",
        "MaritalStatus": "03",
        "ChildrenNumber": "2",
        "Address": "",
        "Zip": "",
        "Email": "",
        "IsGetInfoByEmail": "0",
        "Memo": "",
        "Status": "10",
        "MemberType": "4",
        "RegisteType": "20",
        "Province": "001",
        "City": "001",
        "Point": "17200",
        "TmallNick": "",
        "RegisteDateTime": "2014-12-28T00:00:00",
        "FirstSaleDateTime": "2014-12-28T00:00:00"
    },
    "Tags": [{
        "TagId": "xxxxxx",
        "TagName": "xxxxxx"
    }, {
        "TagId": "xxxxxx",
        "TagName": "xxxxxx"
    }]
}

2.6 Cancellation Of Membership

Interface Address: /member/cancelation
Interface Description: 会员注销接口，只有CRM系统开启了注销功能才能成功调用。注销后，会员信息全部更改为“已注销”，手机号等信息全部更改为注销专用的无意义的数字
Interface Name: CancelMember
Request mode: HTTP POST submission

2.6.1 Parameter Description

2.6.2 Parameter Example

{
    "OwnerId": "10",
    "MemberNo": "M1000978773",
    "CancelType": "40",
    "CancelMemo": "Test"
}

2.6.3 Return Result Description

2.6.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.7 Query Member Points

Interface Address: /point/query
Interface Description: 根据会员号/手机号/邮箱/WechatOpenId/WechatUnionId/会员卡号/天猫昵称/EC 帐号查询会员当前可用积分和会员状态
Interface Name: EC_MemberPointQuery
Request mode: HTTP POST submission

2.7.1 Parameter Description

2.7.2 Parameter Example

{
    "OwnerId": "78",
    "MemberNo": "M7800000128"
}

2.7.3 Return Result Description

2.7.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "CurrentPointInfo": {
        "OwnerId": "78",
        "MemberNo": "M7800000128",
        "Point": "120",
        "Status": "10"
    }
}

2.8 Inquire The Member's Point Record Of The Current Period

Interface URL: /point/history
Interface Description: 获取会员在当前积分期间的积分履历
Interface Name: EC_MemberPointHistoryQuery
Request mode: HTTP POST submission

2.8.1 Parameter Description

2.8.2 Parameter Example

{
    "OwnerId": "16",
    "StoreId": "32300000",
    "MemberNo": "M1600000XX"
}

2.8.3 Return Result Description

• Result

• 会员积分账期信息: PointHisHead

• 积分变动明细: GoodsDetail

2.8.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "PointHisHead": {
        "OwnerId": "16",
        "MemberNo": "XXX",
        "Status": "10",
        "BeginDate": "20140101",
        "EndDate": "20141231"
    },
    "GoodsDetailArray": [{
        "SaleDateTime": "20150102142356",
        "StoreId": "00300091",
        "StoreName": "东方商厦有限公司(GL)",
        "GoodsCode": "11114",
        "GoodsName": "资生堂新漾美肌 精华润肤乳",
        "SaleQty": "",
        "AfterSalesAmount": "",
        "AddPoint": "300",
        "PointIsActive": "",
        "AdjustReason": "",
        "AdjustReasonDesc": "",
        "ScoreActivityId": "",
        "ActivityName": ""
    }, ""]
}

2.9 Adjust Member Points

Interface Address: /point/update
Interface Description: 对会员积分进行调整
Interface Name: EC_ScoreAdjust
Request mode: HTTP POST submission

2.9.1 Parameter Description

2.9.2 Parameter Example

{
    "OwnerId": "10",
    "PeriodType": "1",
    "AdjustPoint": 4,
    "AdjustReason": "Test"
}

2.9.3 Return Result Description

2.9.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "MemberNo": "M7800000128",
    "Point": ""
}

2.10 Credit deducted after the gift is redeemed

Interface Address: /point/add
Interface Description: 在 EC 商城进行礼品兑换后直接调用本接口进行积分扣除。注意：本接口不是简单的积分调整扣减接口，是EC进行礼品兑换后将礼品信息和扣除的积分传递给CRM进行存储并扣减积分。兑换礼品的活动编号必须先在CRM创建。使用积分和 获取积分的交易明细不能混在同一个订单编号即小票号中。除非有特殊需求，否则不建议使用本接口，建议使用“礼品兑换接口”。
Interface Name: EC_MemberPointAdd
Request mode: HTTP POST submission

2.10.1 Parameter Description

2.10.2 Parameter Example

{
    "OwnerId": "78",
    "StoreId": "21700001",
    "MemberNo": "M7800000128",
    "PosId": 1,
    "BillNo": 1123456789,
    "AddPointSum": -200,
    "SaleDateTime": "20140909144323",
    "SalesDetailArray": [{
        "LineNo": 1,
        "GoodsCode": "88888888",
        "SaleQty": 1,
        "AddPoint": -200,
        "ScoreActivityId": ""
    }]
}

2.10.3 Return Result Description

2.10.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "MemberNo": "M7800000128"
}

2.11 Inquire Member Consumption History

Interface Address: /sales/history
Interface Description: 获取会员消费履历，仅包含购买或退货
Interface Name: EC_GetMemberSalesHis
Request mode: HTTP POST submission

2.11.1 Parameter Description

2.11.2 Parameter Example

{
    "OwnerId": "10",
    "MemberNo": "10",
    "DateFrom": "2020-01-01",
    "DateTo": "2022-01-01"
}

2.11.3 Return Result Description

• Result

• 消费记录： SalesArray

2.11.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "SalesArray": [{
        "MemberNo": "",
        "SaleDateTime": "",
        "GoodsName": "",
        "SalesAmount": "",
        "SaleQty": "",
        "BillNo": "",
        "StoreId": "",
        "StoreName": "",
        "AddPoint": "",
        "SalesType": "",
        "SalesTypeName": "",
        "PointIsActive": ""
    }]
}

2.12 Query Membership Level Information

Interface Address: /rank/query
Interface Description: 获取会员等级信息(返回 10 天之内发生过的会员升降级信息的所有会员升降级履 历)
Interface Name: EC_MemberRankChgQuery
Request mode: HTTP POST submission

2.12.1 Parameter Description

2.12.2 Parameter Example

{
  "OwnerId": "78"
}

2.12.3 Return Result Description

• Result

• 会员等级集合：MemberRankArry

2.12.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "OwnerId": "78",
    "MemberRankArry": [{
        "MemberNo": "M7800000128",
        "MemberType": "02",
        "PrevMemberType": "02",
        "BeginDateTime": "20141201000000",
        "EndDateTime": ">20151130000000",
        "Status": "1"
    }]
}

2.13 Tmall Member Binding/Unbinding

Interface Address: /tmall/bind
Interface Description: 通过手机号或会员编号与淘宝昵称进行绑定或解绑
Interface Name: TM_MemberBind
Request mode: HTTP POST submission

2.13.1 Parameter Description

2.13.2 Parameter Example

{
    "seller_name": "anessa 安热沙官方旗舰店",
    "mobile": "1730xxxx397",
    "type": "1",
    "member_nick": "quexxxxqin"
}

2.13.3 Return Result Description

2.13.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "MemberNo": "M7800000128"
}

2.14 Receive Orders From Tmall

Interface Address: /tmall/order
Interface Description: Receive Orders From Tmall数据
Interface Name: PUSH_ORDERS
Request mode: HTTP POST submission

2.14.3 Return Result Description

2.14.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.15 Check the mileage information purchased by members (NARS)

Interface Address: /mileage/info
Interface Description: 查询会员购买里程账户信息，仅限查询本期帐户信息。本接口仅限 NARS 品牌使用
Interface Name: EC_GetMemberMileageAccount
Request mode: HTTP POST submission

2.15.1 Parameter Description

2.15.2 Parameter Example

{
    "OwnerId": "10",
    "MemberNo": "YZ008028"
}

2.15.3 Return Result Description

2.15.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "MemberMileageAccountData": [{
        "OwnerId": "10",
        "MemberNo": "YZ008028",
        "ExchangeRuleClassID": "C1",
        "TotalSaleQty": "6",
        "TotalRefundQty": "0",
        "TotalExchangedDeductQty": "5",
        "TotalExpiredQty": "0",
        "TotalValidQty": "1"
    }, {
        "OwnerId": "10",
        "MemberNo": "YZ008028",
        "ExchangeRuleClassID": "C2",
        "TotalSaleQty": "5",
        "TotalRefundQty": "0",
        "TotalExchangedDeductQty": "4",
        "TotalExpiredQty": "0",
        "TotalValidQty": "1"
    }, {
        "OwnerId": "10",
        "MemberNo": "YZ008028",
        "ExchangeRuleClassID": "C3",
        "TotalSaleQty": "1",
        "TotalRefundQty": "0",
        "TotalExchangedDeductQty": "0",
        "TotalExpiredQty": "0",
        "TotalValidQty": "1"
    }]
}

2.16 Enquire about members' Redeemable Status (NARS)

Interface Address: /mileage/query
Interface Description: 根据已选择的预约礼品及数量，返回剩余和兑换规则可预约的礼品数量。如果仅仅是查询会员当前各兑礼规则最新的可兑礼情况，请不要传递参数 “PresentReserveApplyDetail”节点信息。
Interface Name: EC_GetMemberCanExchangeAccount
Request mode: HTTP POST submission

2.16.1 Parameter Description

• 头部信息: PresentReserveApply

• 模拟礼品预约申请集合：PresentReserveApplyDetail

2.16.2 Parameter Example

{
    "PresentReserveApply": {
        "OwnerId": "10",
        "MemberNo": "YZ008029",
        "ActivityId": "100841-0010"
    },
    "PresentReserveApplyDetail": [{
        "PresentId": "10055",
        "ReserveNum": 1,
        "ExchangeRuleTypeId": "10"
    }, {
        "PresentId": "10055",
        "ReserveNum": 1,
        "ExchangeRuleTypeId": "10"
    }]
}

2.16.3 Return Result Description

• 可兑换礼品账户集合：MemberCanExchangeResultList

2.16.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "MemberCanExchangeResultList": [{
        "ExchangeRuleTypeId": "10",
        "CanExchangeQty": "0"
    }, {
        "ExchangeRuleTypeId": "20",
        "CanExchangeQty": "0"
    }, {
        "ExchangeRuleTypeId": "30",
        "CanExchangeQty": "0"
    }, {
        "ExchangeRuleTypeId": "60",
        "CanExchangeQty": "1"
    }]
}

2.16.4 Definition Of Ritual Rules

10：脸部同品类满3件
20：眼部同品类满3件
30：唇部同品类满3件
40：面颊同品类满3件
50：指甲同品类满3件
60：跨品类满3件
70：全品类各满1件

2.17 Acknowledge event gift reservation (NARS)

Interface Address: /mileage/reserve
Interface Description: 答谢活动礼品预约申请处理
Interface Name: EC_NewPresentReserveApply
Request mode: HTTP POST submission

2.17.1 Parameter Description

• 礼品预约申请集合：PresentReserveApplyDetail

2.17.2 Parameter Example

{
    "PresentReserveApply": {
        "OwnerId": "10",
        "MemberNo": "M1000854113",
        "ActivityId": "100841-0002"
    },
    "PresentReserveApplyDetail": [{
        "PresentId": "10000C",
        "Qty": 2,
        "ExchangeRuleTypeId": "30"
    }, {
        "PresentId": "10000D",
        "Qty": 2,
        "ExchangeRuleTypeId": "40"
    }]
}

2.17.3 Return Result Description

2.17.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "ReserveApplyList": [{
        "ReserveId": "",
        "PresentId": "",
        "PresentName": "",
        "Qty": "",
        "ExchangeRuleTypeId": "",
        "ExchangeBeginDate": "",
        "ExchangeEndDate": ""
    }, {
        "ReserveId": "",
        "PresentId": "",
        "PresentName": "",
        "Qty": "",
        "ExchangeRuleTypeId": "",
        "ExchangeBeginDate": "",
        "ExchangeEndDate": ""
    }]
}

2.18 Acknowledge event gift redemption (NARS)

Interface Address: /mileage/exchnange
Interface Description: 答谢活动礼品预约成功后到店兑换领取时，调用本接口进行兑换领取处理
Interface Name: EC_NewPresentExchange
Request mode: HTTP POST submission

2.18.1 Parameter Description

2.18.2 Parameter Example

{
    "OwnerId": "10",
    "PresentExchangeItems": [{
        "ReserveId": "8702001076263"
    }, {
        "ReserveId": "8702001076264"
    }]
}

2.18.3 Return Result Description

2.18.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.19 Update Member Privacy Policy Confirmation Status

Interface Address: /policy/update
Interface Description: 如果会员未确认过隐私政策，调用本接口更新为已确认，如果同时上传隐私政策确认签名文件则会将隐私政策确认状态更新为已上传确认签名文件
Interface Name: UpdatePolicyStatus
Request mode: HTTP POST submission

2.19.1 Parameter Description

2.19.2 Parameter Example

{
    "OwnerId": "10",
    "MemberNo": "XXX",
    "FileExtension": "JPG",
    "FileContent": "XXXXXXX",
    "IsConsented": 1
}

2.19.3 Return Result Description

2.19.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
  "MemberNo": ""
}

2.20 Third-party platform ID binding(Such as SFCCID)

Interface Address: /platform/bind
Interface Description: 将第三方平台的用户 ID 与会员编号进行绑定
Interface Name: OtherPlatfrom_MemberBind
Request mode: HTTP POST submission

2.20.1 Parameter Description

2.20.2 Parameter Example

{
    "OwnerId": "10",
    "MemberNo": "XXXXXXXX000001",
    "OtherPlatfromType": "SFCC",
    "OtherPlatfromId": "XXXXXXXXXXXXXXXXX001"
}

2.20.3 Return Result Description

2.20.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.21 Update Member's Store And BC Information

Interface Address: /bcandstore/update
Interface Description: 通过调用本接口来更新会员所属店铺和所属 BC 信息
Interface Name: UpdateMemberBCAndStore
Request mode: HTTP POST submission

2.21.1 Parameter Description

2.21.2 Parameter Example

{
    "OwnerId": "10",
    "MemberNo": "M1000450701",
    "StoreId": "32310000",
    "ServiceEmployeeNo": "00007674"
}

2.21.3 Return Result Description

2.21.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.22 Update Member Label

Interface Address: /tag/update
Interface Description: 通过调用本接口来Update Member Label
Interface Name: EditMemberTag
Request mode: HTTP POST submission

2.22.1 Parameter Description

2.22.2 Parameter Example

{
    "OwnerId": "10",
    "TagId": "50001",
    "Action": "Add",
    "MemberList": ["0011000300008", "M1000450701"]
}

2.22.3 Return Result Description

2.22.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.23 Inquire About Member Gifts And Vouchers

Interface Address: /gifts/detail
Interface Description: Inquire About Member Gifts And Vouchers信息
Interface Name: EC_GetMemberGifts
接口方式: HTTP POST submission

2.23.1 Parameter Description

2.23.2 Parameter Example

{
    "OwnerId": "100010",
    "MemberNo": "",
    "PAType": "",
    "BeginTime": "2020-01-01",
    "EndTime": "2022-01-01",
    "PAStatus": ""
}

2.23.3 Return Result Description

• 礼品兑换信息集合：HistoryApplyArray

2.23.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "HistoryApplyArray": [{
        "ApplyDate": "",
        "GoodsCode": "",
        "OwnerID": "",
        "ApplyId": "",
        "MemberNo": "",
        "PAID": "",
        "PAType": "",
        "Qty": "",
        "ExchangeScore": "",
        "TicketSerialNo": "",
        "GoodsStatus": "",
        "TicketStatus": "",
        "TicketType": "",
        "GOODSNAME": "",
        "GOODSNAME_EN": "",
        "TicketBegYmd": "",
        "TicketEndYmd": "",
        "ExchangeStatus": "",
        "ExchangeDate": "",
        "ExchangeStoreId": "",
        "ExchangeStoreName": "",
        "ExchangeBeginDate": "",
        "ExchangeEndDate": "",
        "SaleDateTime": "",
        "IsExpress": "",
        "ExpressNo": "",
        "ExpressStatusCode": ""
    }]
}

2.24 Query The Promotion Number

Interface Address: /activity/query
Interface Description: 获取促销活动编号列表(第二天开始的所有活动)
Interface Name: EC_ScoreActivityQuery
接口方式: HTTP POST submission

2.24.1 Parameter Description

2.24.2 Parameter Example

{
  "OwnerId": ""
}

2.24.3 Return Result Description

• 活动明细: ActivityArray

• 活动明细: ScoreValueArray

2.24.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "OwnerId": "",
    "ActivityCount": "2",
    "ActivityArray": [{
        "ActivityId": "100452-015",
        "ActivityName": "双11活动",
        "ActivityDistinction": "10",
        "BeginDateTime": "20141111",
        "EndDateTime": "20141111",
        "Status": "30",
        "ScoreValueArray": [{
            "MemberType": "1",
            "ScoreValue": "1.5"
        }, {
            "MemberType": "2",
            "ScoreValue": "2.0"
        }]
    }]
}

2.25 Add Active Objects In Batches

Interface Address: /activity/batchadd
Interface Description: 通过调用本接口可以对指定的活动对象批量添加活动成员
Interface Name: AddMemberToActivity
接口方式: HTTP POST submission

2.25.1 Parameter Description

• 活动明细: MemberMstArray

2.25.2 Parameter Example

{
    "OwnerId": "10",
    "DMRecordId": "38",
    "MemberMstArray": [{
        "MemberNo": "M1000450701"
    }, {
        "MemberNo": "M1000450702"
    }]
}

2.25.3 Return Result Description

2.25.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.26 Cancel Member Gift Application Or Point Exchange Reservation

Interface Address: /present/reserve
Interface Description: 核销会员的领取试用申请或积分兑换预约申请记录。核销后，领取试用申请状态为已领取，积分兑换预约状态为已兑换
Interface Name: PresentAndSampleTake
接口方式: HTTP POST submission

2.26.1 Parameter Description

2.26.2 Parameter Example

{
    "OwnerId": "78",
    "MemberNo": "XXX",
    "ApplyId": "XXXXXXXXXXXXXXXXXX",
    "PAType": "10"
}

2.26.3 Return Result Description

2.26.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.27 Make An Appointment For The Event Gift

Interface Address: /present/exchange
Interface Description: 答谢活动做礼品预约申请
Interface Name: EC_PresentExchange
接口方式: HTTP POST submission

2.27.1 Parameter Description

2.27.2 Parameter Example

{
    "ActiveNo": "",
    "MemberNo": "",
    "GoodsArray": [{
        "GoodCode": "A001",
        "Qty": 1
    }, {
        "GoodCode": "A002",
        "Qty": 1
    }],
    "OwnerId": "",
    "Store": "",
    "OrderConsignee": {
        "Name": "",
        "Mobile": "",
        "Telephone": "",
        "Area_State": "",
        "Area_City": "",
        "Area_District": "",
        "Addr": ""
    }
}

2.27.3 Return Result Description

2.27.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "MemberNo": "",
    "Score": "",
    "ReserveId": "",
    "ReserveDetails": [{
        "ReserveId": "",
        "GoodsCode": "",
        "Qty": ""
    }, {
        "ReserveId": "",
        "GoodsCode": "",
        "Qty": ""
    }],
    "Tickets": [{
        "GoodCode": "",
        "Ecode": ""
    }, {
        "GoodCode": "",
        "Ecode": ""
    }]
}

2.28 Apply For A Trial Gift

Interface Address: /sample/apply
Interface Description: 会员进行领取试用活动的礼品进行申请
Interface Name: EC_SampleApply
接口方式: HTTP POST submission

2.28.1 Parameter Description

• 商品信息集合：GoodsArray

2.28.2 Parameter Example

{
    "OwnerId": "",
    "Store": "",
    "ApplyStore": "",
    "ActiveNo": "",
    "MemberNo": "",
    "GoodsArray": [{
        "GoodCode": "",
        "Qty": 0
    }, {
        "GoodCode": "",
        "Qty": 0
    }]
}

2.28.3 Return Result Description

2.28.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "MemberNo": "",
    "ApplyId": ""
}

2.29 Cancel The Trial Application

Interface Address: /sample/cancel
Interface Description: 通过本接口对指定的领取试用申请进行取消，取消后会员可以再重新进行申请
Interface Name: CancelSampleApply
接口方式: HTTP POST submission

2.29.1 Parameter Description

2.29.2 Parameter Example

{
    "OwnerId": "10",
    "ApplyId": "9106009076212"
}

2.29.3 Return Result Description

2.29.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.30 Member Service Voucher In Advance

Interface Address: /coupon/reserve
Interface Description: Member Service Voucher In Advance约申请，可以支持在已预约的基础上再做预约更新
Interface Name: MemberTicketReserve
接口方式: HTTP POST

2.30.1 Parameter Description

2.30.2 Parameter Example

{
    "OwnerId": "78",
    "StoreId": "32300000",
    "MemberNo": "XXXX",
    "CouponSerialNo": "1000000000000001",
    "ReserveType": 1,
    "ApplyStoreId": "32300000",
    "ApplyDateTime": "2017-12-31T10:00:00",
    "ApplyMemo": ""
}

2.30.3 Return Result Description

2.30.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.31 Verification The Member's Coupon Code

Interface Address: /coupon/consume
Interface Description: 核销会员券
Interface Name: EC_CouponConsume
接口方式: HTTP POST submission

2.31.1 Parameter Description

2.31.2 Parameter Example

{
    "OwnerId": "78",
    "StoreId": "32300000",
    "MemberNo": "XXX",
    "CouponSerialNo": "1000000000000001",
    "ConsumptionType": "70",
    "SaleStoreId": "32300000",
    "SalePosId": 1,
    "SaleBillNo": 255
}

2.31.3 Return Result Description

2.31.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.32 Batch Query Membership Coupon Information

Interface Address: /coupon/query
Interface Description: 分页Batch Query Membership Coupon Information。本接口于 2020-01-01 0:00 正式发布。每页返回500行，如果返回结果中HasNextPage=false，则说明当前页就是最后一页
Interface Name: EC_GetMemberTickets
接口方式: HTTP POST submission

2.32.1 Parameter Description

2.32.2 Parameter Example

{
  "OwnerId": "",
  "MemberNo": "",
  "IssueActivityId": "",
  "IssueDateBegin": "2020-01-01",
  "IssueDateEnd": "2022-01-01",
  "Status": "10,15"
}

2.32.3 Return Result Description

• 券信息集合：Tickets

2.32.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "Tickets": [{
        "OwnerID": "",
        "TicketSerialNo": "",
        "TicketName": "",
        "TicketId": "",
        "ReserveId": "",
        "MemberNo": "",
        "MemberName": "",
        "Mobile": "",
        "Status": "",
        "UseBeginDate": "",
        "UseEndDate": "",
        "IssueStoreId": "",
        "IssueDate": "",
        "IssueActivityId": "",
        "IssueActivityName": "",
        "ApplyStoreId": "",
        "ApplyDateTime": "",
        "ApplyServiceEmployeeNo": "",
        "ApplyEndDateTime": "",
        "SaleStoreId": "",
        "SaleDateTime": "",
        "SaleEmployeeNo": "",
        "CancelDate": "",
        "LeftDays": ""
    }, {
        "OwnerID": "",
        "TicketSerialNo": "",
        "TicketName": "",
        "TicketId": "",
        "ReserveId": "",
        "MemberNo": "",
        "MemberName": "",
        "Mobile": "",
        "Status": "",
        "UseBeginDate": "",
        "UseEndDate": "",
        "IssueStoreId": "",
        "IssueDate": "",
        "IssueActivityId": "",
        "IssueActivityName": "",
        "ApplyStoreId": "",
        "ApplyDateTime": "",
        "ApplyServiceEmployeeNo": "",
        "ApplyEndDateTime": "",
        "SaleStoreId": "",
        "SaleDateTime": "",
        "SaleEmployeeNo": "",
        "CancelDate": "",
        "LeftDays": ""
    }]
}

2.33 Member Coupon Basic Information Batch Modification

Interface Address: /coupon/update
Interface Description: 根据传入的修改条件和修改内容，批量修改会员优惠券基本信息
Interface Name: EC_BatchUpdateMemberTicketDetailInfor
接口方式: HTTP POST submission

2.33.1 Parameter Description

2.33.2 Parameter Example

{
    "OwnerId": "10",
    "TicketSerialNo": "000020748380",
    "TicketId": "00100003",
    "IssueStoreId": "00300023",
    "StatusCondition": "70",
    "UseEndDate": "2020-12-15",
    "ApplyDateTime": "2020-02-15T00:00:00",
    "ApplyEndDateTime": "2020-02-15T00:00:00",
    "Status": "10"
}

2.33.3 Return Result Description

2.33.4 Return Result Example

{
    "ErrorCode": "",
    "Message": ""
}

2.34 Bulk Publish Coupon

Interface Address: /coupon/batchissue
Interface Description: 针对所有类型券，直接给指定的一批会员发行券码
Interface Name: EC_BatchIssueTicket
接口方式: HTTP POST submission

2.34.1 Parameter Description

• 会员集合：MemberArray

2.34.2 Parameter Example

{
    "OwnerId": "10",
    "TicketId": "",
    "RequestId": "10",
    "MemberArray": [{
        "MemberNo": "",
        "StoreId": "",
        "Qty": 1
    }, {
        "MemberNo": "",
        "StoreId": "",
        "Qty": 1
    }]
}

2.34.3 Return Result Description

• 券集合：MemberTicksArray

2.34.4 Return Result Example

{
    "ErrorCode": "",
    "Message": "",
    "MemberTicksArray": [{
        "MemberNo": "",
        "TicketSerialNo": ""
    }, {
        "MemberNo": "",
        "TicketSerialNo": ""
    }]
}

2.35 Bind/unbind Member Devices

Interface Address: /device/relation
Interface Description: 通过调用接口，Bind/unbind Member Devices。 EFFECTIM 专用
Interface Name: MemberDeviceRelation
接口方式: HTTP POST submission

2.35.1 Parameter Description

2.35.2 Parameter Example

{
  "OwnerId": "",
  "MemberNo": "",
  "DeviceSerialNo": "1001",
  "OperationType": 0
}

2.35.3 Return Result Description

2.35.4 Return Result Example

{
  "ErrorCode": "",
  "Message": "",
  "BindMemberNo": ""
}

2.36 Query Member Binding Devices

Interface Address: /device/detail
Interface Description: 通过调用接口，Query Member Binding Devices。 EFFECTIM 专用
Interface Name: GetMemberDeviceRelation
接口方式: HTTP POST submission

2.36.1 Parameter Description

2.36.2 Parameter Example

{
  "OwnerId": "",
  "MemberNo": "",
  "DeviceSerialNo": "1001",
  "GoodsCode": "001001"
}

2.36.3 Return Result Description

• 数据信息：Data

2.36.4 Return Result Example

{
  "ErrorCode": "",
  "Message": "",
  "Data": [
    {
      "DeviceSerialNo": "1001",
      "GoodsCode": "001001",
      "GoodsName": "商品 1",
      "Status": "10",
      "UpdateDate": "2020/12/22 10:11:20"
    },
    {
      "DeviceSerialNo": "1002",
      "GoodsCode": "001001",
      "GoodsName": "商品 2",
      "Status": "20",
      "UpdateDate": "2020/12/22 10:01:10"
    }
  ]
}

2.37 Query Device Order Information

Interface Address: /device/orderinfo
Interface Description: 通过调用接口，Query Device Order Information。EFFECTIM 专用
Interface Name: GetDeviceOrderInfo
接口方式: HTTP POST submission

2.37.1 Parameter Description

2.37.2 Parameter Example

{
  "OwnerId": "",
  "MemberNo": "",
  "SaleDate": "",
  "PayDate": "",
  "BeginDate": "2020/01/01",
  "EndDate": "2022/01/01",
  "StoreId": "",
  "PosId": 1,
  "BillNo": 1335,
  "OrderNo": "1344",
  "DeviceSerialNo": "",
  "GoodsCode": "001001"
}

2.37.3 Return Result Description

• 数据信息：Data