Skip to content
/
List Promotion Event

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
Languages
Servers
Production Server
https://{subdomain}/

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

Fulfillment

Operations related to fulfillment, 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

List Promotion Event

Request

Get a list of promotion events. Requires the "VIEW" role in the "Promotion" group.

Security
OAuth2_clientCredentials
Query
PageNumberintegerrequired

The number of page data to be displayed

Example: PageNumber=1
PageSizeintegerrequired

The number of rows returned by the API

Example: PageSize=10
Typestring

Promotion Type (Amount / Quantity / Discount / Product / Tiered) If value is null , it will be show all type

Example: Type=Amount
Statusstring

Status of promotion event (Active / Expired). If value is null, it will show all status promotion

Example: Status=Active
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/PromotionEvent?PageNumber=1&PageSize=10&Type=Amount&Status=Active' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
Namestringrequired

Promotion Event Name

StartDatestringrequired

Start Time of Promotion Event

ExpirationDatestringrequired

Expiration Date of Promotion Event

OutletArray of stringsrequired

Outlet Name assigned of promotion event (Null means assigned to all outlet)

Typestringrequired

Promotion Event Type

MinimumQtyintegerrequired

Minimum Qty of promotion event be applied

]
Response
application/json
[
  {
    "Name": "New Year Sale",
    "StartDate": "2022-12-25 00:00:00",
    "ExpirationDate": "2022-01-01 23:59:59",
    "Outlet": [ … ],
    "Type": "Amount",
    "MinimumQty": 1
  }
]

Get Promotion Event by Variant ID

Request

Get promotion event details by variant ID. Requires the "VIEW" role in the "Promotion" group.

Security
OAuth2_clientCredentials
Query
VariantIDstringrequired

Variant ID

Example: VariantID=6f96d108-1af5-45de-a593-74719a0ee8e2
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/PromotionEvent/GetByVariantID?VariantID=6f96d108-1af5-45de-a593-74719a0ee8e2' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
Namestringnon-emptyrequired
UnitPricenumberrequired
ExtraCostnumberrequired
Discountnumberrequired
StartDatestringnon-emptyrequired
ExpirationDatestringnon-emptyrequired
StartTimestringnon-emptyrequired
ExpirationTimestringnon-emptyrequired
PromotionIDstringnon-emptyrequired
]
Response
application/json
[
  {
    "Name": "DealPOS Book Fair 2022",
    "UnitPrice": 100000,
    "ExtraCost": 0,
    "Discount": 0,
    "StartDate": "2022-04-13T00:00:00",
    "ExpirationDate": "2022-04-21T00:00:00",
    "StartTime": "00:00:00",
    "ExpirationTime": "23:59:59",
    "PromotionID": "06777bca-ad15-4806-a625-009fce7bc54a"
  }
]

Get Promotion Event by Variant Code

Request

Get promotion event details by variant code. Requires the "VIEW" role in the "Promotion" group.

Security
OAuth2_clientCredentials
Query
VariantCodestringrequired

Variant Code

Example: VariantCode=1315L
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/PromotionEvent/GetByVariantCode?VariantCode=1315L' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
Namestringnon-emptyrequired
UnitPricenumberrequired
ExtraCostnumberrequired
Discountnumberrequired
StartDatestringnon-emptyrequired
ExpirationDatestringnon-emptyrequired
StartTimestringnon-emptyrequired
ExpirationTimestringnon-emptyrequired
PromotionIDstringnon-emptyrequired
]
Response
application/json
[
  {
    "Name": "DealPOS Book Fair 2022",
    "UnitPrice": 100000,
    "ExtraCost": 0,
    "Discount": 0,
    "StartDate": "2022-04-13T00:00:00",
    "ExpirationDate": "2022-04-21T00:00:00",
    "StartTime": "00:00:00",
    "ExpirationTime": "23:59:59",
    "PromotionID": "06777bca-ad15-4806-a625-009fce7bc54a"
  }
]

Pricebook

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

Operations

Outlet

Operations related to outlet, including create, get, etc

Operations

User

Operations related to user, 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

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

Expense

Operations related to get expense

Operations

Logistics Service

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

Operations

Park Order Display

Operations related to parked order display, including create, get, etc

Operations

Midtrans Payment Gateway

Operations related to Midtrans Payment Gateway, including create, get, etc

Operations

Apps

Operations related to Apps, including create, get, etc

Operations

Client Secret

Operations related to client secret, including create, get, etc

Operations

Rate Limit

Operations related to rate limit, including create, get, etc

Operations