Promotion Coupon

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

List Promotion Coupons

Request

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


Get List of Promotion Coupons

Required Group Role: "Promotion" - "VIEW"

Bodyapplication/json
One of:
Fromstring

Start date of Created Promotion Coupon

Example: "2019-12-01T00:00:00"
Tostring

To date of Created Promotion Coupon

Example: "2019-12-19T00:00:00"
Typestring

Type of promotion coupon

Enum"DiscountPercentage""DiscountAmount""ParkedDeletion""Return""FullAccess"
Example: "DiscountPercentage"
UsageStatusstring

Status Coupon usage (If value null it will show only Active Coupon)

Enum"Active""Used""Expired""All"
Example: "Active"
PageNumbernumberrequired

The number of page data to be displayed

Example: 1
PageSizenumberrequired

The number of rows returned by the API

Example: 10
CustomerCodestring

The customer code that assigned to the coupon

Codestring

Promotion coupon code

Example: "Disc99"
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/PromotionCoupon \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2019-12-01T00:00:00",
    "To": "2019-12-19T00:00:00",
    "Type": "DiscountPercentage",
    "UsageStatus": "Active",
    "PageNumber": 1,
    "PageSize": 10,
    "Code": "Disc99"
  }'

Responses

Bodyapplication/jsonArray [
Codestring

Promotion Coupon Code

Limitinteger

the usage limit of the promotion coupon key

Balanceinteger

Remaining balance of the promotion coupon key

Discountinteger

the discount applied of the promotion coupon

Createdstring

the promotion coupon created time

StartDatestring

Started Date of Promotion Coupon

ExpiryDatestring

the promotion coupon expiry date

Typestring

the promotion coupon discount type

Descriptionstring

Description of promotion coupon

CustomerCodestring

Code of Customer (Member Code)

]
Response
application/json
[
  {
    "Code": "Disc99",
    "Limit": 5,
    "Balance": 5,
    "Discount": 99,
    "Created": "2019-12-17T14:58:15.447",
    "StartDate": "2019-12-01T00:00:00",
    "ExpiryDate": "2019-12-19T00:00:00",
    "Type": "Discount",
    "Description": "Discount percentage 99%",
    "CustomerCode": "DP-001"
  },
  {
    "Code": "Disc100",
    "Limit": 5,
    "Balance": 5,
    "Discount": 100000,
    "Created": "2019-12-17T14:58:15.447",
    "StartDate": "2019-12-01T00:00:00",
    "ExpiryDate": "2019-12-19T00:00:00",
    "Type": "DiscountAmount",
    "Description": "Discount amount 100k",
    "CustomerCode": "DP-001"
  }
]

Create a Promotion Coupon

Request

Create new promotion coupon

You must have "CREATE" role in "Promotion" Module

Bodyapplication/json
One of:
Codestringrequired

Promotion coupon code

Example: "Disc99"
Limitintegerrequired

limit the promotion coupon can be used

Example: 5
Discountintegerrequired

Number of percentage or amount that given from promotion coupon (Only take effect for type Discount Percentage or Discount Amount)

Example: 99
MinimumAmountnumberrequired

Minimum spending amount that allow to use the coupon code. Only for Type DiscountAmount and DiscountPercentage.

Example: 100000
FullPriceItemOnlyboolean

Only use if DiscountType Percentage. If set to "true", coupon discounts apply to regular-priced products

Default false
Example: "No"
MaximumDiscountnumber

Only use if DiscountType Percentage. The maximum discount amount achievable with this coupon

Example: 100000
ExpiryDatestringrequired

expiration date of promotion coupon

Example: "2019-11-18"
StartDatestring

Start date of promotion coupon

Descriptionstring

Promotion coupon description

Example: "Discount percentage 99%"
Typestringrequired

Type of promotion coupon

Enum"DiscountPercentage""DiscountAmount""Return""ParkedDeletion""FullAccess"
Example: "DiscountPercentage"
ReferredByCustomerCodestring

Code of Customer (Member Code)

ReferredByCustomerIDstring

ID of Customer (Member ID)

ReferenceIDstring

InvoiceID (need to be Unique)

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/PromotionCoupon \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Code": "Disc99",
    "Limit": 5,
    "Discount": 99,
    "MinimumAmount": 100000,
    "FullPriceItemOnly": "No",
    "MaximumDiscount": 100000,
    "ExpiryDate": "2019-11-18",
    "Description": "Discount percentage 99%",
    "Type": "DiscountPercentage"
  }'

Responses

Bodyapplication/json
IDstring

the Promotion Coupon has been created

Response
application/json
{
  "ID": "c0472252-57ad-47dd-9aa7-f61129e88831"
}

Delete a Promotion Coupon

Request

Delete Promotion by Code

You must have "DELETE" role in "Promotion" Module

Bodyapplication/json
Codestringrequired

Key of promotion coupon

Example: "Disc99"
curl -i -X DELETE \
  https://subdomain.dealpos.net/api/v3/PromotionCoupon \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Code": "Disc99"
  }'

Responses

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "Coupon has been delete!"
}

List Promotion Coupons With Total Count

Request

Also available as HTTP POST with the same endpoint
Get List of Promotion Coupons

Required Group Role: "Promotion" - "VIEW"

Bodyapplication/json
Fromstringrequired

From date

Example: "2019-12-17"
Tostringrequired

to date

Example: "2019-12-19"
Typestring

Type of promotion coupon

Enum"Discount""DiscountAmount""ParkedDeletion""Return""FullAccess"
Example: "Discount"
PageNumbernumber

The number of page data to be displayed

Example: 1
PageSizenumber

The number of rows returned by the API

Example: 10
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/PromotionCoupon/WithTotalCount \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2019-12-17",
    "To": "2019-12-19",
    "Type": "Discount",
    "PageNumber": 1,
    "PageSize": 10
  }'