Return Order
Get Return Orders
GET https://api.zortout.com/api.aspx
Get list of return orders.
Query Parameters
method*
String
“GETRETURNORDERS”
createdatetimeafter
String
Created Datetime After ….. (yyyy-MM-dd HH:mm)
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)
returnorderdatebefore
String
Return Order Date Before ….. (yyyy-MM-dd)
returnorderdateafter
String
Return 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)
topaymentamount
Double
Maximum payment amount
frompaymentamount
Double
Minimum payment amount
toamount
Double
Maximum amount
fromamount
Double
Minimum amount
keyword
String
Keyword to search
createusername
String
Created by (Username)
warehousecode
String
Warehouse Code
limit
Int
Limit per page (Max = 2000)
page
Int
Page (Default = 1)
Headers
storename *
String
Store Name
apikey*
String
API Key
apisecret *
String
API Secret
numberlist
String
List Of Return Order Number Ex. “CN-001,CN-002,CN-003”
returnorderidlist
String
List Of Return Order ID Ex. “123,124,125”
Get Return Order Detail
GET https://api.zortout.com/api.aspx
Get return order detail
Query Parameters
method*
String
“GETRETURNORDERDETAIL”
id*
Int
Return 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 Order Detail
GET https://api.zortout.com/api.aspx
Get movement list of products according to each return order.
Query Parameters
method*
String
“GETMOVEMENTRETURNORDERDETAIL”
id*
Int
Return 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 Orders
GET https://api.zortout.com/api.aspx
Get movement list of products for return orders.
Query Parameters
method*
String
“GETMOVEMENTRETURNORDERS”
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
format
String
json (Default), xml
Headers
storename *
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
Add Return Order
POST https://api.zortout.com/api.aspx
Add return order.
Query Parameters
method*
String
“ADDRETURNORDER”
version*
String
3
format
String
json (Default), xml
Headers
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
Request Body
number*
String
Return Order Number
customername
String
Customer Name
customeraddress
String
Customer Address
customerphone
String
Customer Phone
customeremail
String
Customer Email
customeridnumber
String
Customer ID Number/Tax ID
paymentmethod
String
Payment Method
returnorderdate
String
Return Order Date
Ex. “2021-09-15”
vatamount
Double
Vat Amount
amount *
Double
Net Amount
status
String
Status(Pending,Success) Default – Pending
reference
String
Reference
paymentamount
Double
Payment Amount
("paymentmethod" must be required.)
∟ sku *
String
Product Sku
list
ReturnOrderProduct (Array)
Product List
warehousecode
String
Warehouse Code
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.
discount
String
Discount Ex.5.00, 10%
description
String
Description
∟ name *
String
Product Name
∟ number*
Double
Product Quantity
∟ totalprice *
Double
Total Price
∟ pricepernumber*
Double
Product Price/Quantity
∟ discount
String
Discount Per Unit
referencenumber
String
Reference Order Number
referenceid
Int
Reference Order ID
customercode
String
Customer Code
customerbranchno
String
Customer Branch No
customerbranchname
String
Customer Branch Name
shippingvat
Int
Shipping Vat Status 0 - No Shipping Vat (Default) 1 – Have Shipping Vat
shippingamount
Double
Shipping Amount
saleschannel
String
Sales Channel
Update Return Order Status
POST https://api.zortout.com/api.aspx
Update status of return order.
Query Parameters
method*
String
“UPDATERETURNORDERSTATUS”
warehousecode
String
Warehouse Code
number
String
Return Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Return 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
Update Return Order Payment
POST https://api.zortout.com/api.aspx
Update payment of return order.
Query Parameters
method*
String
“UPDATERETURNORDERPAYMENT”
paymentdate
String
Payment Datetime Ex. “2021-09-15 21:05”
paymentamount*
String
Payment Amount
paymentmethod*
String
Payment Method
number
String
Return Order Number Require if id = 0 or null
*Must have either id or number
id
String
Return Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
Headers
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
Void Return Order
POST https://api.zortout.com/api.aspx
Void return order.
Query Parameters
method*
String
“VOIDRETURNORDER”
number
String
Return Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Return 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 Order Payment
POST https://api.zortout.com/api.aspx
Delete payment in return order.
Query Parameters
method*
String
“VOIDRETURNORDERPAYMENT”
number
String
Return Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Return Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
paymentid*
Int
Payment ID
Headers
storename*
String
Store Name
apisecret*
String
API Secret
apikey*
String
API Key
Add Return Order Tag
POST https://api.zortout.com/api.aspx
Add tag to return order.
Query Parameters
method*
String
“ADDRETURNORDERTAG”
tag*
String
Tag
number
String
Return Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Return 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
Last updated