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

Webhooks

Invoice

Webhooks

Customer

Webhooks

Supplier

Webhooks

Bill

Webhooks

Purchase Order CreatedWebhook

Request

This webhook is triggered when a new purchase order has been completed in the Buy Menu.

Bodyapplication/json

IDstringnon-empty

Unique ID of the supplier bill

Outletstringnon-empty

Outlet origin of the supplier bill

Numberstringnon-empty

Number of the supplier bill

Datestringnon-empty

Date of the supplier bill

DueDatestring

Due date of the supplier bill

Supplierobject

CreatorIDstringnon-empty

Unique creator ID of the supplier bill

Createdstringnon-empty

Supplier bill created date

Discount1number

Discount percentage applied in the bill

DiscountAmountnumber

Discount amount applied in the bill

Grossnumber

Total amount before discounts

DiscountTotalnumber

Total discount in the supplier bill

TaxTypestringnon-empty

Type of tax applied to the supplier bill

Taxnumber

Total amount or percentage of tax

Purchasenumber

Total net purchase amount

PurchaseNTaxnumber

Total amount of the supplier bill after taxes

Deliverystringnon-empty

Delivery state of the supplier bill

Tagstring

Channel Tagging System

VariantsArray of objectsnon-emptyunique

PaymentsArray of objectsnon-emptyunique

application/json

{
  "ID": "e0211b45-358e-4d5c-bf5b-8a31404b125e",
  "Outlet": "Outlet1",
  "Number": "20.09.00001",
  "Date": "2020-09-02T00:00:00",
  "DueDate": "",
  "Supplier": {
    "Name": "Hendry Wijaya",
    "Title": "Mr.",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Phone": "0215895473",
    "Email": "Ndry94@gmail.com",
    "Code": "S12889",
    "Gender": "Male"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-09-02T14:05:40.84",
  "Discount1": 0,
  "DiscountAmount": 0,
  "Gross": 100000,
  "DiscountTotal": 0,
  "TaxType": "No Tax",
  "Tax": 0,
  "Purchase": 100000,
  "PurchaseNTax": 100000,
  "Delivery": "Received",
  "Tag": "Offline Store",
  "Variants": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json

statusstring

Example: "success"

Response

application/json

{
  "status": "success"
}

Purchase Order DeletedWebhook

Request

This webhook is triggered when a purchase order is deleted in the Buy Menu.

Bodyapplication/json

IDstringnon-empty

Unique ID of the supplier bill

Outletstringnon-empty

Outlet origin of the supplier bill

Numberstringnon-empty

Number of the supplier bill

Datestringnon-empty

Date of the supplier bill

DueDatestring

Due date of the supplier bill

Supplierobject

CreatorIDstringnon-empty

Unique creator ID of the supplier bill

Createdstringnon-empty

Supplier bill created date

Discount1number

Discount percentage applied in the bill

DiscountAmountnumber

Discount amount applied in the bill

Grossnumber

Total amount before discounts

DiscountTotalnumber

Total discount in the supplier bill

TaxTypestringnon-empty

Type of tax applied to the supplier bill

Taxnumber

Total amount or percentage of tax

Purchasenumber

Total net purchase amount

PurchaseNTaxnumber

Total amount of the supplier bill after taxes

Deliverystringnon-empty

Delivery state of the supplier bill

Tagstring

Channel Tagging System

VariantsArray of objectsnon-emptyunique

PaymentsArray of objectsnon-emptyunique

application/json

{
  "ID": "e0211b45-358e-4d5c-bf5b-8a31404b125e",
  "Outlet": "Outlet1",
  "Number": "20.09.00001",
  "Date": "2020-09-02T00:00:00",
  "DueDate": "",
  "Supplier": {
    "Name": "Hendry Wijaya",
    "Title": "Mr.",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Phone": "0215895473",
    "Email": "Ndry94@gmail.com",
    "Code": "S12889",
    "Gender": "Male"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-09-02T14:05:40.84",
  "Discount1": 0,
  "DiscountAmount": 0,
  "Gross": 100000,
  "DiscountTotal": 0,
  "TaxType": "No Tax",
  "Tax": 0,
  "Purchase": 100000,
  "PurchaseNTax": 100000,
  "Delivery": "Received",
  "Tag": "Offline Store",
  "Variants": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json

statusstring

Example: "success"

Response

application/json

{
  "status": "success"
}

Purchase Order RestoredWebhook

Request

This webhook is triggered when a Purchase Order is restored.

Bodyapplication/jsonrequired

IDstringrequired

Unique ID of the supplier bill.

Outletstringrequired

Outlet origin of the supplier bill.

Numberstringrequired

Number of the supplier bill.

Datestring(date-time)required

Date of the supplier bill.

DueDatestring

Due date of the supplier bill.

Supplierobjectrequired

Supplier.Namestringrequired

Name of the supplier.

Supplier.Titlestringrequired

Title on behalf of the supplier.

Supplier.FirstNamestringrequired

First name of the supplier.

Supplier.LastNamestringrequired

Last name of the supplier.

Supplier.Phonestringrequired

Phone number of the supplier.

Supplier.Emailstringrequired

Email of the supplier.

Supplier.Codestringrequired

Member code of the supplier.

Supplier.Genderstringrequired

Gender of the supplier.

CreatorIDstringrequired

Unique Creator ID of the supplier bill.

Createdstring(date-time)required

Supplier bill creation date.

Discount1number

Discount percentage applied to the bill.

DiscountAmountnumber

Discount amount applied to the bill.

Grossnumberrequired

Total amount before discount.

DiscountTotalnumber

Total discount in the supplier bill.

TaxTypestring

Type of tax applied to the supplier bill.

Taxnumber

Total tax amount.

Purchasenumber

Total net purchase amount.

PurchaseNTaxnumber

Total amount of the supplier bill after taxes.

Deliverystring

Delivery status of the supplier bill.

Tagstring

Channel tagging system.

VariantsArray of objectsrequired

Variants[].VariantIDstring

Variants[].Namestring

Variants[].Codestring

Variants[].Quantitynumber

Variants[].Pricenumber

Variants[].Discountnumber

Variants[].Notestring

PaymentsArray of objectsrequired

Payments[].Datestring(date-time)

Payments[].Amountnumber

Payments[].Methodstring

Payments[].Codestring

Payments[].Notestring

application/json

{
  "ID": "e0211b45-358e-4d5c-bf5b-8a31404b125e",
  "Outlet": "Outlet1",
  "Number": "20.09.00001",
  "Date": "2020-09-02T00:00:00",
  "DueDate": "",
  "Supplier": {
    "Name": "Hendry Wijaya",
    "Title": "Mr.",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Phone": "0215895473",
    "Email": "Ndry94@gmail.com",
    "Code": "S12889",
    "Gender": "Male"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-09-02T14:05:40.84",
  "Discount1": 0,
  "DiscountAmount": 0,
  "Gross": 100000,
  "DiscountTotal": 0,
  "TaxType": "No Tax",
  "Tax": 0,
  "Purchase": 100000,
  "PurchaseNTax": 100000,
  "Delivery": "Received",
  "Tag": "Offline Store",
  "Variants": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json

statusstring

Example: "success"

Response

application/json

{
  "status": "success"
}

Purchase Order UpdatedWebhook

Request

This webhook is triggered when a Purchase Order is updated.

Bodyapplication/jsonrequired

IDstringrequired

Unique ID of the supplier bill.

Outletstringrequired

Outlet origin of the supplier bill.

Numberstringrequired

Number of the supplier bill.

Datestring(date-time)required

Date of the supplier bill.

DueDatestring

Due date of the supplier bill.

Supplierobjectrequired

Supplier.Namestringrequired

Name of the supplier.

Supplier.Titlestringrequired

Title on behalf of the supplier.

Supplier.FirstNamestringrequired

First name of the supplier.

Supplier.LastNamestringrequired

Last name of the supplier.

Supplier.Phonestringrequired

Phone number of the supplier.

Supplier.Emailstringrequired

Email of the supplier.

Supplier.Codestringrequired

Member code of the supplier.

Supplier.Genderstringrequired

Gender of the supplier.

CreatorIDstringrequired

Unique Creator ID of the supplier bill.

Createdstring(date-time)required

Supplier bill creation date.

Discount1number

Discount percentage applied to the bill.

DiscountAmountnumber

Discount amount applied to the bill.

Grossnumberrequired

Total amount before discount.

DiscountTotalnumber

Total discount in the supplier bill.

TaxTypestring

Type of tax applied to the supplier bill.

Taxnumber

Total tax amount.

Purchasenumber

Total net purchase amount.

PurchaseNTaxnumber

Total amount of the supplier bill after taxes.

Deliverystring

Delivery status of the supplier bill.

Tagstring

Channel tagging system.

VariantsArray of objectsrequired

Variants[].VariantIDstring

Variants[].Namestring

Variants[].Codestring

Variants[].Quantitynumber

Variants[].Pricenumber

Variants[].Discountnumber

Variants[].Notestring

PaymentsArray of objectsrequired

Payments[].Datestring(date-time)

Payments[].Amountnumber

Payments[].Methodstring

Payments[].Codestring

Payments[].Notestring

application/json

{
  "ID": "e0211b45-358e-4d5c-bf5b-8a31404b125e",
  "Outlet": "Outlet1",
  "Number": "20.09.00001",
  "Date": "2020-09-02T00:00:00",
  "DueDate": "",
  "Supplier": {
    "Name": "Hendry Wijaya",
    "Title": "Mr.",
    "FirstName": "Hendry",
    "LastName": "Wijaya",
    "Phone": "0215895473",
    "Email": "Ndry94@gmail.com",
    "Code": "S12889",
    "Gender": "Male"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-09-02T14:05:40.84",
  "Discount1": 0,
  "DiscountAmount": 0,
  "Gross": 100000,
  "DiscountTotal": 0,
  "TaxType": "No Tax",
  "Tax": 0,
  "Purchase": 100000,
  "PurchaseNTax": 100000,
  "Delivery": "Received",
  "Tag": "Offline Store",
  "Variants": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json

statusstring

Example: "success"

Response

application/json

{
  "status": "success"
}

Purchase Order VoidedWebhook

Request

This webhook is triggered when a Purchase Order is voided.

Bodyapplication/jsonrequired

IDstringrequired

Unique ID of the supplier bill.

Outletstringrequired

Outlet origin of the supplier bill.

Numberstringrequired

Number of the supplier bill.

Datestring(date-time)required

Date of the supplier bill.

DueDatestring

Due date of the supplier bill.

Supplierobjectrequired

Supplier.Namestringrequired

Name of the supplier.

Supplier.Titlestringrequired

Title on behalf of the supplier.

Supplier.FirstNamestringrequired

First name of the supplier.

Supplier.LastNamestringrequired

Last name of the supplier.

Supplier.Phonestringrequired

Phone number of the supplier.

Supplier.Emailstringrequired

Email of the supplier.

Supplier.Codestringrequired

Member code of the supplier.

Supplier.Genderstringrequired

Gender of the supplier.

CreatorIDstringrequired

Unique Creator ID of the supplier bill.