Loyalty Provider
/
Validate Coupon

Product Webhook API (1.0.0)

Webhook that triggers when a new product is created

Download OpenAPI description
webhook.json
webhook.yaml
Languages
Servers
Production Server
https://{subdomain}/api/v3/

Product

Webhook for product events

Webhooks

Invoice

Webhook for invoice events

Webhooks

Customer

Webhook for customer events

Webhooks

Supplier

Webhook for supplier events

Webhooks

Bill

Webhook for bill events

Webhooks

Transfer Order

Webhook for transfer order events

Webhooks

Outbound Logistic

Webhook for outbound logistic events

Webhooks

Inbound Logistic

Webhook for inbound logistic events

Webhooks

Adjustment

Webhook for adjustment events

Webhooks

Invoice Payment

Webhook for invoice payment events

Webhooks

Bill Payment

Webhook for bill payment events

Webhooks

Shift

Webhook for shift events

Webhooks

Outlet

Webhook for outlet events

Webhooks

Sales Order

Webhook for sales order events

Webhooks

Loyalty Provider

Use this section to integrate external coupon provider to DealPOS

Go to Developer Menu -> Tab Promotion Coupon Provider then click button Add and fill with your endpoint. Loyalty Image

Webhooks

Validate CouponWebhook

Request

This webhook is triggered when the user inputs a promotional coupon from the SELL page from the external app. This is a synchronous API that requires a response.

To developer who wants to use this webhook, you can create prototypes Endpoint URL mockserver from beeceptor.

Bodyapplication/jsonrequired
Codestring

Promotion Coupon Code

Outletstring

Outlet Name

Customerobject
ShoppingCartobject
application/json
{
  "Code": "1234",
  "Outlet": "Outlet1",
  "Customer": {
    "Email": "hendry@dealpos.com",
    "Phone": "81234567844"
  },
  "ShoppingCart": {
    "Amount": 100000,
    "Items": [ … ]
  }
}

Responses

Successful validation response with discount details.

Bodyapplication/json
Typestring

Promotion Coupon Type (Percentage / Amount)

Enum"Percentage""Amount"
Amountnumber

Total discount percentage or amount given

Notificationstring

The message that will be shown to the USER in a Toaster!

ApplyToobject

List of Product Variant Codes to apply the coupon Amount. When ApplyTo is null, the coupon will be applied to discount invoice

Response
application/json
{
  "Type": "Percentage",
  "Amount": 50,
  "Notification": "50% Discount Applied. Proof of Transaction",
  "ApplyTo": {
    "Code": [ … ]
  }
}

Redeem CouponWebhook

Request

This webhook will be triggered once the provider has configured the coupon and completed the payment or invoice creation in Sell menu.

Bodyapplication/json
IDstring

Unique ID of the invoice

Outletstring

Name of the outlet

Numberstring

Number of the invoice transaction

Datestring

Date of the invoice transaction

DueDatestring

Due date of the invoice transaction

Tagstring

Channel Tagging system (e.g., Take Away, Shopee)

Customerobject
CreatorIDstring

ID of the creator of the invoice

Createdstring

Date when the invoice was created

Discount1integer

Percentage of discount 1

Discount2integer

Percentage of discount 2

DiscountAmountinteger

Discount amount applied

Grossinteger

Total amount before discounts

DiscountTotalinteger

Total discount applied

TaxTypestring

Type of tax (e.g., No Tax)

TaxCalculationstring

Tax calculation method (e.g., Add or Include)

Taxinteger

Total tax applied

TaxRateinteger

Tax rate in percentage

Salesinteger

Total sales after discounts

Surchargeinteger

Additional surcharge (e.g., credit card fee)

SalesNTaxinteger

Sales total after tax

Couponstring

Coupon code used, if any

CouponNotestring

Additional note for the coupon

Notestring

Additional note for the invoice

PointUsedinteger

Total loyalty points used

PointsEarnedinteger

Total loyalty points earned

Deliverystring

Delivery status (Sent, Unsent, etc.)

Voidstring

Whether the invoice is voided (Yes/No)

VariantsArray of objects
OutboundLogisticsArray of objects
PaymentsArray of objects
ReferenceNumberstring

Reference number for the invoice

OrderFulfillmentRecipientobject
application/json
{
  "ID": "e0211b45-358e-4d5c-bf5b-8a31404b125e",
  "Outlet": "Outlet1",
  "Number": "20.09.00020",
  "Date": "2020-09-02T00:00:00",
  "DueDate": "0001-01-01T00:00:00",
  "Tag": "Take Away",
  "Customer": {
    "ID": "2774372b-0d5e-4171-8c83-dd66fbd4461e",
    "Name": "hendry",
    "Email": "henz2194w@gmail.com",
    "Phone": "0215851412",
    "Mobile": "0815161688",
    "Code": "HW0001",
    "Address": "Jl. Muara No. 3"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-09-02T13:52:18.33",
  "Discount1": 0,
  "Discount2": 0,
  "DiscountAmount": 0,
  "Gross": 100000,
  "DiscountTotal": 0,
  "TaxType": "No Tax",
  "TaxCalculation": "Add",
  "Tax": 0,
  "TaxRate": 0,
  "Sales": 100000,
  "Surcharge": 0,
  "SalesNTax": 100000,
  "Coupon": "XPPW123",
  "CouponNote": "Test Coupon",
  "Note": "Note Test",
  "PointUsed": 0,
  "PointsEarned": 0,
  "Delivery": "Sent",
  "Void": "No",
  "Variants": [
    { … }
  ],
  "Payments": [
    { … }
  ],
  "OutboundLogistics": [
    { … }
  ]
}