Product Webhook API (1.0.0)

Webhook that triggers when a new product is created

Download OpenAPI description

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

Supplier Bill Payment CreatedWebhook

Request

Triggered when a supplier bill payment is successfully completed.

Bodyapplication/jsonrequired

IDstringnon-emptyrequired

Unique ID of the payment

BillIDstringnon-emptyrequired

Unique bill ID of the payment

Outletstringnon-emptyrequired

Origin outlet of the payment

Numberstringnon-emptyrequired

Number of the transaction

Amountnumberrequired

Total amount of the payment

Methodstringnon-emptyrequired

Type/method of the payment

Datestringnon-emptyrequired

Date of the payment made

Createdstringnon-emptyrequired

Created date of the payment

Creatorstringnon-emptyrequired

Name of the person who created the payment

CreatorIDstringnon-empty

Unique ID of the person who created the payment

application/json

{
  "ID": "f53187c8-1b8e-4075-a227-6867d09179cd",
  "BillID": "7aaf89d0-52be-448a-8f19-18ef163e21ff",
  "Outlet": "Outlet1",
  "Number": "2-OT/21/08/0006",
  "Amount": 60000,
  "Method": "Cash",
  "Date": "2021-08-20T00:00:00",
  "Created": "2021-08-20T10:28:56.6691072",
  "Creator": "dealpos",
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee"
}

Responses

Successfully processed supplier bill payment creation .

Supplier Bill Payment DeletedWebhook

Request

Triggered when a supplier bill payment is successfully deleted.

Bodyapplication/jsonrequired

IDstringnon-emptyrequired

Unique ID of the payment

BillIDstringnon-emptyrequired

Unique bill ID of the payment

Outletstringnon-emptyrequired

Origin outlet of the payment

Numberstringnon-emptyrequired

Number of the transaction

Amountnumberrequired

Total amount of the payment

Methodstringnon-emptyrequired

Type/method of the payment

Datestringnon-emptyrequired

Date of the payment made

Createdstringnon-emptyrequired

Created date of the payment

Creatorstringnon-emptyrequired

Name of the person who created the payment

CreatorIDstringnon-empty

Unique ID of the person who created the payment

application/json

{
  "ID": "f53187c8-1b8e-4075-a227-6867d09179cd",
  "BillID": "7aaf89d0-52be-448a-8f19-18ef163e21ff",
  "Outlet": "Outlet1",
  "Number": "2-OT/21/08/0006",
  "Amount": 60000,
  "Method": "Cash",
  "Date": "2021-08-20T00:00:00",
  "Created": "2021-08-20T10:28:56.6691072",
  "Creator": "dealpos",
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee"
}

Responses

Successfully processed supplier bill payment deletion .

Supplier Bill Payment UpdatedWebhook

Request

Triggered when a supplier bill payment is successfully updated.

Bodyapplication/jsonrequired

IDstringnon-emptyrequired

Unique ID of the payment

BillIDstringnon-emptyrequired

Unique bill ID of the payment

Outletstringnon-emptyrequired

Origin outlet of the payment

Numberstringnon-emptyrequired

Number of the transaction

Amountnumberrequired

Total amount of the payment

Methodstringnon-emptyrequired

Type/method of the payment

Datestringnon-emptyrequired

Date of the payment made

Createdstringnon-emptyrequired

Created date of the payment

Creatorstringnon-emptyrequired

Name of the person who created the payment

CreatorIDstringnon-empty

Unique ID of the person who created the payment

application/json

{
  "ID": "f53187c8-1b8e-4075-a227-6867d09179cd",
  "BillID": "7aaf89d0-52be-448a-8f19-18ef163e21ff",
  "Outlet": "Outlet1",
  "Number": "2-OT/21/08/0006",
  "Amount": 60000,
  "Method": "Cash",
  "Date": "2021-08-20T00:00:00",
  "Created": "2021-08-20T10:28:56.6691072",
  "Creator": "dealpos",
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee"
}

Responses

Successfully processed supplier bill payment update .

Supplier Bill Payment Write OffWebhook

Request

Triggered when a supplier bill payment is successfully Write Off.

Bodyapplication/jsonrequired

IDstringnon-emptyrequired

Unique ID of the payment

BillIDstringnon-emptyrequired

Unique bill ID of the payment

Outletstringnon-emptyrequired

Origin outlet of the payment

Numberstringnon-emptyrequired

Number of the transaction

Amountnumberrequired

Total amount of the payment

Methodstringnon-emptyrequired

Type/method of the payment

Datestringnon-emptyrequired

Date of the payment made

Createdstringnon-emptyrequired

Created date of the payment

Creatorstringnon-emptyrequired

Name of the person who created the payment

CreatorIDstringnon-empty

Unique ID of the person who created the payment

application/json

{
  "ID": "f53187c8-1b8e-4075-a227-6867d09179cd",
  "BillID": "7aaf89d0-52be-448a-8f19-18ef163e21ff",
  "Outlet": "Outlet1",
  "Number": "2-OT/21/08/0006",
  "Amount": 60000,
  "Method": "Cash",
  "Date": "2021-08-20T00:00:00",
  "Created": "2021-08-20T10:28:56.6691072",
  "Creator": "dealpos",
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee"
}

Responses

Successfully processed supplier bill payment Write Off .

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