Overview
The OneRewards Integration API provide api for operation such as point redemption, get member info and etc. The following list out the command operations that you can do with OneRewards Integration API.
Get Member Real Time Information
| Operation | Description |
|---|---|
| Get Member | Get a specific member. |
| Get Member Info | Get a member information regarding the point balance and number of vouchers claimed. |
| Get Member Listing | Get a list of members with filters. |
| Get Member Level Listing | Get a list of member level with filters. |
Get Member Obtainable / Usable E-Vouchers
| Operation | Description |
|---|---|
| Get Obtainable Voucher | Retrieve vouchers that can be obtained by the member. |
| Get Usable Voucher | Retreive vouchers that can be used by the member. |
| Can Get Voucher Now | Retrieve the voucher information and the obtainability for the member. |
| Can Use Voucher Now | Retrieve the voucher information and the usability for the member. |
Create Sales Transaction
| Operation | Description |
|---|---|
| Post Transaction | Create sales transaction. |
| Unpost Transaction | Void sales transaction. |
Create Sales Transaction with Return
| Operation | Description |
|---|---|
| Post Transaction | Create sales transaction. In order to create sales transaction with return, the field type inside Sales Details Input Model need to be type R - (Return). |
| Unpost Transaction | Void sales transaction. |
Create Sales Transaction with Trade In
| Operation | Description |
|---|---|
| Post Transaction | Create sales transaction. In order to create sales transaction with trade in, the field type inside Sales Details Input Model need to be type T - (Trade-in). It also need to be followed by another Sales Details Input Model with type N - (Normal) to indicate the product bought. |
| Unpost Transaction | Void sales transaction. |
Create Sales Transaction with Point Redemption
| Operation | Description |
|---|---|
| Get Mobile User Membership Info by Auth Code | Get mobile app user membership info, including the redemptionCode necessary for processing member redemptions. If the member is linked to any mobile app user, redemptionCode is required for point redemption. Therefore, this api need to be called first to retrieve redemptionCode to be used for creating sales transaction with point redemption. |
| Post Transaction | Create sales transaction. In order to create sales transaction with point redemption, the field redemption and redemptionDescription inside Points Input Model need to have values. If the point is redeemed for payment, the field payments should have the record detailing another payment method with points and the amount paid. |
| Unpost Transaction | Void sales transaction. |
Create Sales Transaction with Voucher Redemption
| Operation | Description |
|---|---|
| Post Transaction | Create sales transaction. In order to create sales transaction with voucher redemption, the field voucherNo and discontAmount inside Voucher Input Model need to have values. It also need to have at least one Sales Details Input Model with type D - (Discount) to indicate the discount applied from voucher. |
| Unpost Transaction | Void sales transaction. |
Create / Update Member
| Operation | Description |
|---|---|
| Create Member | Create a member. |
| Update Member | Update a member. If member is linked to a mobile app user, restriction will be applied to some field to avoid conflicting data between member record and mobile app user record. |
Create Member from Mobile App User
| Operation | Description |
|---|---|
| Create Member from Mobile User | Create a new member from mobile app user. If existing member record that have not linked to any mobile app user has the same phone number, it will link to that record instead of creating a new one. |
| Get Mobile User | Get a specific mobile app user. |
| Get Mobile User Membership Info by Auth Code | Get mobile app user membership info, including the redemption code necessary for processing member redemptions. |
Migrate Member from other system
| Operation | Description |
|---|---|
| Migrate Member | Migrate member record from other system. The api can only migrate one member at a time. |
Upload receipt softcopy
| Operation | Description |
|---|---|
| Get Upload Receipt Url | Retrieved pre-signed urls to upload receipt softcopy to cloud storage. The api only return the urls that can be used to upload receipt indicating that the urls returned need to be call again with the file attached to upload the receipt. |
Issue Voucher To Member
| Operation | Description |
|---|---|
| Issue Voucher To Member | Issue voucher to the member. Voucher need to be claimed before using. |