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

Outbound Logistic

Webhook for outbound logistic events

Webhooks

Inbound Logistic

Webhook for inbound logistic events

Webhooks

Adjustment

Webhook for adjustment events

Webhooks

Adjustment CreatedWebhook

Request

This webhook is triggered when an adjustment is Created to inventory.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
IDstringnon-emptyrequired

Unique id of the Adjustment

Outletstringnon-emptyrequired

Origin Outlet of the Adjustment

Datestring(date-time)non-emptyrequired

Date of the Adjustment made

Numberstringnon-emptyrequired

Number of the Adjustment

PICstring

Person in charge of the adjustment

Typestringnon-emptyrequired

Type of the Adjustment

Enum"Adjust""Count"
Statestringnon-emptyrequired

Adjustment progress / state

Notestringrequired

Note of the Adjustment

CreatorIDstringnon-empty

Unique Creator ID of the adjustment

AdjustedInventoryArray of objectsnon-emptyuniquerequired
AdjustedInventory[].​Variantstringnon-emptyrequired

Name of the product variant adjusted

AdjustedInventory[].​VariantIDstringnon-emptyrequired

Variant ID of the product variant adjusted

AdjustedInventory[].​Codestringnon-emptyrequired

Code of the product variant adjusted

AdjustedInventory[].​Quantitynumberrequired

Quantity of the product variant adjusted

AdjustedInventory[].​UnitCostnumberrequired

Unit buying cost of the product variant adjusted

AdjustedInventory[].​UnitPricenumberrequired

Unit selling price of the product variant adjusted

AdjustedInventory[].​Pricenumberrequired

Original Price of the product variant adjusted

AdjustedInventory[].​TotalCostnumberrequired

Total unit buying cost of the product variant adjusted

AdjustedInventory[].​TotalPricenumberrequired

Total unit selling price of the product variant

CountedInventoryArray of objectsnon-emptyuniquerequired
CountedInventory[].​Variantstringnon-emptyrequired

Name of the product variant adjusted

CountedInventory[].​VariantIDstringnon-emptyrequired

Variant ID of the product variant adjusted

CountedInventory[].​Codestringnon-emptyrequired

Code of the product variant adjusted

CountedInventory[].​Countednumberrequired

Total counted product of the adjustment

CountedInventory[].​Actualnumberrequired

Total actual stock product of the adjustment

CountedInventory[].​Differencenumberrequired

Difference between the counted and the actual product

application/json
{
  "ID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Outlet": "Outlet1",
  "Date": "2020-08-31T00:00:00",
  "Number": "20.08.00014",
  "PIC": "JANSEN",
  "Type": "Count",
  "State": "InProgress",
  "Note": "",
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee",
  "AdjustedInventory": [
    { … }
  ],
  "CountedInventory": [
    { … }
  ]
}

Responses

Webhook received successfully

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

Adjustment DeletedWebhook

Request

This webhook is triggered when an adjustment is deleted.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
IDstringnon-emptyrequired

Unique id of the Adjustment

Outletstringnon-emptyrequired

Origin Outlet of the Adjustment

Datestring(date-time)non-emptyrequired

Date of the Adjustment made

Numberstringnon-emptyrequired

Number of the Adjustment

PICstring

Person in charge of the adjustment

Typestringnon-emptyrequired

Type of the Adjustment

Enum"Adjust""Count"
Statestringnon-emptyrequired

Adjustment progress / state

Notestringrequired

Note of the Adjustment

CreatorIDstringnon-empty

Unique Creator ID of the adjustment

AdjustedInventoryArray of objectsnon-emptyuniquerequired
AdjustedInventory[].​Variantstringnon-emptyrequired

Name of the product variant adjusted

AdjustedInventory[].​VariantIDstringnon-emptyrequired

Variant ID of the product variant adjusted

AdjustedInventory[].​Codestringnon-emptyrequired

Code of the product variant adjusted

AdjustedInventory[].​Quantitynumberrequired

Quantity of the product variant adjusted

AdjustedInventory[].​UnitCostnumberrequired

Unit buying cost of the product variant adjusted

AdjustedInventory[].​UnitPricenumberrequired

Unit selling price of the product variant adjusted

AdjustedInventory[].​Pricenumberrequired

Original Price of the product variant adjusted

AdjustedInventory[].​TotalCostnumberrequired

Total unit buying cost of the product variant adjusted

AdjustedInventory[].​TotalPricenumberrequired

Total unit selling price of the product variant

CountedInventoryArray of objectsnon-emptyuniquerequired
CountedInventory[].​Variantstringnon-emptyrequired

Name of the product variant adjusted

CountedInventory[].​VariantIDstringnon-emptyrequired

Variant ID of the product variant adjusted

CountedInventory[].​Codestringnon-emptyrequired

Code of the product variant adjusted

CountedInventory[].​Countednumberrequired

Total counted product of the adjustment

CountedInventory[].​Actualnumberrequired

Total actual stock product of the adjustment

CountedInventory[].​Differencenumberrequired

Difference between the counted and the actual product

application/json
{
  "ID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Outlet": "Outlet1",
  "Date": "2020-08-31T00:00:00",
  "Number": "20.08.00014",
  "PIC": "JANSEN",
  "Type": "Count",
  "State": "InProgress",
  "Note": "",
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee",
  "AdjustedInventory": [
    { … }
  ],
  "CountedInventory": [
    { … }
  ]
}

Responses

Webhook received successfully

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

Adjustment UpdatedWebhook

Request

This webhook is triggered when an adjustment is updated.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
IDstringnon-emptyrequired

Unique id of the Adjustment

Outletstringnon-emptyrequired

Origin Outlet of the Adjustment

Datestring(date-time)non-emptyrequired

Date of the Adjustment made

Numberstringnon-emptyrequired

Number of the Adjustment

PICstring

Person in charge of the adjustment

Typestringnon-emptyrequired

Type of the Adjustment

Enum"Adjust""Count"
Statestringnon-emptyrequired

Adjustment progress / state

Notestringrequired

Note of the Adjustment

CreatorIDstringnon-empty

Unique Creator ID of the adjustment

AdjustedInventoryArray of objectsnon-emptyuniquerequired
AdjustedInventory[].​Variantstringnon-emptyrequired

Name of the product variant adjusted

AdjustedInventory[].​VariantIDstringnon-emptyrequired

Variant ID of the product variant adjusted

AdjustedInventory[].​Codestringnon-emptyrequired

Code of the product variant adjusted

AdjustedInventory[].​Quantitynumberrequired

Quantity of the product variant adjusted

AdjustedInventory[].​UnitCostnumberrequired

Unit buying cost of the product variant adjusted

AdjustedInventory[].​UnitPricenumberrequired

Unit selling price of the product variant adjusted

AdjustedInventory[].​Pricenumberrequired

Original Price of the product variant adjusted

AdjustedInventory[].​TotalCostnumberrequired

Total unit buying cost of the product variant adjusted

AdjustedInventory[].​TotalPricenumberrequired

Total unit selling price of the product variant

CountedInventoryArray of objectsnon-emptyuniquerequired
CountedInventory[].​Variantstringnon-emptyrequired

Name of the product variant adjusted

CountedInventory[].​VariantIDstringnon-emptyrequired

Variant ID of the product variant adjusted

CountedInventory[].​Codestringnon-emptyrequired

Code of the product variant adjusted

CountedInventory[].​Countednumberrequired

Total counted product of the adjustment

CountedInventory[].​Actualnumberrequired

Total actual stock product of the adjustment

CountedInventory[].​Differencenumberrequired

Difference between the counted and the actual product

application/json
{
  "ID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Outlet": "Outlet1",
  "Date": "2020-08-31T00:00:00",
  "Number": "20.08.00014",
  "PIC": "JANSEN",
  "Type": "Count",
  "State": "InProgress",
  "Note": "",
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee",
  "AdjustedInventory": [
    { … }
  ],
  "CountedInventory": [
    { … }
  ]
}

Responses

Webhook received successfully

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

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