Loyalty Point

DealPOS API (3.1.0)

Welcome Developer

This page lists the reference documentation for DealPOS APIs. For guides and tutorials.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL https://www.dealpos.com
Customer Support info@dealpos.com
License
Languages
Servers
Production Server
https://{subdomain}/api/v3/

Token

Operations related to authentication tokens

Operations

Category

Operations related to category, including create, get, etc

Operations

Product

Operations related to product, including create, get, etc

Operations

Variant

Operations related to variant, including create, get, etc

Operations

Serial

Operation related to Serial product type

Operations

Estimate

Operations related to estimate, including create, get, etc

Operations

Sales Order

Operations related to sales order, including create, get, etc

Operations

Invoice

Operations related to invoice, including create, get, etc

Operations

Shift

Operation related to shift, including create, get, etc

Operations

Report

Operations related to report page, including create, get, etc

Operations

Customer

Operations related to customer data, including create, get, etc

Operations

Comment

Operations related to comment (Contact Feedback), including create, get, etc

Operations

Supplier

Operations related to supplier data, including create, get, etc

Operations

Invoice Payment

Operations related to invoice payment, including create, get, etc

Operations

Bill Payment

Operations related to bill payment, including create, get, etc

Operations

Invoice Write Off

Operations related to invoice write off, including create, get, etc

Operations

Inventory

Operations related to inventory, including create, get, etc

Operations

Inventory Log

Operations related to inventory log, including create, get, etc

Operations

Inventory Adjustment

Operations related to inventory adjustment, including create, get, etc

Operations

Bill

Operations related to bill, including create, get, etc

Operations

OutboundLogistic

Operations related to outbound logistic, including create, get, etc

Operations

InboundLogistic

Operations related to inbound logistic, including create, get, etc

Operations

TransferOrder

Operations related to transfer order, including create, get, etc

Operations

Picklist

Operations related to picklist, including create, get, etc

Operations

Prepaid Package

Operations related to prepaid package, including create, get, etc

Operations

Promotion Coupon

Operations related to promotion coupon, including create, get, etc

Operations

Promotion Event

Operations related to promotion event, including create, get, etc

Operations

Outlet

Operations related to outlet, including create, get, etc

Operations

Outlet Price

Operations related to outlet price, including create, get, etc

Operations

Loyalty Point

Operations related to loyalty point, including create, get, etc

Operations

Get History by Email or Phone

Request

Also available as HTTP POST with the same endpoint


Get Loyalty Point History for a specific customer by Email, MobilePhone or Phone

Required Group Role: "Contacts" - "VIEW"

Bodyapplication/json
Fromstring

From Date

Tostring

To Date

PageNumbernumberrequired

The Page of data to be displayed

PageSizenumberrequired

The Number of rows returned by the API

Emailstring

Customer's email which will be used to pull the loyalty point history

MobilePhonestring

Customer's Mobile or Phone Number which will be used to pull the loyalty point history

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/LoyaltyPoint/EmailOrPhone \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2024-01-01",
    "To": "2024-12-31",
    "PageNumber": 1,
    "PageSize": 10,
    "Email": "customer@example.com",
    "MobilePhone": "1234567890"
  }'

Responses

Bodyapplication/jsonArray [
InvoiceIDstring

Invoice ID

Outletstring

Outlet Name

EntryDatestring

Date entry for transaction related to loyalty point (earned/redeemed)

Actionstring

The cause of change in loyalty point

Invoicestring

Invoice Number

Earnedinteger

Total Points earned/redeemed for the transaction

Balanceinteger

Total last points

Remaininginteger

Points will be / already expired

ExpiryDatestring

Point expired date

Notestring

Note for History Point

]
Response
application/json
[
  {
    "InvoiceID": "c7224cbd-0292-4060-88f8-2f53f328f904",
    "Outlet": "Offline Store",
    "EntryDate": "2024-05-08T14:46:00.01",
    "Action": "Points Earned",
    "Invoice": "24.05.00041",
    "Earned": 50,
    "Balance": 60,
    "Remaining": 50,
    "ExpiryDate": "2024-06-08T14:44:37",
    "Note": "Paid"
  },
  {
    "InvoiceID": "a6ca59c2-4dd8-48ef-8dd7-96ba6427c3f8",
    "Outlet": "Offline Store",
    "EntryDate": "2024-05-08T14:25:10.42",
    "Action": "Point Expired",
    "Invoice": "24.05.00039",
    "Earned": -990,
    "Balance": 10,
    "Remaining": 0,
    "ExpiryDate": "0001-01-01T00:00:00",
    "Note": "Expired on 08 May 2024"
  },
  {
    "InvoiceID": "40c52cfe-6941-421b-b8cd-5cb71b705281",
    "Outlet": "Offline Store",
    "EntryDate": "2024-05-08T14:18:21.377",
    "Action": "Points Earned",
    "Invoice": "24.05.00040",
    "Earned": 10,
    "Balance": 1000,
    "Remaining": 10,
    "ExpiryDate": "2024-06-08T14:17:47",
    "Note": "Paid"
  },
  {
    "InvoiceID": "6ccc6cc6-fc59-41bf-ae5a-8e2d81e1ff31",
    "Outlet": "Offline Store",
    "EntryDate": "2024-05-08T13:53:15.987",
    "Action": "Points Redeemed",
    "Invoice": "24.05.00037",
    "Earned": -10,
    "Balance": 990,
    "Remaining": 0,
    "ExpiryDate": "0001-01-01T00:00:00",
    "Note": "Points Redeemed"
  },
  {
    "InvoiceID": "7eb83722-99e4-4fb9-a2db-103673ad258e",
    "Outlet": "Offline Store",
    "EntryDate": "2024-05-08T13:40:30.74",
    "Action": "Points Earned",
    "Invoice": "24.05.00036",
    "Earned": 1000,
    "Balance": 1000,
    "Remaining": 0,
    "ExpiryDate": "0001-01-01T00:00:00",
    "Note": "Points Earned"
  }
]

Get Loyalty Point Expiration By Email

Request

Get Loyalty Point Expiration for a specific customer by Email

Required Group Role: "Contacts" - "VIEW"

Bodyapplication/json
Emailstring

Customer's email which will be used to pull the loyalty point expiration date

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/LoyaltyPoint/ExpirationByEmail \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Email": "ferdi@example.com"
  }'

Responses

Bodyapplication/jsonArray [
Pointsinteger

Total Points

ExpiryDatestring

Date of expiration point

]
Response
application/json
[
  {
    "Points": 69,
    "ExpiryDate": "2023-01-31"
  },
  {
    "Points": 70,
    "ExpiryDate": "2023-01-26"
  },
  {
    "Points": 40,
    "ExpiryDate": "2023-01-24"
  }
]

Get Loyalty Point Expiration By Mobile Phone

Request

Get Loyalty Point Expiration for a specific customer by Mobile Phone

Required Group Role: "Contacts" - "VIEW"

Bodyapplication/json
MobilePhonestring

Customer's Mobile or Phone Number which will be used to pull the loyalty point expiration date

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/LoyaltyPoint/ExpirationByMobile \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "MobilePhone": "08968484805"
  }'

Responses

Bodyapplication/jsonArray [
Pointsinteger

Total Points

ExpiryDatestring

Date of expiration point

]
Response
application/json
[
  {
    "Points": 69,
    "ExpiryDate": "2023-01-31"
  },
  {
    "Points": 70,
    "ExpiryDate": "2023-01-26"
  },
  {
    "Points": 40,
    "ExpiryDate": "2023-01-24"
  }
]

Add / Redeem Loyalty Point by Mobile

Request

Add / Redeem Loyalty Point Customer by Mobile

Bodyapplication/json
MobilePhonestringrequired

Customer mobile phone. This is primary key for the object

Example: "081251545454"
LoyaltyPointintegerrequired

The number of loyalty points you want to add / redeem

Example: 1000
Notestring

Note add loyalty point

Example: "Add loyalty point"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/LoyaltyPoint/Mobile \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "MobilePhone": "081251545454",
    "LoyaltyPoint": 1000,
    "Note": "Add loyalty point"
  }'

Responses

OK

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "Your loyalty point has been added by 100 points"
}

Get Loyalty Point

Request

Also available as HTTP POST (endpoint: /api/v3/LoyaltyPoint/p)


Get Loyalty Point History

Required Group Role: "Contacts" - "VIEW"