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

Transfer Order

Webhooks

Outbound Logistic

Webhooks

Inbound Logistic

Webhooks

Adjustment

Webhooks

Invoice Payment

Webhooks

Bill Payment

Webhooks

Shift

Webhooks

Loyalty Point

Webhooks

Outlet

Webhooks

Sales Order

Webhooks

Sales Order CreatedWebhook

Request

Sends data when a sales order is converted to an invoice.

Bodyapplication/jsonrequired

IDstringrequired

Unique ID of the invoice

Outletstringrequired

Name of the outlet

Numberstringrequired

Number of the invoice transaction

Datestringrequired

Sell date of the invoice transaction

DueDatestringrequired

Due date of the invoice transaction

Tagstringrequired

Channel Tagging system. (ex:Offline / Whatsapp / Shopee / Tokopedia) used in marketplace.dealpos.app. Backwards Compatibility with property request "SalesType"

Customerobjectrequired

Customer.Namestringrequired

Name of the customer

Customer.Emailstringrequired

E-mail of the customer

Customer.Phonestringrequired

Phone number of the customer

Customer.Mobilestringrequired

Mobile Phone Number of the customer

Customer.Codestringrequired

Unique Code of the customer

CreatorIDstringrequired

Unique ID of the creator

Createdstringrequired

Invoice created Transaction Date by system

Discount1integerrequired

Percentage of discount 1

Discount2integerrequired

Percentage of discount 2

DiscountAmountintegerrequired

Discount Amount per-invoice

Grossintegerrequired

Total amount of the transaction before discounted

DiscountTotalintegerrequired

Total accumulation of whole discounts

TaxTypestringrequired

Type name of the tax

TaxCalculationstringrequired

Calculation tax type (Add or Include)

Taxintegerrequired

Total amount of the taxes

TaxRateintegerrequired

Rate of Tax in percentage

Salesintegerrequired

Total amount of the sales after subtraction

Surchargeintegerrequired

Additional expense (ex: from credit card)

SalesNTaxintegerrequired

Total amount of sales after taxes

Couponstringrequired

Registered Coupon Name/Code

Notestringrequired

Note of the invoice transaction

PointUsedintegerrequired

Total point used in the transaction

PointsEarnedintegerrequired

Total point earned from the transaction

Deliverystringrequired

Delivery status / progress of the invoice (Value: Sent / Unsent / Partial)

Voidstringrequired

Void state / status of the invoice (Yes / No)

VariantsArray of objectsrequired

Variants[].VariantIDstringrequired

Variant ID

Variants[].Namestringrequired

Variant's Name

Variants[].Codestringrequired

Variant's Code

Variants[].Quantityintegerrequired

Quantity of the variant

Variants[].UnitQuantityintegerrequired

Unit Quantity Measurement of the variant

Variants[].Costintegerrequired

Unit Cost of variant

Variants[].Priceintegerrequired

Selling Price of the variant

Variants[].PriceOriginalnumberrequired

Original Price (before discounted) of the variant

Variants[].Discountintegerrequired

Discount Percentage (%) of the variant

Variants[].DiscountAmountintegerrequired

Total discount amount per-after multiply by the qty

Variants[].Taxablebooleanrequired

Taxable state/status of the invoice transaction

Variants[].LoyaltyPointbooleanrequired

Loyalty state/status of the invoice transaction

Variants[].Expenseintegerrequired

Additional Expense of the variant

Variants[].NettPriceintegerrequired

Total amount of the variant after subscration

Variants[].Commissionintegerrequired

Sales commision of the invoice transaction

Variants[].SalesNamestringrequired

Sales Person Name of the transaction

Variants[].PriceTypeIDintegerrequired

Sales price type of the transaction

Variants[].Notestringrequired

Product Variant Note of the invoice transaction

OutboundLogisticsArray of objectsrequired

OutboundLogistics[].Outletstringrequired

Outlet Name Of Outbound Logistic

OutboundLogistics[].Numberstringrequired

Outbound Logistic Number

OutboundLogistics[].Datestringrequired

Date of OutboundLogistic

PaymentsArray of objectsrequired

Payments[].Datestringrequired

Date of the payment

Payments[].Amountintegerrequired

Total amount of the payment

Payments[].Methodstringrequired

Payment method of the invoice transaction

Payments[].Codestringrequired

Code of the payment method

Payments[].Notestringrequired

Note of the payment method

application/json

{
  "ID": "e0211b45-358e-4d5c-bf5b-8a31404b125e",
  "Outlet": "Outlet1",
  "Number": "20.09.00020",
  "Date": "2020-09-02T00:00:00",
  "DueDate": "2020-09-10T00:00:00",
  "Tag": "Take Away",
  "Customer": {
    "Name": "Hendry",
    "Email": "henz2194w@gmail.com",
    "Phone": "0215851412",
    "Mobile": "0815161688",
    "Code": "HW0001"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-09-02T13:52:18.33",
  "Discount1": 0,
  "Discount2": 0,
  "DiscountAmount": 0,
  "Gross": 100000,
  "DiscountTotal": 0,
  "TaxType": "No Tax",
  "TaxCalculation": "Add",
  "Tax": 0,
  "TaxRate": 0,
  "Sales": 100000,
  "Surcharge": 0,
  "SalesNTax": 100000,
  "Coupon": "KUPON123",
  "Note": "CONTOH NOTE",
  "PointUsed": 0,
  "PointsEarned": 0,
  "Delivery": "Sent",
  "Void": "No",
  "Variants": [
    { … }
  ],
  "OutboundLogistics": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Responses

Success

Sales Order DeletedWebhook

Request

Webhook triggered upon sales order deletion.

Bodyapplication/jsonrequired

Outletstring

Name of the outlet.

Numberstring

Sales order number.

Datestring(date-time)

Deletion date of the sales order.

Customerobject

Customer details.

CreatorIDstring

ID of the creator.

Createdstring(date-time)

Creation date of the sales order.

Discount1integer

Discount percentage (type 1).

Discount2integer

Discount percentage (type 2).

DiscountAmountinteger

Total discount amount.

Grossinteger

Total gross amount.

Couponstring

Coupon used in the transaction.

Notestring

Additional notes for the sales order.

PointUsedinteger

Points used in the transaction.

Deliverystring

Delivery status (e.g., Sent, Partial, Unsent).

Voidstring

Void status (Yes or No).

VariantsArray of objects

Product variants in the sales order.

application/json

{
  "Outlet": "Offline",
  "Number": "B1.22.07.00025",
  "Date": "2022-07-25T00:00:00",
  "Customer": {},
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee",
  "Created": "2022-07-25T16:14:03.9",
  "Discount1": 0,
  "Discount2": 0,
  "DiscountAmount": 0,
  "Gross": 7800000,
  "Coupon": "KUPON123",
  "Note": "CONTOH NOTE",
  "PointUsed": 0,
  "Delivery": "Sent",
  "Void": "No",
  "Variants": [
    { … }
  ]
}

Responses

Successfully received the webhook.

Sales Order ConvertedWebhook

Request

This endpoint receives the data when a sales order is converted into an invoice.

Bodyapplication/json

IDstringrequired

Outletstringrequired

Numberstringrequired

Datestringrequired

DueDatestringrequired

Tagstringrequired

Customerobjectrequired

Customer.Namestringrequired

Customer.Emailstringrequired

Customer.Phonestringrequired

Customer.Mobilestringrequired

Customer.Codestringrequired

CreatorIDstringrequired

Createdstringrequired

Discount1integerrequired

Discount2integerrequired

DiscountAmountintegerrequired

Grossintegerrequired

DiscountTotalintegerrequired

TaxTypestringrequired

TaxCalculationstringrequired

Taxintegerrequired

TaxRateintegerrequired

Salesintegerrequired

Surchargeintegerrequired

SalesNTaxintegerrequired

Couponnullrequired

Notenullrequired

PointUsedintegerrequired

PointsEarnedintegerrequired

Deliverystringrequired

Voidstringrequired

VariantsArray of objectsrequired

Variants[].VariantIDstring

Variants[].Namestring

Variants[].Codestring

Variants[].Quantityinteger

Variants[].UnitQuantityinteger

Variants[].Costinteger

Variants[].Priceinteger

Variants[].PriceOriginalnumber

Variants[].Discountinteger

Variants[].DiscountAmountinteger

Variants[].Taxableboolean

Variants[].LoyaltyPointboolean

Variants[].Expenseinteger

Variants[].NettPriceinteger

Variants[].Commissioninteger

Variants[].SalesNamenull

Variants[].PriceTypeIDinteger

Variants[].Notestring

OutboundLogisticsArray of objectsrequired

OutboundLogistics[].Outletstring

OutboundLogistics[].Numberstring

OutboundLogistics[].Datestring

PaymentsArray of objectsrequired

Payments[].Datestring

Payments[].Amountinteger

Payments[].Methodstring

Payments[].Codestring

Payments[].Notestring

application/json

{
  "ID": "string",
  "Outlet": "string",
  "Number": "string",
  "Date": "string",
  "DueDate": "string",
  "Tag": "string",
  "Customer": {
    "Name": "string",
    "Email": "string",
    "Phone": "string",
    "Mobile": "string",
    "Code": "string"
  },
  "CreatorID": "string",
  "Created": "string",
  "Discount1": 0,
  "Discount2": 0,
  "DiscountAmount": 0,
  "Gross": 0,
  "DiscountTotal": 0,
  "TaxType": "string",
  "TaxCalculation": "string",
  "Tax": 0,
  "TaxRate": 0,
  "Sales": 0,
  "Surcharge": 0,
  "SalesNTax": 0,
  "Coupon": null,
  "Note": null,
  "PointUsed": 0,
  "PointsEarned": 0,
  "Delivery": "string",
  "Void": "string",
  "Variants": [
    { … }
  ],
  "OutboundLogistics": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Responses

Successfully received the webhook data