Webhook
ZORT have webhook to callback when some events are triggered. The system will send request by "POST" method to your endpoint URL that set in the system.
Common Request Parameters
Your Endpoint URL
Every request will be sent with Header to endpoint URL.
Header
Parameter | Description |
---|---|
Authorization | Basic {key1} |
key1 | Key Reference 1 |
key2 | Key Reference 2 |
key3 | Key Reference 3 |
A trigger with by API request will be not sent to webhook that use the same API Key.
How To Set Webhook
Set manually in ZORT portal.
Login to ZORT.
Go to menu Setting --> Integration --> API Reference --> Webhook.
Input key and endpoint URL and click "Verify and Save".
Set by calling API.
You can send request to update webhook information.
UPDATEWEBHOOK
POST
https://open-api.zortout.com/v4/Webhook/UpdateWebhook
Update webhook information.
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Request Body
Name | Type | Description |
---|---|---|
key1* | String | Key Reference 1 |
key2* | String | Key Reference 2 |
key3* | String | Key Reference 3 |
addproducturl | String | Endpoint URL when product is created. If this value is null or blank, this trigger will be not active. |
updateproducturl | String | Endpoint URL when product is modified. If this value is null or blank, this trigger will be not active. |
deleteproducturl | String | Endpoint URL when product is deleted. If this value is null or blank, this trigger will be not active. |
updatequantityurl | String | Endpoint URL when product quantity is changed. If this value is null or blank, this trigger will be not active. |
addorderurl | String | Endpoint URL when order is created. If this value is null or blank, this trigger will be not active. |
updateorderurl | String | Endpoint URL when order is modified or an order status is changed. If this value is null or blank, this trigger will be not active. |
updateordertrackingurl | String | Endpoint URL when tracking no in order is changed. If this value is null or blank, this trigger will be not active. |
updateorderpaymenturl | String | Endpoint URL when payments in order is changed. If this value is null or blank, this trigger will be not active. |
addpurchaseurl | String | Endpoint URL when purchase is created. If this value is null or blank, this trigger will be not active. |
updatepurchaseurl | String | Endpoint URL when purchase is modified or a purchase status is changed. If this value is null or blank, this trigger will be not active. |
updatepurchasepaymenturl | String | Endpoint URL when payments in purchase is changed. If this value is null or blank, this trigger will be not active. |
addreturnorderurl | String | Endpoint URL when return order is created. If this value is null or blank, this trigger will be not active. |
updatereturnorderurl | String | Endpoint URL when return order is modified or a return order status is changed. If this value is null or blank, this trigger will be not active. |
updatereturnorderpaymenturl | String | Endpoint URL when payments in return order is changed. If this value is null or blank, this trigger will be not active. |
addreturnpurchaseurl | String | Endpoint URL when return purchase is created. If this value is null or blank, this trigger will be not active. |
updatereturnpurchaseurl | String | Endpoint URL when return purchase is modified or a return purchase status is changed. If this value is null or blank, this trigger will be not active. |
updatereturnpurchasepaymenturl | String | Endpoint URL when payments in return purchase is changed. If this value is null or blank, this trigger will be not active. |
addtransferurl | String | Endpoint URL when transfer is created. If this value is null or blank, this trigger will be not active. |
updatetransferurl | String | Endpoint URL when transfer is modified or a transfer status is changed. If this value is null or blank, this trigger will be not active. |
deletewarehouseurl | String | Endpoint URL when warehouse is deleted. If this value is null or blank, this trigger will be not active. |
updatewarehouseurl | String | Endpoint URL when warehouse is modified. If this value is null or blank, this trigger will be not active. |
addwarehouseurl | String | Endpoint URL when warehouse is created. If this value is null or blank, this trigger will be not active. |
deletecontacturl | String | Endpoint URL when contact is deleted. If this value is null or blank, this trigger will be not active. |
updatecontacturl | String | Endpoint URL when contact is modified. If this value is null or blank, this trigger will be not active. |
addcontacturl | String | Endpoint URL when contact is created. If this value is null or blank, this trigger will be not active. |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
You can get current webhook information by calling "GETWEBHOOK" method.
GETWEBHOOK
GET
https://open-api.zortout.com/v4/Webhook/GetWebhook
Get webhook information.
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Parameter | Type | Description/Example |
---|---|---|
key1 | String | Key Reference 1 |
key2 | String | Key Reference 2 |
key3 | String | Key Reference 3 |
addproducturl | String | Endpoint URL when product is created. |
updateproducturl | String | Endpoint URL when product is modified. |
deleteproducturl | String | Endpoint URL when product is deleted. |
updatequantityurl | String | Endpoint URL when product quantity is changed. |
addorderurl | String | Endpoint URL when order is create |
updateorderurl | String | Endpoint URL when order is modified or an order status is changed. |
updateordertrackingurl | String | Endpoint URL when tracking no in order is changed. |
updateorderpaymenturl | String | Endpoint URL when payments in order is changed. |
addpurchaseurl | String | Endpoint URL when purchase is created |
updatepurchaseurl | String | Endpoint URL when purchase is modified or a purchase status is changed. |
updatepurchasepaymenturl | String | Endpoint URL when payments in purchase is changed. |
addreturnorderurl | String | Endpoint URL when return order is created. |
updatereturnorderurl | String | Endpoint URL when return order is modified or a return order status is changed. |
updatereturnorderpaymenturl | String | Endpoint URL when payments in return order is changed. |
addreturnpurchaseurl | String | Endpoint URL when return purchase is created. |
updatereturnpurchaseurl | String | Endpoint URL when return purchase is modified or a return purchase status is changed. |
updatereturnpurchasepaymenturl | String | Endpoint URL when payments in return purchase is changed. |
addtransferurl | String | Endpoint URL when transfer is created. |
updatetransferurl | String | Endpoint URL when transfer is modified or a transfer status is changed. |
addcontacturl | String | Endpoint URL when contact is created. |
updatecontacturl | String | Endpoint URL when contact is modified. |
deletecontacturl | String | Endpoint URL when contact is deleted. If this value is null or blank, this trigger will be not active. |
addwarehouseurl | String | Endpoint URL when warehouse is created. |
updatewarehouseurl | String | Endpoint URL when warehouse is modified. |
deletewarehouseurl | String | Endpoint URL when warehouse is deleted. If this value is null or blank, this trigger will be not active. |
Trigger
ADDPRODUCT
POST
{Your Endpoint URL}
Send request when a product is created.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | ADDPRODUCT |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
UPDATEPRODUCT
POST
{Your Endpoint URL}
Send request when a product is modified.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | UPDATEPRODUCT |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
UPDATEPRODUCTQUANTITY
POST
{Your Endpoint URL}
Send request when a product quantity is changed.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | UPDATEPRODUCTQUANTITY |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
DELETEPRODUCT
POST
{Your Endpoint URL}
Send request when a product is deleted.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | DELETEPRODUCT |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
ADDORDER
POST
{Your Endpoint URL}
Send request when an order is created.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | ADDORDER |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
UPDATEORDER
POST
{Your Endpoint URL}
Send request when an order is modified or an order status is changed.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | UPDATEORDER |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
UPDATEORDERPAYMENT
POST
{Your Endpoint URL}
Send request when payments in order is changed.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | UPDATEORDERPAYMENT |
id* | Int | Order ID |
number* | String | Order Number |
paymentstatus* | String | Payment Status (Pending, Paid, Partial Payment, Excess Payment) |
UPDATEORDERTRACKING
POST
{Your Endpoint URL}
Send request when a tracking no in order is changed.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | UPDATEORDERTRACKING |
id* | Int | Order ID |
number* | String | Order Number |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
DELETEORDER
POST
{Your Endpoint URL}
Send request when an order is deleted.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | DELETEORDER |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
Purchase Order Trigger
ADDPURCHASEORDER
POST
{Your Endpoint URL}
Send request when a purchase is created.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | ADDPURCHASEORDER |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
UPDATEPURCHASEORDER
POST
{Your Endpoint URL}
Send request when a purchase is modified or a purchase status is changed.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | UPDATEPURCHASEORDER |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
UPDATEPURCHASEORDERPAYMENT
POST
{Your Endpoint URL}
Send request when payments in purchase is changed.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | UPDATEPURCHASEORDERPAYMENT |
id* | Int | PurchaseOrder ID |
number* | String | PurchaseOrder Number |
paymentstatus* | String | Payment Status (Pending, Paid, Partial Payment, Excess Payment) |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
DELETEPURCHASEORDER
POST
{Your Endpoint URL}
Send request when an purchase is deleted.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | DELETEPURCHASEORDER |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
Return Order Trigger
ADDRETURNORDER
POST
{Your Endpoint URL}
Send request when a return order is created.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | ADDRETURNORDER |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
UPDATERETURNORDER
POST
{Your Endpoint URL}
Send request when a return order is modified or a return order status is changed.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | UPDATERETURNORDER |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
UPDATERETURNORDERPAYMENT
POST
{Your Endpoint URL}
Send request when payments in return order is changed.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | UPDATERETURNORDERPAYMENT |
id* | Int | ReturnOrder ID |
number* | String | ReturnOrder Number |
paymentstatus* | String | Payment Status (Pending, Paid, Partial Payment, Excess Payment) |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
DELETERETURNORDER
POST
{Your Endpoint URL}
Send request when an return order is deleted.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | DELETERETURNORDER |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
Return Purchase Order Trigger
ADDRETURNPURCHASEORDER
POST
{Your Endpoint URL}
Send request when a return purchase is created.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | ADDRETURNPURCHASEORDER |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
UPDATERETURNPURCHASEORDER
POST
{Your Endpoint URL}
Send request when a return purchase is modified or a return purchase status is changed.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | UPDATERETURNPURCHASEORDER |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |
UPDATERETURNPURCHASEORDERPAYMENT
POST
{Your Endpoint URL}
Send request when payments in return purchase is changed.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | UPDATERETURNPURCHASEORDERPAYMENT |
id* | Int | ReturnPurchaseOrder ID |
number* | String | ReturnPurchaseOrder Number |
paymentstatus* | String |
Request Body
Name | Type | Description |
---|---|---|
payload* | String | Payload (JSON format) See detail in Ex. Payload JSON. |