Product Webhook API (1.0.0)

Webhook that triggers when a new product is created

Download OpenAPI description
Languages
Servers
Production Server
https://{subdomain}/api/v3/

Product

Webhooks

Invoice

Webhooks

Customer

Webhooks

Supplier

Webhooks

Bill

Webhooks

Transfer Order

Webhooks

Transfer Order CreatedWebhook

Request

This webhook is triggered when a Transfer Order is completed.

Bodyapplication/jsonrequired
Outletstringnon-emptyrequired

Outlet Delivery number

Destinationstringnon-emptyrequired

Destination of the outlet delivery

Datestring(date-time)non-emptyrequired

Date of the outlet delivery

Numberstringnon-emptyrequired

Number of the outlet delivery

Courierstring

Courier name of the outlet delivery

Notestring

Note of the outlet delivery

Statestringnon-emptyrequired

Status of the outlet delivery

ReceivedDatestring(date-time)

Received date of the outlet delivery

ReceivedNotestring

Received note of the outlet delivery

CreatorIDstringnon-emptyrequired

Unique Creator ID of the outlet delivery

Createdstring(date-time)non-emptyrequired

Created date time of the outlet delivery

VariantsArray of objectsnon-emptyuniquerequired
Variants[].​VariantIDstringnon-emptyrequired

Unique ID of the variant

Variants[].​Namestringnon-emptyrequired

Name of the product variant

Variants[].​Codestringnon-emptyrequired

Code of the product variant

Variants[].​Quantitynumberrequired

Total quantity of the product variant

Variants[].​Discountnumberrequired

Discount amount/percentage of the product variant

Variants[].​Costnumberrequired

Unit buying cost of the product variant

Variants[].​Pricenumberrequired

Unit selling price of the product variant

Variants[].​Notestring

Note of the product variant

application/json
{ "Outlet": "Outlet1", "Destination": "Outlet2", "Date": "01 Sep 2020 00:00", "Number": "20.09.00001", "Courier": "JNY EXPRESS", "Note": "TEST NOTE", "State": "Dispatched", "ReceivedDate": "01 Sep 2020 00:00", "ReceivedNote": "TEST NOTE", "CreatorID": "hendry", "Created": "01 Sep 2020 13:23", "Variants": [ { … } ] }

Responses

Webhook received successfully

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

Transfer Order DeletedWebhook

Request

This webhook is triggered when a Transfer Order is deleted.

Bodyapplication/jsonrequired
Outletstringnon-emptyrequired

Outlet Delivery number

Destinationstringnon-emptyrequired

Destination of the outlet delivery

Datestring(date-time)non-emptyrequired

Date of the outlet delivery

Numberstringnon-emptyrequired

Number of the outlet delivery

Courierstring

Courier name of the outlet delivery

Notestring

Note of the outlet delivery

Statestringnon-emptyrequired

Status of the outlet delivery

ReceivedDatestring(date-time)

Received date of the outlet delivery

ReceivedNotestring

Received note of the outlet delivery

CreatorIDstringnon-emptyrequired

Unique Creator ID of the outlet delivery

Createdstring(date-time)non-emptyrequired

Created date time of the outlet delivery

VariantsArray of objectsnon-emptyuniquerequired
Variants[].​VariantIDstringnon-emptyrequired

Unique ID of the variant

Variants[].​Namestringnon-emptyrequired

Name of the product variant

Variants[].​Codestringnon-emptyrequired

Code of the product variant

Variants[].​Quantitynumberrequired

Total quantity of the product variant

Variants[].​Discountnumberrequired

Discount amount/percentage of the product variant

Variants[].​Costnumberrequired

Unit buying cost of the product variant

Variants[].​Pricenumberrequired

Unit selling price of the product variant cisap

Variants[].​Notestring

Note of the product variant

application/json
{ "Outlet": "Outlet1", "Destination": "Outlet2", "Date": "01 Sep 2020 00:00", "Number": "20.09.00001", "Courier": "JNY EXPRESS", "Note": "TEST NOTE", "State": "Dispatched", "ReceivedDate": "01 Sep 2020 00:00", "ReceivedNote": "TEST NOTE", "CreatorID": "hendry", "Created": "01 Sep 2020 13:23", "Variants": [ { … } ] }

Responses

Webhook received successfully

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

Transfer Order UpdatedWebhook

Request

This webhook is triggered when the status of a Transfer Order is updated.

Bodyapplication/jsonrequired
Outletstringnon-emptyrequired

Outlet Delivery number

Destinationstringnon-emptyrequired

Destination of the outlet delivery

Datestring(date-time)non-emptyrequired

Date of the outlet delivery

Numberstringnon-emptyrequired

Number of the outlet delivery

Courierstring

Courier name of the outlet delivery

Notestring

Note of the outlet delivery

Statestringnon-emptyrequired

Status of the outlet delivery

ReceivedDatestring(date-time)

Received date of the outlet delivery

ReceivedNotestring

Received note of the outlet delivery

CreatorIDstringnon-emptyrequired

Unique Creator ID of the outlet delivery

Createdstring(date-time)non-emptyrequired

Created date time of the outlet delivery

VariantsArray of objectsnon-emptyuniquerequired
Variants[].​VariantIDstringnon-emptyrequired

Unique ID of the variant

Variants[].​Namestringnon-emptyrequired

Name of the product variant

Variants[].​Codestringnon-emptyrequired

Code of the product variant

Variants[].​Quantitynumberrequired

Total quantity of the product variant

Variants[].​Discountnumberrequired

Discount amount/percentage of the product variant

Variants[].​Costnumberrequired

Unit buying cost of the product variant

Variants[].​Pricenumberrequired

Unit selling price of the product variant

Variants[].​Notestring

Note of the product variant

application/json
{ "Outlet": "Outlet1", "Destination": "Outlet2", "Date": "01 Sep 2020 00:00", "Number": "20.09.00001", "Courier": "JNY EXPRESS", "Note": "TEST NOTE", "State": "Dispatched", "ReceivedDate": "01 Sep 2020 00:00", "ReceivedNote": "TEST NOTE", "CreatorID": "hendry", "Created": "01 Sep 2020 13:23", "Variants": [ { … } ] }

Responses

Webhook received successfully

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

Outbound Logistic

Webhooks

Inbound Logistic

Webhooks

Adjustment

Webhooks

Invoice Payment

Webhooks

Bill Payment

Webhooks

Shift

Webhooks

Loyalty Point

Webhooks

Outlet

Webhooks

Sales Order

Webhooks