Notification

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

Notification

Operations related to notification, including create, get, etc

Operations

List Notifications

Request

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


Get List of Notifications

Required Group Role: "My Profile" - "Notification" OR "Global" - "EDIT"

Bodyapplication/json
Outletstring
Fromstringrequired

From Date

Default "(yyyy/mm/dd)"
Tostringrequired

To date

Default "(yyyy/mm/dd)"
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Notification \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "From": "2022-03-17",
    "To": "2022-03-17"
  }'

Responses

Bodyapplication/jsonArray [
IDstring

Notification's ID

ObjectIDstring

Notification Object Unique ID

OutletNamestring
Headerstring

Title of notification message

Bodystring

Content of notification

URLstring

Content URL of notification

Typestring
Createdstring

Notification's created time

TypeIDstring
]
Response
application/json
[
  {
    "ID": "7f7b85db-da32-4fe8-8118-f071ba36f0a0",
    "ObjectID": "00000000-0000-0000-0000-000000000000",
    "OutletName": "Offline",
    "Header": "Customer has visited store 5 times",
    "Body": "male, 30 years old",
    "Created": "2022-03-17T08:10:10.15",
    "URL": "https://www.google.com/",
    "TypeID": "0",
    "Type": "None"
  },
  {
    "ID": "ce34ace3-2fec-4b87-8ae1-9338eed379a3",
    "ObjectID": "00000000-0000-0000-0000-000000000000",
    "OutletName": "Offline",
    "Header": "Customer has visited store 5 times",
    "Body": "male, 30 years old",
    "Created": "2022-03-17T08:09:51.367",
    "URL": "https://www.google.com/",
    "TypeID": "0",
    "Type": "None"
  }
]

Create a Notification

Request

Push Notification to Cashier Point of Sales

Create a Notification based on outlets

You must have "Notification" role in "My Profile" Module

Bodyapplication/json
Outletstringrequired

Name of the Outlet

Headerstringrequired

Title of notification message. this is primary key for the object

Bodystringrequired

Content of notification. this is primary key for the object

URLstring

Content URL of notification

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Notification \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Header": "Jane visits this store",
    "Body": "This customer likes to buy T-shirt",
    "URL": "https://www.mybrand.com/Products/1704"
  }'

Responses

Bodyapplication/json
object

Notification has been created

Response
application/json
{
  "Message": "Success"
}

Delete Notifications

Request

Delete a Notification

You must have "Notification" role in "My Profile" Module

Bodyapplication/json
Outletstring
Fromstringrequired

Date from of notification created which will be deleted. this is primary key for the object

Default "(yyyy/mm/dd)"
Tostringrequired

To date of notfication created which will be deleted. this is primary key for the object

Default "(yyyy/mm/dd)"
curl -i -X DELETE \
  https://subdomain.dealpos.net/api/v3/Notification \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "From": "2022-03-17",
    "To": "2022-03-17"
  }'

Responses

Bodyapplication/json
Messagestring

Notification has been deleted

Response
application/json
{
  "Message": "Push Notification has been deleted!"
}

List Notifications With Total Count

Request

Also available as HTTP POST with the same endpoint


Get List of Notifications With Total Count

Required Group Role: "My Profile" - "Notification" OR "Global" - "EDIT"

Bodyapplication/json
Outletstringrequired
Fromstringrequired

From date (format: yyyy-mm-dd)

Tostringrequired

To date (format: yyyy-mm-dd)

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Notification/WithTotalCount \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "From": "2020-02-28",
    "To": "2020-03-16"
  }'

Responses

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total count of the result

Response
application/json
{
  "Data": [
    { … },
    { … }
  ],
  "TotalCount": 2
}

Payment Method

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

Operations

Invoice Write Off Option

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

Operations

Tax

Operations related to tax, including create, get, etc

Operations

Logistics Service

Operations related to logistics service, including create, get, etc

Operations