Product

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

Product CreatedWebhook

Request

This webhook is triggered when a new product is created.

Bodyapplication/json
IDstring
Categorystring
Namestring
SupplierNamestring
Brandstring
BrandNamestring
Codestring
Discontinuedboolean
Descriptionstring
StorageArray of objects
TagsArray of strings
ImageURLstring
ThumbnailURLstring
ExtraImageURLArray of strings
VariantsArray of objects
application/json
{
  "ID": "020f279d-e6ba-408c-b944-57bed320dc22",
  "Category": "Accessories",
  "Name": "Gorgeous Dress",
  "SupplierName": "PT Berkah",
  "Brand": "123",
  "BrandName": "123",
  "Code": "DRXS129",
  "Discontinued": false,
  "Description": "Step into elegance with the Gorgeous Dress, tailored for those who desire a blend of classic charm and modern sophistication. Its delicate fabric gracefully drapes over the body, ensuring both comfort and style. This dress features a flattering silhouette that complements any occasion, from a casual brunch to an elegant evening event. Available in a variety of colors, it promises versatility and timeless appeal in your wardrobe. Make a statement and turn heads with every step in the Gorgeous Dress.",
  "Storage": [
    { … },
    { … }
  ],
  "Tags": [
    "123"
  ],
  "ImageURL": "https://cdn.dealpos.app/com/starterretail/Product/020f279d-e6ba-408c-b944-57bed320dc22/aa65e037-setelan-satu-warna-ala-kimono.jpeg",
  "ThumbnailURL": "https://cdn.dealpos.app/cdn-cgi/image/width=80,quality=100/com/starterretail/Product/020f279d-e6ba-408c-b944-57bed320dc22/aa65e037-setelan-satu-warna-ala-kimono.jpeg",
  "ExtraImageURL": [
    "https://cdn.dealpos.app/com/starterretail/Product/020f279d-e6ba-408c-b944-57bed320dc22/A10092200400_3.jpg"
  ],
  "Variants": [
    { … }
  ]
}

Responses

Webhook received successfully

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

Product UpdatedWebhook

Request

This webhook is triggered when a product is updated

Bodyapplication/json
IDstring
Categorystring
Namestring
SupplierNamestring
Brandstring
BrandNamestring
Codestring
Discontinuedboolean
Descriptionstring
StorageArray of objects
TagsArray of strings
ImageURLstring
ThumbnailURLstring
ExtraImageURLArray of strings
VariantsArray of objects
application/json
{
  "ID": "020f279d-e6ba-408c-b944-57bed320dc22",
  "Category": "Accessories",
  "Name": "Gorgeous Dress NEW Collection",
  "SupplierName": "PT Berkah",
  "Brand": "123",
  "BrandName": "123",
  "Code": "DRXS129",
  "Discontinued": false,
  "Description": "Step into elegance with the Gorgeous Dress, tailored for those who desire a blend of classic charm and modern sophistication. Its delicate fabric gracefully drapes over the body, ensuring both comfort and style. This dress features a flattering silhouette that complements any occasion, from a casual brunch to an elegant evening event. Available in a variety of colors, it promises versatility and timeless appeal in your wardrobe. Make a statement and turn heads with every step in the Gorgeous Dress.",
  "Storage": [
    { … },
    { … }
  ],
  "Tags": [
    "123"
  ],
  "ImageURL": "https://cdn.dealpos.app/com/starterretail/Product/020f279d-e6ba-408c-b944-57bed320dc22/aa65e037-setelan-satu-warna-ala-kimono.jpeg",
  "ThumbnailURL": "https://cdn.dealpos.app/cdn-cgi/image/width=80,quality=100/com/starterretail/Product/020f279d-e6ba-408c-b944-57bed320dc22/aa65e037-setelan-satu-warna-ala-kimono.jpeg",
  "ExtraImageURL": [
    "https://cdn.dealpos.app/com/starterretail/Product/020f279d-e6ba-408c-b944-57bed320dc22/A10092200400_3.jpg"
  ],
  "Variants": [
    { … }
  ]
}

Responses

Webhook received successfully

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

Product DeletedWebhook

Request

This webhook is triggered when a product is deleted

Bodyapplication/json
IDstring
Categorystring
Namestring
SupplierNamestring
Brandstring
BrandNamestring
Codestring
Discontinuedboolean
Descriptionstring
StorageArray of objects
TagsArray of strings
ImageURLstring
ThumbnailURLstring
ExtraImageURLArray of strings
VariantsArray of objects
application/json
{
  "ID": "020f279d-e6ba-408c-b944-57bed320dc22",
  "Category": "Accessories",
  "Name": "Gorgeous Dress NEW Collection",
  "SupplierName": "PT Berkah",
  "Brand": "123",
  "BrandName": "123",
  "Code": "DRXS129",
  "Discontinued": false,
  "Description": "Step into elegance with the Gorgeous Dress, tailored for those who desire a blend of classic charm and modern sophistication. Its delicate fabric gracefully drapes over the body, ensuring both comfort and style. This dress features a flattering silhouette that complements any occasion, from a casual brunch to an elegant evening event. Available in a variety of colors, it promises versatility and timeless appeal in your wardrobe. Make a statement and turn heads with every step in the Gorgeous Dress.",
  "Storage": [
    { … },
    { … }
  ],
  "Tags": [
    "123"
  ],
  "ImageURL": "https://cdn.dealpos.app/com/starterretail/Product/020f279d-e6ba-408c-b944-57bed320dc22/aa65e037-setelan-satu-warna-ala-kimono.jpeg",
  "ThumbnailURL": "https://cdn.dealpos.app/cdn-cgi/image/width=80,quality=100/com/starterretail/Product/020f279d-e6ba-408c-b944-57bed320dc22/aa65e037-setelan-satu-warna-ala-kimono.jpeg",
  "ExtraImageURL": [
    "https://cdn.dealpos.app/com/starterretail/Product/020f279d-e6ba-408c-b944-57bed320dc22/A10092200400_3.jpg"
  ],
  "Variants": [
    { … }
  ]
}

Responses

Webhook received successfully

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

Product Variant CreatedWebhook

Request

This webhook is triggered when a new product variant is created.

Bodyapplication/json
IDstring

The unique ID of the product variant.

Example: "dc3c01f1-6af5-4a86-9e31-ffaaca8051df"
Categorystring

The category ID of the product.

Example: "123"
Productstring

The name of the product.

Example: "Tupperware"
Variantstring

The variant of the product.

Example: "XL"
Namestring

The name of the product variant.

Example: "Tupperware - TPW (XL)"
Codestring

The product code.

Example: "TPW-XL"
Weightinteger

The weight of the product.

Typestring

The type of product variant.

Example: "Standard"
OrderPriceinteger

The order price of the product.

UnitCostinteger

The unit cost of the product.

Example: 125000
UnitPriceinteger

The unit price of the product.

Example: 250000
Taxableboolean

Whether the product is taxable.

Example: true
LoyaltyPointboolean

Whether the product is eligible for loyalty points.

Example: true
Discontinuedboolean

Whether the product variant is discontinued.

ComponentsArray of objects
Example: [{"Name":"Sticker","Code":"STI01","Qty":1}]
OutletPriceArray of objects
Example: [{"Outlet":"Outlet1","Price":225000,"ExtraCost":0}]
application/json
{
  "ID": "dc3c01f1-6af5-4a86-9e31-ffaaca8051df",
  "Category": "123",
  "Product": "Tupperware",
  "Variant": "XL",
  "Name": "Tupperware - TPW (XL)",
  "Code": "TPW-XL",
  "Weight": 0,
  "Type": "Standard",
  "OrderPrice": 0,
  "UnitCost": 125000,
  "UnitPrice": 250000,
  "Taxable": true,
  "LoyaltyPoint": true,
  "Discontinued": false,
  "Components": [
    { … }
  ],
  "OutletPrice": [
    { … }
  ]
}

Responses

Webhook received successfully

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

Product Variant UpdatedWebhook

Request

This webhook is triggered when a product variant is updated.

Bodyapplication/json
IDstring

Unique identifier of the variant.

Categorystring

The category associated with the product.

Productstring

Name of the product.

Variantstring

The variant type or size.

Namestring

Full name of the product variant.

Codestring

Unique code for the variant.

Weightnumber

Weight of the variant.

Typestring

Type of the product variant (e.g., Standard).

OrderPricenumber

Price used for orders.

UnitCostnumber

Cost of the variant.

UnitPricenumber

Selling price of the variant.

Taxableboolean

Indicates if the variant is taxable.

LoyaltyPointboolean

Indicates if the variant provides loyalty points.

Discontinuedboolean

Indicates if the variant is discontinued.

ComponentsArray of objects
OutletPriceArray of objects
application/json
{
  "ID": "dc3c01f1-6af5-4a86-9e31-ffaaca8051df",
  "Category": "123",
  "Product": "Tupperware",
  "Variant": "XL",
  "Name": "Tupperware - TPW (XL)",
  "Code": "TPW-XL",
  "Weight": 0,
  "Type": "Standard",
  "OrderPrice": 0,
  "UnitCost": 125000,
  "UnitPrice": 250000,
  "Taxable": true,
  "LoyaltyPoint": true,
  "Discontinued": false,
  "Components": [
    { … }
  ],
  "OutletPrice": [
    { … }
  ]
}

Responses

Webhook received successfully

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

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