Common Request Parameters
Every request will be sent with Header to endpoint URL.
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.
Go to menu Setting --> Integration --> API Reference --> Webhook.
Input key and endpoint URL and click "Verify and Save".
You can send request to update webhook information.
UPDATEWEBHOOK
POST
https://api.zortout.com/api.aspx
Update webhook information.
Query Parameters
Request Body
You can get current webhook information by calling "GETWEBHOOK " method.
GETWEBHOOK
GET
https://api.zortout.com/api.aspx
Get webhook information.
Query Parameters
Trigger
ADDPRODUCT
POST
{Your Endpoint URL}
Send request when a product is created.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"sku": "P0001",
"name": "Product1",
"sellprice": "20.00",
"purchaseprice": "10.00",
"unittext": "Piece",
"weight": "500",
"barcode": "1234",
"category": "test category"
}
UPDATEPRODUCT
POST
{Your Endpoint URL}
Send request when a product is modified.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"sku": "P0001",
"name": "Product1",
"sellprice": "20.00",
"purchaseprice": "10.00",
"unittext": "Piece",
"weight": "500",
"barcode": "1234",
"category": "test category"
}
UPDATEPRODUCTQUANTITY
POST
{Your Endpoint URL}
Send request when a product quantity is changed.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"sku": "P0001",
"name": "Product1",
"stock": "20.00",
"availablestock": "10.00"
}
DELETEPRODUCT
POST
{Your Endpoint URL}
Send request when a product is deleted.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"sku": "P0001"
}
ADDORDER
POST
{Your Endpoint URL}
Send request when an order is created.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "SO-0001",
"orderdate": "/Date(1644944400000)/",
"orderdateString": "2022-02-16",
"customerid": 123,
"customername": "Customer Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"customerbranchname": null,
"customerbranchno": null,
"shippingdate": null,
"shippingchannel": null,
"shippingamount": null,
"shippingvat": null,
"shippingname": null,
"shippingaddress": null,
"shippingphone": null,
"shippingemail": null,
"trackingno": null,
"saleschannel": null,
"description": null,
"reference": null,
"vattype": 1,
"list": [
{
"productid": 2345,
"sku": "P0001",
"name": "Product 1",
"number": 1,
"pricepernumber": 100,
"discount": null,
"totalprice": 100
},
{
"productid": 4567,
"sku": "P0002",
"name": "Product 2",
"number": 1,
"pricepernumber": 50,
"discount": null,
"totalprice": 50
}
],
"discount": null,
"vatamount": null,
"amount": 150,
"paymentamount": 150,
"paymentstatus": "Paid",
"status": "Success",
"isCOD": false
}
UPDATEORDER
POST
{Your Endpoint URL}
Send request when an order is modified or an order status is changed.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "SO-0001",
"orderdate": "/Date(1644944400000)/",
"orderdateString": "2022-02-16",
"customerid": 123,
"customername": "Customer Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"customerbranchname": null,
"customerbranchno": null,
"shippingdate": null,
"shippingchannel": null,
"shippingamount": null,
"shippingvat": null,
"shippingname": null,
"shippingaddress": null,
"shippingphone": null,
"shippingemail": null,
"trackingno": null,
"saleschannel": null,
"description": null,
"reference": null,
"vattype": 1,
"list": [
{
"productid": 2345,
"sku": "P0001",
"name": "Product 1",
"number": 1,
"pricepernumber": 100,
"discount": null,
"totalprice": 100
},
{
"productid": 4567,
"sku": "P0002",
"name": "Product 2",
"number": 1,
"pricepernumber": 50,
"discount": null,
"totalprice": 50
}
],
"discount": null,
"vatamount": null,
"amount": 150,
"paymentamount": 150,
"paymentstatus": "Paid",
"status": "Success",
"isCOD": false
}
UPDATEORDERPAYMENT
POST
{Your Endpoint URL}
Send request when payments in order is changed.
Query Parameters
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "SO-0001",
"orderdate": "/Date(1644944400000)/",
"orderdateString": "2022-02-16",
"customerid": 123,
"customername": "Customer Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"customerbranchname": null,
"customerbranchno": null,
"shippingdate": null,
"shippingchannel": null,
"shippingamount": null,
"shippingvat": null,
"shippingname": null,
"shippingaddress": null,
"shippingphone": null,
"shippingemail": null,
"trackingno": null,
"saleschannel": null,
"description": null,
"reference": null,
"vattype": 1,
"list": [
{
"productid": 2345,
"sku": "P0001",
"name": "Product 1",
"number": 1,
"pricepernumber": 100,
"discount": null,
"totalprice": 100
},
{
"productid": 4567,
"sku": "P0002",
"name": "Product 2",
"number": 1,
"pricepernumber": 50,
"discount": null,
"totalprice": 50
}
],
"discount": null,
"vatamount": null,
"amount": 150,
"paymentamount": 150,
"paymentstatus": "Paid",
"status": "Success",
"isCOD": false
}
UPDATEORDERTRACKING
POST
{Your Endpoint URL}
Send request when a tracking no in order is changed.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy [
{
"trackingno": "THP0001",
"trackingurl": "",
"shippingdate": null
}
]
DELETEORDER
POST
{Your Endpoint URL}
Send request when an order is deleted.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "SO-0001"
}
ADDPURCHASEORDER
POST
{Your Endpoint URL}
Send request when a purchase is created.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "PO-0001",
"purchaseorderdate": "/Date(1644944400000)/",
"purchaseorderdateString": "2022-02-16",
"customerid": 123,
"customername": "Customer Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"description": null,
"reference": null,
"vattype": 1,
"list": [
{
"productid": 2345,
"sku": "P0001",
"name": "Product 1",
"number": 1,
"pricepernumber": 100,
"discount": null,
"totalprice": 100
},
{
"productid": 4567,
"sku": "P0002",
"name": "Product 2",
"number": 1,
"pricepernumber": 50,
"discount": null,
"totalprice": 50
}
],
"discount": null,
"vatamount": null,
"amount": 150,
"paymentamount": 150,
"paymentstatus": "Paid",
"status": "Success"
}
UPDATEPURCHASEORDER
POST
{Your Endpoint URL}
Send request when a purchase is modified or a purchase status is changed.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "PO-0001",
"purchaseorderdate": "/Date(1644944400000)/",
"purchaseorderdateString": "2022-02-16",
"customerid": 123,
"customername": "Customer Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"description": null,
"reference": null,
"vattype": 1,
"list": [
{
"productid": 2345,
"sku": "P0001",
"name": "Product 1",
"number": 1,
"pricepernumber": 100,
"discount": null,
"totalprice": 100
},
{
"productid": 4567,
"sku": "P0002",
"name": "Product 2",
"number": 1,
"pricepernumber": 50,
"discount": null,
"totalprice": 50
}
],
"discount": null,
"vatamount": null,
"amount": 150,
"paymentamount": 150,
"paymentstatus": "Paid",
"status": "Success"
}
UPDATEPURCHASEORDERPAYMENT
POST
{Your Endpoint URL}
Send request when payments in purchase is changed.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "PO-0001",
"purchaseorderdate": "/Date(1644944400000)/",
"purchaseorderdateString": "2022-02-16",
"customerid": 123,
"customername": "Customer Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"description": null,
"reference": null,
"vattype": 1,
"list": [
{
"productid": 2345,
"sku": "P0001",
"name": "Product 1",
"number": 1,
"pricepernumber": 100,
"discount": null,
"totalprice": 100
},
{
"productid": 4567,
"sku": "P0002",
"name": "Product 2",
"number": 1,
"pricepernumber": 50,
"discount": null,
"totalprice": 50
}
],
"discount": null,
"vatamount": null,
"amount": 150,
"paymentamount": 150,
"paymentstatus": "Paid",
"status": "Success"
}
DELETEPURCHASEORDER
POST
{Your Endpoint URL}
Send request when an purchase is deleted.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "PO-0001"
}
ADDRETURNORDER
POST
{Your Endpoint URL}
Send request when a return order is created.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "CN-0001",
"returnorderdate": "/Date(1644944400000)/",
"returnorderdateString": "2022-02-16",
"customerid": 123,
"customername": "Customer Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"description": null,
"reference": "SO-0001",
"vattype": 1,
"list": [
{
"productid": 2345,
"sku": "P0001",
"name": "Product 1",
"number": 1,
"pricepernumber": 100,
"discount": null,
"totalprice": 100
},
{
"productid": 4567,
"sku": "P0002",
"name": "Product 2",
"number": 1,
"pricepernumber": 50,
"discount": null,
"totalprice": 50
}
],
"discount": null,
"vatamount": null,
"amount": 150,
"paymentamount": 150,
"paymentstatus": "Paid",
"status": "Success",
"referenceid": 2345
}
UPDATERETURNORDER
POST
{Your Endpoint URL}
Send request when a return order is modified or a return order status is changed.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "CN-0001",
"returnorderdate": "/Date(1644944400000)/",
"returnorderdateString": "2022-02-16",
"customerid": 123,
"customername": "Customer Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"description": null,
"reference": "SO-0001",
"vattype": 1,
"list": [
{
"productid": 2345,
"sku": "P0001",
"name": "Product 1",
"number": 1,
"pricepernumber": 100,
"discount": null,
"totalprice": 100
},
{
"productid": 4567,
"sku": "P0002",
"name": "Product 2",
"number": 1,
"pricepernumber": 50,
"discount": null,
"totalprice": 50
}
],
"discount": null,
"vatamount": null,
"amount": 150,
"paymentamount": 150,
"paymentstatus": "Paid",
"status": "Success",
"referenceid": 2345
}
UPDATERETURNORDERPAYMENT
POST
{Your Endpoint URL}
Send request when payments in return order is changed.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "CN-0001",
"returnorderdate": "/Date(1644944400000)/",
"returnorderdateString": "2022-02-16",
"customerid": 123,
"customername": "Customer Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"description": null,
"reference": "SO-0001",
"vattype": 1,
"list": [
{
"productid": 2345,
"sku": "P0001",
"name": "Product 1",
"number": 1,
"pricepernumber": 100,
"discount": null,
"totalprice": 100
},
{
"productid": 4567,
"sku": "P0002",
"name": "Product 2",
"number": 1,
"pricepernumber": 50,
"discount": null,
"totalprice": 50
}
],
"discount": null,
"vatamount": null,
"amount": 150,
"paymentamount": 150,
"paymentstatus": "Paid",
"status": "Success",
"referenceid": 2345
}
DELETERETURNORDER
POST
{Your Endpoint URL}
Send request when an return order is deleted.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "CN-0001"
}
Return Purchase Order Trigger
ADDRETURNPURCHASEORDER
POST
{Your Endpoint URL}
Send request when a return purchase is created.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "DN-0001",
"returnpurchaseorderdate": "/Date(1644944400000)/",
"returnpurchaseorderdateString": "2022-02-16",
"customerid": 123,
"customername": "Contact Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"description": null,
"reference": "PO-0001",
"vattype": 1,
"list": [
{
"productid": 2345,
"sku": "P0001",
"name": "Product 1",
"number": 1,
"pricepernumber": 100,
"discount": null,
"totalprice": 100
},
{
"productid": 4567,
"sku": "P0002",
"name": "Product 2",
"number": 1,
"pricepernumber": 50,
"discount": null,
"totalprice": 50
}
],
"discount": null,
"vatamount": null,
"amount": 150,
"paymentamount": 150,
"paymentstatus": "Paid",
"status": "Success",
"referenceid": 2345
}
UPDATERETURNPURCHASEORDER
POST
{Your Endpoint URL}
Send request when a return purchase is modified or a return purchase status is changed.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "DN-0001",
"returnpurchaseorderdate": "/Date(1644944400000)/",
"returnpurchaseorderdateString": "2022-02-16",
"customerid": 123,
"customername": "Contact Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"description": null,
"reference": "PO-0001",
"vattype": 1,
"list": [
{
"productid": 2345,
"sku": "P0001",
"name": "Product 1",
"number": 1,
"pricepernumber": 100,
"discount": null,
"totalprice": 100
},
{
"productid": 4567,
"sku": "P0002",
"name": "Product 2",
"number": 1,
"pricepernumber": 50,
"discount": null,
"totalprice": 50
}
],
"discount": null,
"vatamount": null,
"amount": 150,
"paymentamount": 150,
"paymentstatus": "Paid",
"status": "Success",
"referenceid": 2345
}
UPDATERETURNPURCHASEORDERPAYMENT
POST
{Your Endpoint URL}
Send request when payments in return purchase is changed.
Query Parameters
Request Body
200: OK
Ex. Payload JSON
Copy {
"id": 1234,
"number": "DN-0001",
"returnpurchaseorderdate": "/Date(1644944400000)/",
"returnpurchaseorderdateString": "2022-02-16",
"customerid": 123,
"customername": "Contact Name",
"customeridnumber": null,
"customerphone": null,
"customeremail": null,
"customeraddress": null,
"description": null,
"reference": "PO-0001",
"vattype": 1,
"list": [
{
"productid": 2345,