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.

1. Login to ZORT.

2. Go to menu Setting --> Integration --> API Reference --> Webhook.

3. 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://api.zortout.com/api.aspx

Update webhook information.

Query Parameters

Name	Type	Description
method*	String	"UPDATEWEBHOOK"
format	String	json (Default), xml
version*	String	3

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.

200: OK Success

Response

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://api.zortout.com/api.aspx

Get webhook information.

Query Parameters

Name	Type	Description
method*	String	"GETWEBHOOK"
format	String	json (Default), xml
version*	String	json (Default), xml

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

200: OK Success

Response

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.

Trigger

Product 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.

200: OK

Ex. Payload JSON

{
  "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

Name	Type	Description
method*	String	UPDATEPRODUCT

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "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

Name	Type	Description
method*	String	UPDATEPRODUCTQUANTITY

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "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

Name	Type	Description
method*	String	DELETEPRODUCT

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "id": 1234,
  "sku": "P0001"
}

Order Trigger

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.

200: OK

Ex. Payload JSON

{
  "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

Name	Type	Description
method*	String	UPDATEORDER

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "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

Name	Type	Description
method*	String	UPDATEORDERPAYMENT
id*	Int	Order ID
number*	String	Order Number
paymentstatus*	String	Payment Status (Pending, Paid, Partial Payment, Excess Payment)

200: OK

Ex. Payload JSON

{
  "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

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.

200: OK

Ex. Payload JSON

[
  {
    "trackingno": "THP0001",
    "trackingurl": "",
    "shippingdate": null
  }
]

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.

200: OK

Ex. Payload JSON

{
  "id": 1234,
  "number": "SO-0001"
}

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.

200: OK

Ex. Payload JSON

{
  "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

Name	Type	Description
method*	String	UPDATEPURCHASEORDER

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "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

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.

200: OK

Ex. Payload JSON

{
  "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

Name	Type	Description
method*	String	DELETEPURCHASEORDER

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "id": 1234,
  "number": "PO-0001"
}

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.

200: OK

Ex. Payload JSON

{
  "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

Name	Type	Description
method*	String	UPDATERETURNORDER

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "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

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.

200: OK

Ex. Payload JSON

{
  "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

Name	Type	Description
method*	String	DELETERETURNORDER

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "id": 1234,
  "number": "CN-0001"
}

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.

200: OK

Ex. Payload JSON

{
  "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

Name	Type	Description
method*	String	UPDATERETURNPURCHASEORDER

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "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

Name	Type	Description
method*	String	UPDATERETURNPURCHASEORDERPAYMENT
id*	Int	ReturnPurchaseOrder ID
number*	String	ReturnPurchaseOrder 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.

200: OK

Ex. Payload JSON

{
  "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
}

DELETERETURNPURCHASEORDER

POST {Your Endpoint URL}

Send request when an return purchase is deleted.

Query Parameters

Name	Type	Description
method*	String	DELETERETURNPURCHASEORDER

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "id": 1234,
  "number": "DO-0001"
}

Transfer

ADDTRANSFER

POST {Your Endpoint URL}

Send request when a transfer is created.

Query Parameters

Name	Type	Description
method*	String	ADDTRANSFER

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "id": 1234,
  "number": "TF-0001",
  "status": "Success",
  "transferdate": "2021-01- 25",
  "fromwarehousecode": "W0001",
  "towarehousecode": "W0002",
  "list": [
    {
      "sku": "P0001",
      "name": "Product1",
      "number": "5"
    },
    {
      "sku": "P0002",
      "name": "Product2",
      "number": "3"
    }
  ]
}

UPDATETRANSFER

POST {Your Endpoint URL}

Send request when a transfer is modified or a transfer status is changed.

Query Parameters

Name	Type	Description
method*	String	UPDATETRANSFER

Request Body

Name	Type	Description
payload*	String	Payload (JSON format) See detail in Ex. Payload JSON.

200: OK

Ex. Payload JSON

{
  "id": 1234,
  "number": "TF-0001",
  "status": "Success",
  "transferdate": "2021-01- 25",
  "fromwarehousecode": "W0001",
  "towarehousecode": "W0002",
  "list": [
    {
      "sku": "P0001",
      "name": "Product1",
      "number": "5"
    },
    {
      "sku": "P0002",
      "name": "Product2",
      "number": "3"
    }
  ]
}