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

Webhooks

Product CreatedWebhook

Request

This webhook is triggered when a new product is created.

Bodyapplication/json
IDstring

The unique ID of the variant created.

Categorystringnon-empty

The name of the category.

Namestringnon-empty

The name of the product.

SupplierNamestring

The name of the supplier.

BrandNamestring

The name of the brand.

Codestringnon-empty

The product code.

Discontinuedboolean

Product availability status.

Descriptionstringnon-empty

The product description.

Storagestringnon-empty

The storage location of the product.

TagsArray of strings

Tags associated with the product.

ImageURLstring

URL for the product image.

VariantsArray of objects
application/json
{
  "ID": "0ce13b18-bd2d-466a-8cc1-fde2191655e9",
  "Category": "Top",
  "Name": "Flanel",
  "SupplierName": "PT SENANG SEKALI",
  "BrandName": "TEGUH Clothing",
  "Code": "8008",
  "Discontinued": false,
  "Description": "New Arrival",
  "Storage": "Rack1",
  "Tags": [
    "Cloth"
  ],
  "ImageURL": "/media/0ce13b18-bd2d-466a-8cc1-fde2191655e9/",
  "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
IDstringrequired

The unique ID of the variant created.

Categorystringnon-emptyrequired

The name of the category that will be used. You can also create a new category (e.g., "Food/Snack/Pastries" will create 3 levels).

Namestringnon-emptyrequired

The name of the product to be updated.

SupplierNamestring

The name of the supplier for the product.

BrandNamestring

The name of the brand for the product.

Codestringnon-emptyrequired

The product code.

Discontinuedbooleanrequired

Product availability for selling.

Descriptionstringnon-emptyrequired

The description of the product.

Storagestringnon-emptyrequired

The storage location of the product.

TagsArray of stringsrequired

The tags associated with the product.

ImageURLstringrequired

URL of the product image.

VariantsArray of objectsnon-emptyuniquerequired
Variants[].​IDstringnon-empty

The unique ID of the variant.

Variants[].​Modelstringnon-empty

The model of the variant.

Variants[].​Codestringnon-empty

The variant code.

Variants[].​UnitCostnumber

The cost of the variant.

Variants[].​UnitPricenumber

The price of the variant.

Variants[].​Discountnumber

The discount percentage for the variant.

Variants[].​Discontinuedboolean

Variant availability for selling.

Variants[].​Descriptionstringnon-empty

Variant description.

application/json
{
  "ID": "0ce13b18-bd2d-466a-8cc1-fde2191655e9",
  "Category": "Top",
  "Name": "Flanel",
  "SupplierName": "PT Sehat Sejahtera",
  "BrandName": "Adodis",
  "Code": "8008",
  "Discontinued": false,
  "Description": "New Arrival",
  "Storage": "Rack1",
  "Tags": [
    "Cloth"
  ],
  "ImageURL": "/media/0ce13b18-bd2d-466a-8cc1-fde2191655e9/",
  "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

The unique ID of the product to be deleted.

Example: "0ce13b18-bd2d-466a-8cc1-fde2191655e9"
Categorystringnon-empty

The name of the category the product belongs to.

Example: "Top"
Namestringnon-empty

The name of the product.

Example: "Flanel"
SupplierNamestring

The name of the supplier of the product.

BrandNamestring

The name of the brand of the product.

Codestringnon-empty

The unique code of the product.

Example: "8008"
Discontinuedboolean

Whether the product is discontinued.

Descriptionstringnon-empty

A description of the product.

Example: "New Arrival"
Storagestringnon-empty

Where the product is stored.

Example: "Rack1"
TagsArray of strings

Tags associated with the product.

Example: ["Cloth"]
ImageURLstring

URL for the image of the product.

Example: "/media/0ce13b18-bd2d-466a-8cc1-fde2191655e9/"
VariantsArray of objects

Variants associated with the product.

Example: [{"ID":"bf708967-3a30-4db1-bfb1-443728a2ffd3","Model":"M","Code":"8008M","UnitCost":150000,"UnitPrice":200000,"Discount":20,"Discontinued":false,"Description":"New Arrival"},{"ID":"e2e5828d-5bd4-42e2-98f5-7aec0d0877ff","Model":"L","Code":"8008L","UnitCost":150000,"UnitPrice":200000,"Discount":0,"Discontinued":false,"Description":"New Arrival"},{"ID":"8b13fc57-92dc-4222-a9d7-b4731e929f86","Model":"XL","Code":"8008XL","UnitCost":150000,"UnitPrice":200000,"Discount":0,"Discontinued":false,"Description":"New Arrival"}]
application/json
{
  "ID": "0ce13b18-bd2d-466a-8cc1-fde2191655e9",
  "Category": "Top",
  "Name": "Flanel",
  "SupplierName": null,
  "BrandName": null,
  "Code": "8008",
  "Discontinued": false,
  "Description": "New Arrival",
  "Storage": "Rack1",
  "Tags": [
    "Cloth"
  ],
  "ImageURL": "/media/0ce13b18-bd2d-466a-8cc1-fde2191655e9/",
  "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.

Categorystring

The category ID of the product.

Productstring

The name of the product.

Variantstring

The variant of the product.

Namestring

The name of the product variant.

Codestring

The product code.

Weightinteger

The weight of the product.

Typestring

The type of product variant.

OrderPriceinteger

The order price of the product.

UnitCostinteger

The unit cost of the product.

UnitPriceinteger

The unit price of the product.

Taxableboolean

Whether the product is taxable.

LoyaltyPointboolean

Whether the product is eligible for loyalty points.

Discontinuedboolean

Whether the product variant is discontinued.

ComponentsArray of objects
OutletPriceArray of objects
application/json
{
  "Example 1": {
    "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

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

Outlet

Webhooks