Product Webhook API (1.0.0)

Webhook that triggers when a new product is created

Download OpenAPI description
Languages
Servers
Production Server
https://{subdomain}/api/v3/

Product

Webhooks

Invoice

Webhooks

Customer

Webhooks

Supplier

Webhooks

Bill

Webhooks

Transfer Order

Webhooks

Outbound Logistic

Webhooks

Inbound Logistic

Webhooks

Adjustment

Webhooks

Invoice Payment

Webhooks

Bill Payment

Webhooks

Shift

Webhooks

Loyalty Point

Webhooks

Fetch Loyalty PointsWebhook

Request

This webhook is triggered when a customer's loyalty points need to be shown in POS. A synchronous response needs to be provided.

Bodyapplication/jsonrequired
Outletstringrequired

Outlet name.

Phonestringrequired

Customer's mobile phone number.

Emailstringrequired

Customer's email address.

Codestringrequired

Customer code.

application/json
{ "example": { "Outlet": "Outlet1", "Phone": "+628159137777", "Email": "john.doe@gmail.com", "Code": "4650865270308696" } }

Responses

Successful response with loyalty point data.

Bodyapplication/json
Response
application/json
{ "Point": 1208 }

Loyalty Point On Order CompleteWebhook

Request

This webhook is triggered when a sales transaction is completed, updating the customer's loyalty points. A synchronous response is required.

Bodyapplication/jsonrequired
IDstring

Invoice ID

Outletstring

Outlet Name

Numberstring

Invoice Number

Datestring

Invoice Date

Paymentstring

Payment status

DueDatestring

Invoice Due Date

Tagstring

Channel Tagging System

SalesTypestring

Sales channel type

Customerobject
CreatorIDstring

Unique ID of the creator

Createdstring

Transaction creation date

Discount1integer

First discount percentage

Discount2integer

Second discount percentage

DiscountAmountinteger

Total discount amount

Grossinteger

Total amount before discount

TaxCalculationstring

Tax calculation type (Add / Include)

DiscountTotalinteger

Total accumulated discounts

TaxTypestring

Tax type

Taxinteger

Total tax amount

Salesinteger

Total sales amount

Surchargeinteger

Additional expenses (e.g., credit card fees)

SalesNTaxinteger

Sales amount excluding tax

Couponstring

Promotion coupon code

Notestring

Invoice note

InvoiceIDstring

Unique invoice ID

PointUsedinteger

Loyalty points used

PointsEarnedinteger

Loyalty points earned

Deliverystring

Delivery status

Voidstring

Invoice void status

Binboolean

Recycle bin status

VariantsArray of objects
PaymentsArray of objects
application/json
{ "ID": "4bd2e7fc-d6c8-4966-a111-4c1db26d3606", "Outlet": "Outlet1", "Number": "B1.23.02.00004", "Date": "2023-02-17T00:00:00", "Payment": "Paid", "DueDate": "0001-01-01T00:00:00", "Tag": "Normal", "SalesType": "Normal", "Customer": { "Name": "ari2", "Mobile": "081916296998", "ID": "1b90d0ed-84ff-4e30-bded-13414ea3ea77" }, "Gross": 90000, "Sales": 90000, "Payments": [ { … } ] }

Responses

Successful response with loyalty points reward.

Bodyapplication/json
Response
application/json
{ "reward": 9000 }

Loyalty Point Validate CouponWebhook

Request

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

PropertyTypeDescription
TypeStringPromotion Coupon Type
AmountNumberTotal discount percentage or amount given
statusStringStatus of promotion coupon
expiredAtDateTimeExpiry date of promotion coupon

Example Responses:

Response-1 (Percentage)
{
"Type": "percentageDiscount",
"Amount": 50,
"status": "activated",
"expiredAt": "2023-03-19T16:59:59.999Z"
}
Response-2 (Value)
{
"Type": "value",
"Amount": 100000,
"status": "activated",
"expiredAt": "2023-03-19T16:59:59.999Z"
}
Response-3 (400 Bad Request)
{
"status": "used",
"expiredAt": "2023-03-19T16:59:59.999Z",
"Message": "Coupon 29466091 has been used"
}
Bodyapplication/jsonrequired
Keystring

Promotion Coupon Code

Outletstring

Outlet Name

Customerobject
application/json
{ "Key": "1234", "Outlet": "Outlet1", "Customer": { "Email": "hendry@dealpos.com", "Phone": "81234567844" } }

Responses

Successful validation response with discount details.

Bodyapplication/json
Response
application/json
{ "Type": "percentageDiscount", "Amount": 50, "status": "activated", "expiredAt": "2023-03-19T16:59:59.999Z" }

Outlet

Webhooks