Return Purchase Order
Get Return Purchase Orders
GET https://api.zortout.com/api.aspx
Get list of return purchase orders.
Query Parameters
method*
String
“GETRETURNPURCHASEORDERS”
paymentbefore
String
Paid Date Before ..... (yyyy-MM-dd)
paymentafter
String
Paid Date After ..... (yyyy-MM-dd)
updatedbefore
String
Updated Date Before ..... (yyyy-MM-dd)
updatedafter
String
Updated Date After ..... (yyyy-MM-dd)
createdbefore
String
Created Date Before ..... (yyyy-MM-dd)
createdafter
String
Created Date After ..... (yyyy-MM-dd)
returnpurchaseorderdatebefore
String
Return Purchase Order Date Before ..... (yyyy-MM-dd)
returnpurchaseorderdateafter
String
Return Purchase Order Date After ..... (yyyy-MM-dd)
version*
String
3
format
String
json (Default), xml
updatedatetimebefore
String
Updated Datetime Before ..... (yyyy-MM-dd HH:mm)
updatedatetimeafter
String
Updated Datetime After ..... (yyyy-MM-dd HH:mm)
createdatetimebefore
String
Created Datetime Before ..... (yyyy-MM-dd HH:mm)
createdatetimeafter
String
Created Datetime After ..... (yyyy-MM-dd HH:mm)
createusername
String
Created by (Username)
warehousecode
String
Warehouse Code
topaymentamount
Double
Maximum payment amount
frompaymentamount
Double
Minimum payment amount
toamount
Double
Maximum amount
fromamount
Double
Minimum amount
limit
Int
Limit per page (Max = 2000)
page
Int
Page (Default = 1)
keyword
String
Keyword to search
Headers
storename*
String
Store Name
numberlist
String
List Of Return Purchase Order Number Ex. “DN-001,DN-002,DN-003”
returnpurchaseorderidlist
String
List Of Return Purchase Order ID Ex. “123,124,125”
apisecret*
String
API Secret
apikey*
String
API Key
Get Return Purchase Order Detail
GET https://api.zortout.com/api.aspx
Get return purchase order detail.
Query Parameters
method*
String
“GETRETURNPURCHASEORDERDETAIL”
id*
Int
Return Purchase Order ID
version*
String
3
format
String
json (Default), xml
Headers
storename*
String
Store Name
apisecret*
String
API Secret
apikey*
String
API Key
Get Movement Return Purchase Order Detail
GET https://api.zortout.com/api.aspx
Get movement list of products according to each return purchase order.
Query Parameters
method*
String
“GETMOVEMENTRETURNPURCHASEORDERDETAIL”
id
Int
Return Purchase Order ID
version*
String
3
format
String
json (Default), xml
Headers
storename*
String
Store Name
apisecret*
String
API Secret
apikey*
String
API Key
Get Movement Return Purchase Orders
GET https://api.zortout.com/api.aspx
Get movement list of products for return purchase orders.
Query Parameters
method*
String
“GETMOVEMENTRETURNPURCHASEORDERS”
format
String
json (Default), xml
limit
Int
Limit per page (Max = 2000)
page
Int
Page (Default = 1)
warehousecode
String
Warehouse Code
datebefore*
String
Date Before ..... (yyyy-MM-dd)
dateafter*
String
Date After ..... (yyyy-MM-dd)
version*
String
3
Headers
storename*
String
Store Name
apisecret*
String
API Secret
apikey*
String
API Key
Add Return Purchase Order
POST https://api.zortout.com/api.aspx
Add return purchase order.
Query Parameters
method*
String
“ADDRETURNPURCHASEORDER”
version*
String
3
format
String
json (Default), xml
Headers
storename*
String
Store Name
apisecret*
String
API Secret
apikey*
String
API Key
Request Body
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.
Update Return Purchase Order Status
POST https://api.zortout.com/api.aspx
Update status of return purchase order.
Query Parameters
id
Int
Return Purchase Order ID
*Must have either id or number
warehousecode
String
Warehouse Code
number
String
Return Purchase Order Number Require if id = 0 or null
*Must have either id or number
version*
String
3
format
String
json (Default), xml
method*
String
"UPDATERETURNPURCHASEORDERSTATUS"
Headers
storename*
String
Store Name
apisecret*
String
API Secret
apikey*
String
API Key
Update Return Purchase Order Payment
POST https://api.zortout.com/api.aspx
Update payment of return purchase order.
Query Parameters
method*
String
"UPDATERETURNPURCHASEORDERPAYMENT"
number
String
Return Purchase Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Return Purchase Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
paymentamount*
Double
Payment Amount
paymentmethod*
String
Payment Method
paymentdate
String
Payment Datetime Ex. “2021-09-15 21:05”
Headers
storename*
String
Store Name
apisecret*
String
API Secret
apikey*
String
API Key
Void Return Purchase Order
POST https://api.zortout.com/api.aspx
Void return purchase order.
Query Parameters
method*
String
"VOIDRETURNPURCHASEORDER"
number
String
Return Purchase Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Return Purchase Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
Headers
storename*
String
Store Name
apisecret*
String
API Secret
apikey*
String
API Key
Void Return Purchase Order Payment
POST https://api.zortout.com/api.aspx
Delete payment in return purchase order.
Query Parameters
method*
String
"VOIDRETURNPURCHASEORDERPAYMENT"
format
String
json (Default), xml
number
String
Return Purchase Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Return Purchase Order ID
*Must have either id or number
version*
String
3
Headers
apisecret*
String
API Secret
apikey*
String
API Key
storename*
String
Store Name
Add Return Purchase Order Tag
POST https://api.zortout.com/api.aspx
Add tag to return purchase order.
Query Parameters
method*
String
"ADDRETURNPURCHASEORDERTAG"
number
String
Return Purchase Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Return Purchase Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
tag*
String
Tag
Headers
apisecret*
String
API Secret
apikey*
String
API Key
storename*
String
Store Name
Last updated