Return Purchase Order

Get Return Purchase Orders

GET https://open-api.zortout.com/v4/ReturnPurchaseOrder/GetReturnPurchaseOrders

Get list of return purchase orders.

Query Parameters

Name	Type	Description
returnpurchaseorderdateafter	String	Return Purchase Order Date After ..... (yyyy-MM-dd)
returnpurchaseorderdatebefore	String	Return Purchase Order Date Before ..... (yyyy-MM-dd)
topaymentamount	Double	Maximum payment amount
frompaymentamount	Double	Minimum payment amount
toamount	Double	Maximum amount
fromamount	Double	Minimum amount
updatedatetimeafter	String	Updated Datetime After ..... (yyyy-MM-dd HH:mm)
updatedatetimebefore	String	Updated Datetime Before ..... (yyyy-MM-dd HH:mm)
createdatetimeafter	String	Created Datetime After ..... (yyyy-MM-dd HH:mm)
createdatetimebefore	String	Created Datetime Before ..... (yyyy-MM-dd HH:mm)
paymentafter	String	Paid Date After ..... (yyyy-MM-dd)
paymentbefore	String	Paid Date Before ..... (yyyy-MM-dd)
updatedafter	String	Updated Date After ..... (yyyy-MM-dd)
updatedbefore	String	Updated Date Before ..... (yyyy-MM-dd)
createdafter	String	Created Date After ..... (yyyy-MM-dd)
createdbefore	String	Created Date Before ..... (yyyy-MM-dd)
limit	Int	Limit per page (Max = 500)
page	Int	Page (Default = 1)
keyword	String	Keyword to search
createusername	String	Created by (Username)
warehousecode	String	Warehouse Code

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret
returnpurchaseorderidlist	String	List Of Return Purchase Order ID Ex. “123,124,125”
numberlist	String	List Of Return Purchase Order Number Ex. “DN-001,DN-002,DN-003”

200: OK Success

Response

Parameter	Type	Description/Example
res	Response	Response Code 200- Success
list	ReturnPurchaseOrder (Array)	Return Purchase Order List (Array)
count	Int	Total return purchase order number by filter

ReturnPurchaseOrder (Array)	Type	Description/Example
id	Int	Return Purchase Order ID
number	String	Return Purchase Order Number
customerid	Int	Contact ID
customercode	String	Contact Code
customername	String	Contact Name
customeridnumber	String	Contact ID Number/Tax ID
customeremail	String	Contact Email
customerphone	String	Contact Phone
customeraddress	String	Contact Address
customerbranchname	String	Contact Branch Name
customerbranchno	String	Contact Branch No
status	String	Status (Pending, Waiting, Shipping, Success, Partial Transfer, Voided)
paymentstatus	String	Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount	Double	Net Amount
amount_pretax		Pretax Amount
vatamount	Double	Vat Amount
shippingamount	Double	Shipping Amount
shippingamount_pretax	Double	Pretax Shipping Amount
shippingamount_vat	Double	Shipping Vat Amount
shippingvat	Int	Shipping Vat Status 0 - No Shipping Vat 1 - Have Shipping Vat
returnpurchaseorderdate	Date	Return Purchase Order Date
returnpurchaseorderdateString	String	Return Purchase Order Date Text (yyyy-MM-dd)
paymentamount	Double	Payment Amount
reference	String	Reference
description	String	Description
discount	String	Discount Ex.5.00, 10%
discountamount	Double	Total summary of return purchase order discount.
discountamount_pretax	Double	Total summary of pretax return purchase order discount.
discountamount_vat	Double	Total summary of return purchase order vat.
vattype	Int	Vat Type 1 – No Vat (Default) 2 – Exclude Vat 3 – Include Vat
warehousecode	String	Warehouse Code
list	ReturnPurchaseOrderProduct (Array)	Product List
payments	Payment (Array)	Payment List
tag	String (Array)	Tag List (Array)
createdatetime	Datetime	Created Datetime
createdatetimeString	String	Created Datetime Text (yyyy-MM-dd HH:mm)
updatedatetime	Datetime	Updated Datetime
updatedatetimeString	String	Updated Datetime Text (yyyy-MM-dd HH:mm)
createuserid	Int	Created User ID
createusername	String	Created User (Username)
createdby	String	Created User (Display name)
referenceid	Int	Reference Purchase Order ID
referencenumber	String	Reference Purchase Order Number

ReturnPurchaseOrderProduct (Array)	Type	Description/Example
productid	Int	Product ID
sku	String	Product Sku
name	String	Product Name
number	Double	Product Quantity
unittext	String	Unit
pricepernumber	Double	Product Price/Quantity
pricepernumber_pretax	Double	Pretax Product Price/Quantity
pricepernumber_vat	Double	Product Vat/Quantity
discount	String	Discount Per Unit
discountamount	Double	Total discount of product line.
discountamount_pretax	Double	Total pretax discount of product line.
discountamount_vat	Double	Total discount vat of product line.
totalprice	Double	Total Price
totalprice_pretax	Double	Pretax Total Price
totalprice_vat	Double	Total Vat

Payment (Array)	Type	Description/Example
id	Int	Payment ID
name	String	Payment Method Name
amount	Double	Payment Amount
paymentdatetime	Datetime	Payment Datetime
paymentdatetimeString	String	Payment Datetime Text (yyyy-MM-dd HH:mm)

Get Return Purchase Order Detail

GET https://open-api.zortout.com/v4/ReturnPurchaseOrder/GetReturnPurchaseOrderDetail

Get return purchase order detail.

Query Parameters

Name	Type	Description
id*	Int	Return Purchase Order ID

Headers

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

200: OK Success

Response

Parameter	Type	Description/Example
id	Int	Return Purchase Order ID
number	String	Return Purchase Order Number
customerid	Int	Contact ID
customercode	String	Contact Code
customername	String	Contact Name
customeridnumber	String	Contact ID Number/Tax ID
customeremail	String	Contact Email
customerphone	String	Contact Phone
customeraddress	String	Contact Address
customerbranchname	String	Contact Branch Name
customerbranchno	String	Contact Branch No
status	String	Status (Pending, Waiting, Shipping, Success, Partial Transfer, Voided)
paymentstatus	String	Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount	Double	Net Amount
amount_pretax		Pretax Amount
vatamount	Double	Vat Amount
shippingamount	Double	Shipping Amount
shippingamount_pretax	Double	Pretax Shipping Amount
shippingamount_vat	Double	Shipping Vat Amount
shippingvat	Int	Shipping Vat Status 0 - No Shipping Vat 1 - Have Shipping Vat
returnpurchaseorderdate	Date	Return Purchase Order Date
returnpurchaseorderdateString	String	Return Purchase Order Date Text (yyyy-MM-dd)
paymentamount	Double	Payment Amount
reference	String	Reference
description	String	Description
discount	String	Discount Ex.5.00, 10%
discountamount	Double	Total summary of return purchase order discount.
discountamount_pretax	Double	Total summary of pretax return purchase order discount.
discountamount_vat	Double	Total summary of return purchase order vat.
vattype	Int	Vat Type 1 – No Vat (Default) 2 – Exclude Vat 3 – Include Vat
warehousecode	String	Warehouse Code
list	ReturnPurchaseOrderProduct (Array)	Product List
payments	Payment (Array)	Payment List
tag	String (Array)	Tag List (Array)
createdatetime	Datetime	Created Datetime
createdatetime String	String	Created Datetime Text (yyyy-MM-dd HH:mm)
updatedatetime	Datetime	Updated Datetime
updatedatetimeString	String	Updated Datetime Text (yyyy-MM-dd HH:mm)
createuserid	Int	Created User ID
createusername	String	Created User (Username)
createdby	String	Created User (Display name)
referenceid	Int	Reference Purchase Order ID
referencenumber	String	Reference Purchase Order Number

ReturnPurchaseOrderProduct (Array)	Type	Description/Example
productid	Int	Product ID
sku	String	Product Sku
name	String	Product Name
number	Double	Product Quantity
unittext	String	Unit
pricepernumber	Double	Product Price/Quantity
pricepernumber_pretax	Double	Pretax Product Price/Quantity
pricepernumber_vat	Double	Product Vat/Quantity
discount	String	Discount Per Unit
discountamount	Double	Total discount of product line.
discountamount_pretax	Double	Total pretax discount of product line.
discountamount_vat	Double	Total discount vat of product line.
totalprice	Double	Total Price
totalprice_pretax	Double	Pretax Total Price
totalprice_vat	Double	Total Vat

Payment (Array)	Type	Description/Example
id	Int	Payment ID
name	String	Payment Method Name
amount	Double	Payment Amount
paymentdatetime	Datetime	Payment Datetime
paymentdatetimeString	String	Payment Datetime Text (yyyy-MM-dd HH:mm)

Get Movement Return Purchase Order Detail

GET https://open-api.zortout.com/v4/ReturnPurchaseOrder/GetMovementReturnPurchaseOrderDetail

Get movement list of products according to each return purchase order.

Query Parameters

Name	Type	Description
id*	Int	Return Purchase Order ID

Headers

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

200: OK Success

Response

MovementReturnPurchaseOrder (Array)	Type	Description/Example
id	Int	ID
list	ReturnPurchaseOrderProduct (Array)	Movement List
actionDate	Date (Array)	List of action date
actionDateString	String (Array)	List of action date text (yyyy-MM-dd)
returnpurchaseorderid	Int	Return Purchase Order ID

ReturnPurchaseOrderProduct (Array)	Type	Description/Example
productid	Int	Product ID
sku	String	Product Sku
name	String	Product Name
number	Double	Product Quantity
unittext	String	Unit
pricepernumber	Double	Product Price/Quantity
discount	String	Discount Per Unit
totalprice	Double	Total Price

Get Movement Return Purchase Orders

GET https://open-api.zortout.com/v4/ReturnPurchaseOrder/GetMovementReturnPurchaseOrders

Get movement list of products for return purchase orders.

Query Parameters

Name	Type	Description
dateafter*	String	Date After ..... (yyyy-MM-dd)
limit	Int	Limit per page (Max = 500)
page	Int	Page (Default = 1)
warehousecode	String	Warehouse Code
datebefore*	String	Date Before ..... (yyyy-MM-dd)

Headers

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

200: OK Success

Response

Parameter	Type	Description/Example
res	Response	Response Code 200- Success
list	MovementReturnPurchaseOrder (Array)	Movement Return Purchase Order List (Array)
count	Int	Total movement order number by filter

MovementReturnPurchaseOrder (Array)	Type	Description/Example
id	Int	ID
list	ReturnPurchaseOrderProduct (Array)	Movement List
actionDate	Date (Array)	List of action date
actionDateString	String (Array)	List of action date text (yyyy-MM-dd)
returnpurchaseorderid	Int	Return Purchase Order ID

ReturnPurchaseOrderProduct (Array)	Type	Description/Example
productid	Int	Product ID
sku	String	Product Sku
name	String	Product Name
number	Double	Product Quantity
unittext	String	Unit
pricepernumber	Double	Product Price/Quantity
discount	String	Discount Per Unit
totalprice	Double	Total Price

Add Return Purchase Order

POST https://open-api.zortout.com/v4/ReturnPurchaseOrder/AddReturnPurchaseOrder

Add return purchase order.

Headers

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

Request Body

Name	Type	Description
number*	String	Return Purchase Order Number
vatamount	Double	Vat Amount
amount*	Double	Net Amount
status	String	Status (Pending,Success) Default - Pending
reference	String	Reference
customeraddress	String	Contact Address
customerphone	String	Contact Phone
customeremail	String	Contact Email
customeridnumber	String	Contact ID Number/Tax ID
customername	String	Contact Name
returnpurchaseorderdate	String	Return Purchase Order Date Ex. “2021-09-15”
warehousecode	String	Warehouse Code
discount	String	Discount Ex. 5.00, 10%
description	String	Description
paymentamount	Double	Payment amount ("paymentmethod" must be required.)
paymentmethod	String	Payment Method
list	PurchaseOrderProduct (Array)	Product List
referenceid	Int	Reference Purchase Order ID
referencenumber	String	Reference Purchase Order Number
∟ totalprice*	Double	∟ Total Price
∟ discount	String	Discount Per Unit
∟ pricepernumber*	Double	Product Price/Quantity
∟ number*	Double	Product Quantity
∟ name*	String	Product Name
∟ sku*	String	Product Sku
customercode	String	Contact Code
customerbranchno	String	Contact Branch No
customerbranchname	String	Contact Branch Name
shippingvat	Int	Shipping Vat Status 0 - No Shipping Vat (Default) 1 – Have Shipping Vat
shippingamount	Double	Shipping Amount
vattype	Int	Vat Type 1 – No Vat 2 – Exclude Vat 3 – Include Vat If vattype is not defined, the system will use vatamount to calculate and define automatically. If vattype = 1, 2 or 3, the system will ignore vatamount and calculate vatamount value automatically.

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description
detail	Detail	Detail

Detail	Type	Description/Example
id	Int	Return Purchase Order ID

Ex. Request JSON

{
   "number": "DN-0001",
   "customername": "Customer Name",
   "status": "Success",
   "amount": 105,
   "vatamount": 0,
   "returnpurchaseorderdate": "2021-05- 20",
   "paymentmethod": "KBANK",
   "paymentamount": 80,
   "list":[
      {
         "sku": "P0001",
         "name": "Product1",
         "number": 5,
         "pricepernumber": 20,
         "discount": "10%",
         "totalprice": 90
      },
      {
         "sku": "P0002",
         "name": "Product2",
         "number": 3,
         "pricepernumber": 10,
         "discount": "5",
         "totalprice": 15
      }
   ],
   "referencenumber": "SO-0001"
}

Update Return Purchase Order Status

POST https://open-api.zortout.com/v4/ReturnPurchaseOrder/UpdateReturnPurchaseOrderStatus

Update status of return purchase order.

Query Parameters

Name	Type	Description
id	Int	Return Purchase Order ID *Must have either id or number
number	String	Return Purchase Order Number Require if id = 0 or null *Must have either id or number
warehousecode	String	Warehouse Code

Headers

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

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Update Return Purchase Order Payment

POST https://open-api.zortout.com/v4/ReturnPurchaseOrder/UpdateReturnPurchaseOrderPayment

Update payment of return purchase order.

Query Parameters

Name	Type	Description
id	Int	Return Purchase Order ID *Must have either id or number
paymentdate	String	Payment Datetime Ex. “2021-09-15 21:05”
paymentamount*	Double	Payment Amount
paymentmethod*	String	Payment Method
number	String	Return Purchase Order Number Require if id = 0 or null *Must have either id or number

Headers

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

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Void Return Purchase Order

POST https://open-api.zortout.com/v4/ReturnPurchaseOrder/VoidReturnPurchaseOrder

Void return purchase order.

Path Parameters

Name	Type	Description
id	Int	Return Purchase Order ID *Must have either id or number
number	String	Return Purchase Order Number Require if id = 0 or null *Must have either id or number

Headers

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

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Void Return Purchase Order Payment

POST https://open-api.zortout.com/v4/ReturnPurchaseOrder/VoidReturnPurchaseOrderPayment

Delete payment in return purchase order.

Query Parameters

Name	Type	Description
id	Int	Return Purchase Order ID *Must have either id or number
number	String	Return Purchase Order Number Require if id = 0 or null *Must have either id or number

Headers

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

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Add Return Purchase Order Tag

POST https://open-api.zortout.com/v4/ReturnPurchaseOrder/AddReturnPurchaseOrderTag

Add tag to return purchase order.

Query Parameters

Name	Type	Description
id	Int	Return Purchase Order ID *Must have either id or number
tag*	String	Tag
number	String	Return Purchase Order Number Require if id = 0 or null *Must have either id or number

Headers

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

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Delete Return Purchase Order Tag

POST https://open-api.zortout.com/v4/ReturnPurchaseOrder/DeleteReturnPurchaseOrderTag

Delete tag of return purchase order.

Query Parameters

Name	Type	Description
id	Int	Return Purchase Order ID *Must have either id or number
tag*	String	Tag
number	String	Return Purchase Order Number Require if id = 0 or null *Must have either id or number

Headers

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

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description