Skip to content

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

Transfer Order CreatedWebhook

Request

This webhook is triggered when a Transfer Order is completed.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
Outletstringnon-emptyrequired

Outlet Delivery number

OutletIDstringnon-empty

Unique ID of the outlet delivery

Destinationstringnon-emptyrequired

Destination of the outlet delivery

Datestring(date-time)non-emptyrequired

Date of the outlet delivery

Numberstringnon-emptyrequired

Number of the outlet delivery

Courierstring

Courier name of the outlet delivery

Notestring

Note of the outlet delivery

Statestringnon-emptyrequired

Status of the outlet delivery

ReceivedDatestring(date-time)

Received date of the outlet delivery

ReceivedNotestring

Received note of the outlet delivery

CreatorIDstringnon-emptyrequired

Unique Creator ID of the outlet delivery

Createdstring(date-time)non-emptyrequired

Created date time of the outlet delivery

VariantsArray of objectsnon-emptyuniquerequired
Variants[].​VariantIDstringnon-emptyrequired

Unique ID of the variant

Variants[].​Namestringnon-emptyrequired

Name of the product variant

Variants[].​Codestringnon-emptyrequired

Code of the product variant

Variants[].​Quantitynumberrequired

Total quantity of the product variant

Variants[].​Discountnumberrequired

Discount amount/percentage of the product variant

Variants[].​Costnumberrequired

Unit buying cost of the product variant

Variants[].​Pricenumberrequired

Unit selling price of the product variant

Variants[].​Notestring

Note of the product variant

application/json
{
  "Outlet": "Outlet1",
  "OutletID": "f5d4ef18-5b47-4596-8a42-3d13610b7bf7",
  "Destination": "Outlet2",
  "Date": "2020-09-02T00:00:00",
  "Number": "20.09.00001",
  "Courier": "JNY EXPRESS",
  "Note": "TEST NOTE",
  "State": "Dispatched",
  "ReceivedDate": "2020-09-02T00:00:00",
  "ReceivedNote": "TEST NOTE",
  "CreatorID": "hendry",
  "Created": "2020-09-02T13:23:00",
  "Variants": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json
statusstring
Example: "success"
Response
application/json
{
  "status": "success"
}

Transfer Order DeletedWebhook

Request

This webhook is triggered when a Transfer Order is deleted.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
Outletstringnon-emptyrequired

Outlet Delivery number

OutletIDstringnon-empty

Unique ID of the outlet delivery

Destinationstringnon-emptyrequired

Destination of the outlet delivery

Datestring(date-time)non-emptyrequired

Date of the outlet delivery

Numberstringnon-emptyrequired

Number of the outlet delivery

Courierstring

Courier name of the outlet delivery

Notestring

Note of the outlet delivery

Statestringnon-emptyrequired

Status of the outlet delivery

ReceivedDatestring(date-time)

Received date of the outlet delivery

ReceivedNotestring

Received note of the outlet delivery

CreatorIDstringnon-emptyrequired

Unique Creator ID of the outlet delivery

Createdstring(date-time)non-emptyrequired

Created date time of the outlet delivery

VariantsArray of objectsnon-emptyuniquerequired
Variants[].​VariantIDstringnon-emptyrequired

Unique ID of the variant

Variants[].​Namestringnon-emptyrequired

Name of the product variant

Variants[].​Codestringnon-emptyrequired

Code of the product variant

Variants[].​Quantitynumberrequired

Total quantity of the product variant

Variants[].​Discountnumberrequired

Discount amount/percentage of the product variant

Variants[].​Costnumberrequired

Unit buying cost of the product variant

Variants[].​Pricenumberrequired

Unit selling price of the product variant cisap

Variants[].​Notestring

Note of the product variant

application/json
{
  "Outlet": "Outlet1",
  "OutletID": "f5d4ef18-5b47-4596-8a42-3d13610b7bf7",
  "Destination": "Outlet2",
  "Date": "2020-09-02T00:00:00",
  "Number": "20.09.00001",
  "Courier": "JNY EXPRESS",
  "Note": "TEST NOTE",
  "State": "Dispatched",
  "ReceivedDate": "2020-09-02T00:00:00",
  "ReceivedNote": "TEST NOTE",
  "CreatorID": "hendry",
  "Created": "2020-09-01T13:23:00",
  "Variants": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json
statusstring
Example: "success"
Response
application/json
{
  "status": "success"
}

Transfer Order VoidedWebhook

Request

This webhook is triggered when a Transfer Order is voided.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
Outletstringnon-emptyrequired

Outlet Delivery number

OutletIDstringnon-empty

Unique ID of the outlet delivery

Destinationstringnon-emptyrequired

Destination of the outlet delivery

Datestring(date-time)non-emptyrequired

Date of the outlet delivery

Numberstringnon-emptyrequired

Number of the outlet delivery

Courierstring

Courier name of the outlet delivery

Notestring

Note of the outlet delivery

Statestringnon-emptyrequired

Status of the outlet delivery

ReceivedDatestring(date-time)

Received date of the outlet delivery

ReceivedNotestring

Received note of the outlet delivery

CreatorIDstringnon-emptyrequired

Unique Creator ID of the outlet delivery

Createdstring(date-time)non-emptyrequired

Created date time of the outlet delivery

VariantsArray of objectsnon-emptyuniquerequired
Variants[].​VariantIDstringnon-emptyrequired

Unique ID of the variant

Variants[].​Namestringnon-emptyrequired

Name of the product variant

Variants[].​Codestringnon-emptyrequired

Code of the product variant

Variants[].​Quantitynumberrequired

Total quantity of the product variant

Variants[].​Discountnumberrequired

Discount amount/percentage of the product variant

Variants[].​Costnumberrequired

Unit buying cost of the product variant

Variants[].​Pricenumberrequired

Unit selling price of the product variant cisap

Variants[].​Notestring

Note of the product variant

application/json
{
  "Outlet": "Outlet1",
  "OutletID": "f5d4ef18-5b47-4596-8a42-3d13610b7bf7",
  "Destination": "Outlet2",
  "Date": "2020-09-02T00:00:00",
  "Number": "20.09.00001",
  "Courier": "JNT EXPRESS",
  "Note": "TEST NOTE",
  "State": "Dispatched",
  "ReceivedDate": "2020-09-02T00:00:00",
  "ReceivedNote": "TEST NOTE",
  "CreatorID": "hendry",
  "Created": "2020-09-01T13:23:00",
  "Variants": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json
statusstring
Example: "success"
Response
application/json
{
  "status": "success"
}

Transfer Order UpdatedWebhook

Request

This webhook is triggered when the status of a Transfer Order is updated.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
Outletstringnon-emptyrequired

Outlet Delivery number

OutletIDstringnon-empty

Unique ID of the outlet delivery

Destinationstringnon-emptyrequired

Destination of the outlet delivery

Datestring(date-time)non-emptyrequired

Date of the outlet delivery

Numberstringnon-emptyrequired

Number of the outlet delivery

Courierstring

Courier name of the outlet delivery

Notestring

Note of the outlet delivery

Statestringnon-emptyrequired

Status of the outlet delivery

ReceivedDatestring(date-time)

Received date of the outlet delivery

ReceivedNotestring

Received note of the outlet delivery

CreatorIDstringnon-emptyrequired

Unique Creator ID of the outlet delivery

Createdstring(date-time)non-emptyrequired

Created date time of the outlet delivery

VariantsArray of objectsnon-emptyuniquerequired
Variants[].​VariantIDstringnon-emptyrequired

Unique ID of the variant

Variants[].​Namestringnon-emptyrequired

Name of the product variant

Variants[].​Codestringnon-emptyrequired

Code of the product variant

Variants[].​Quantitynumberrequired

Total quantity of the product variant

Variants[].​Discountnumberrequired

Discount amount/percentage of the product variant

Variants[].​Costnumberrequired

Unit buying cost of the product variant

Variants[].​Pricenumberrequired

Unit selling price of the product variant

Variants[].​Notestring

Note of the product variant

application/json
{
  "Outlet": "Outlet1",
  "OutletID": "f5d4ef18-5b47-4596-8a42-3d13610b7bf7",
  "Destination": "Outlet2",
  "Date": "2020-09-01T00:00:00",
  "Number": "20.09.00001",
  "Courier": "JNY EXPRESS",
  "Note": "TEST NOTE",
  "State": "Dispatched",
  "ReceivedDate": "2020-09-01T00:00:00",
  "ReceivedNote": "TEST NOTE",
  "CreatorID": "hendry",
  "Created": "2020-09-01T13:23:00",
  "Variants": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json
statusstring
Example: "success"
Response
application/json
{
  "status": "success"
}

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