Order
Get Orders
GET https://api.zortout.com/api.aspx
Get list of orders.
Query Parameters
method*
String
“GETORDERS”
warehousecode
String
Warehouse Code
topaymentamount
Double
Maximum payment amount
frompaymentamount
Double
Minimum payment amount
toamount
Double
Maximum amount
fromamount
Double
Minimum amount
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)
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)
orderdatebefore
String
Order Date Before ..... (yyyy-MM-dd)
orderdateafter
String
Order Date After ..... (yyyy-MM-dd)
version*
String
3
format
String
json (Default), xml
saleschannel
String
Sales channel
expirylot
Int
Show expiry lot status 0 - No (Default) 1 - Yes
serialno
Int
Show serial no status 0 - No (Default) 1 - Yes
paymentstatus
String
Payment status 0 - Pending 1 - Paid 2 - Voided 3 - Partial 4 - Overpaid Ex. "0,1,3,4"
status
String
Status 0 - Pending 1 - Success 2 - Voided 3 - Waiting Ex. "0,1,3,4"
createusername
String
Created by (Username)
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 Order Number Ex. “SO-001,SO-002,SO-003”
orderidlist
String
List Of Order ID Ex. “123,124,125”
apisecret*
String
API Secret
apikey*
String
API Key
Get Order Detail
GET https://api.zortout.com/api.aspx
Get order detail.
Query Parameters
method*
String
“GETORDERDETAIL”
version*
String
3
format
String
json (Default), xml
id*
Int
Order ID
Headers
storename*
String
Store Name
apisecret*
String
API Secret
apikey*
String
API Key
Get Voucher Detail
GET https://api.zortout.com/api.aspx
Get list of voucher subsidized by Marketplace.
Query Parameters
method*
String
“GETVOUCHERDETAIL”
id*
Int
Order ID
version*
String
3
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Get Expense Order Detail
GET https://api.zortout.com/api.aspx
Get list of expenses of order.
Query Parameters
method*
String
“GETEXPENSEORDERDETAIL”
id*
Int
Order ID
version*
String
3
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Get Movement Order Detail
GET https://api.zortout.com/api.aspx
Get movement list of products according to each order.
Query Parameters
method*
String
““GETMOVEMENTORDERDETAIL”
id*
Int
Order ID
version*
String
3
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Get Movement Orders
GET https://api.zortout.com/api.aspx
Get movement list of products for orders.
Query Parameters
method*
String
“GETMOVEMENTORDERS”
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
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Get Shipment Labels
GET https://api.zortout.com/api.aspx
Get shipment label list of orders.
Query Parameters
method*
String
"GETSHIPMENTLABELS"
version*
String
3
format
String
json (Default), xml
Headers
storename*
String
Store Name
orderidlist
String
List Of Order ID Ex. “123,124,125”
apisecret*
String
API Secret
apikey*
String
API Key
numberlist
String
List Of Order Number Ex. “SO-001,SO-002,SO-003”
Add Order
POST https://api.zortout.com/api.aspx
Add order.
Query Parameters
method*
String
“ADDORDER”
link
Int
Link to generate.
0 – None (Default) 1 – Share link
uniquenumber
String
Unique Number.
This value is unique and used to prevent duplicate transaction.
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
Order Number
vatamount
Double
Vat Amount
amount*
Double
Net Amount
status
String
Status (Pending,Success) Default - Pending
reference
String
Reference
customeraddress
String
Customer Address
customerphone
String
Customer Phone
customeremail
String
Customer Email
customeridnumber
String
Customer ID Number/Tax ID
customername
String
Customer Name
shippingaddress
String
Shipping Address
shippingname
String
Shipping Name
shippingdate
String
Shipping Date
Ex. “2021-09-15”
shippingvat
Int
Shipping Vat Status 0 - No Shipping Vat (Default) 1 – Have Shipping Vat
shippingamount
Double
Shipping Amount
shippingchannel
String
Shipping Channel
trackingno
String
Tracking No
shippingemail
String
Shipping Email
shippingphone
String
Shipping Phone
paymentamount
Double
Payment Amount
("paymentmethod" must be required.)
paymentmethod
String
Payment Method
orderdate
String
Order Date Ex. "2021-09-15"
∟ sku*
String
Product Sku
list
OrderProduct (Array)
Product List
warehousecode
String
Warehouse Code
saleschannel
String
Sales Channel
discount
String
Discount Ex. 5.00, 10%
description
String
Description
paymentdate
String
Payment Datetime Ex. “2021-09-15 21:05”
∟ totalprice*
Double
Total Price
∟ discount
String
Discount Per Unit
∟ pricepernumber*
Double
Product Price/Quantity
∟ name*
String
Product Name
∟ number*
Double
Product Quantity
tag
String (Array)
Tag List (Array)
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.
isCOD
Boolean
COD Status
customerbranchname
String
Customer Branch Name
customerbranchno
String
Customer Branch No
customercode
String
Customer Code
agent
Agent
Agent Detail
∟ name
String
Agent Name
∟ phone
String
Agent Phone
String
Agent Email
∟ address
String
Agent Address
expiredate
String
Expired Date Ex. "2021-09-15"
properties
Property (Array)
Custom Properties List
∟ id
Int
Property ID
*Must have either id or name
∟ value
String
Property Value
∟ name
String
Property Name Require if id = 0 or null
*Must have either id or name
Update Order Status
POST https://api.zortout.com/api.aspx
Update status of order.
Query Parameters
method*
String
“UPDATEORDERSTATUS”
status
Int
1 = Success (Default) 3 = Waiting 6 = Shipping
warehousecode
String
Warehouse Code
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Update Order Payment
POST https://api.zortout.com/api.aspx
Update payment of order.
Query Parameters
method*
String
“UPDATEORDERPAYMENT”
verifyslipid
Int
Verify Slip ID
paymentdate
String
Payment Datetime Ex. “2021-09-15 21:05”
paymentamount*
Double
Payment Amount
paymentmethod*
String
Payment Method
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Verify Slip
POST https://api.zortout.com/api.aspx
Verify slip of order.
Path Parameters
method*
String
“VERIFYORDERSLIP”
id
Int
Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
filename*
String
File Name
number
String
Order Number Require if id = 0 or null
*Must have either id or number
Query Parameters
method*
String
“VERIFYORDERSLIP”
filename*
String
File Name
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
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
Request Body
file*
File
File Binary Data
Update Partial Order
POST https://api.zortout.com/api.aspx
Update partial product of order.
Query Parameters
method*
String
"UPDATEPARTIALORDER"
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
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
Request Body
OrderProduct (Array)
Product List
∟ productid
Int
Product ID
*Must have either productid or sku
∟ sku
String
Product Sku Require if productid = 0 or null
*Must have either productid or sku
∟ number*
Double
Product Quantity
Edit Order Info
POST https://api.zortout.com/api.aspx
Edit order info.
Query Parameters
method*
String
“EDITORDERINFO”
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Request Body
number
String
Order Number
trackingno
String
Tracking No
shippingemail
String
Shipping Email
shippingphone
String
Shipping Phone
shippingaddress
String
Shipping Address
shippingname
String
Shipping Name
shippingdate
String
Shipping Date
Ex. “2021-09-15”
shippingchannel
String
Shipping Channel
customeraddress
String
Customer Address
customerphone
String
Customer Phone
customeremail
String
Customer Email
customeridnumber
String
Customer ID Number/Tax ID
customername
String
Customer Name
orderdate
String
Order Date Ex. “2021-09-15”
tag
String (Array)
Tag List (Array)
saleschannel
String
Sales Channel
description
String
Description
customercode
String
Customer Code
customerbranchno
String
Customer Branch No
customerbranchname
String
Customer Branch Name
agent
Agent
Agent Detail
String
Agent Email
∟ phone
String
Agent Phone
∟ name
String
Agent Name
∟ address
String
Agent Address
expiredate
String
Expired Date Ex. “2021-09-15”
reference
String
Reference
Edit Order
POST https://api.zortout.com/api.aspx
Edit order.
Query Parameters
method*
String
“EDITORDER”
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
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
Request Body
number
String
Order Number
shippingname
String
Shipping Name
shippingdate
String
Shipping Date
Ex. “2021-09-15”
shippingchannel
String
Shipping Channel
customerbranchno
String
Customer Branch No
customerbranchname
String
Customer Branch Name
customeraddress
String
Customer Address
customerphone
String
Customer Phone
customeremail
String
Customer Email
customeridnumber
String
Customer ID Number/Tax ID
customername
String
Customer Name
customercode
String
Customer Code
saleschannel
String
Sales Channel
description
String
Description
reference
String
Reference
expiredate
String
Expired Date Ex. “2021-09-15”
orderdate
String
Order Date Ex. “2021-09-15”
trackingno
String
Tracking No
shippingemail
String
Shipping Email
shippingphone
String
Shipping Phone
shippingaddress
String
Shipping Address
∟ address
String
Agent Address
String
Agent Email
∟ phone
String
Agent Phone
∟ name
String
Agent Name
agent
Agent
Agent Detail
tag
String (Array)
Tag List (Array)
discount
String
Discount Ex. 5.00, 10%
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.
vatamount
Double
Vat Amount
amount*
Double
Net Amount
∟ number*
Double
Product Quantity
∟ name*
String
Product Name
∟ sku*
String
Product Sku
list
OrderProduct (Array)
Product List
∟ totalprice*
Double
Total Price
∟ discount
String
Discount Per Unit
∟ pricepernumber*
Double
Product Price/Quantity
Void Order
POST https://api.zortout.com/api.aspx
Void order.
Query Parameters
method*
String
“VOIDORDER”
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Void Order Payment
POST https://api.zortout.com/api.aspx
Delete payment in order.
Query Parameters
method*
String
“VOIDORDERPAYMENT”
paymentid*
Int
Payment ID
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
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
Ready To Ship
POST https://api.zortout.com/api.aspx
Ready to ship. The status will be changed to “Waiting”. If the order is from marketplace, the system will try to update order in marketplace to “Ready to ship”.
Query Parameters
method*
String
“READYTOSHIP”
booking
Int
Booking Request Status
0 - None (Default)
1 - Call shipment provider. The available shipment is “flashexpress” (Flash Express), “jtexpress” (J&T) and “kerry” (Kerry). Support only non-marketplace order.
pickuptime
String
Shopee pickup datetime keyword for pickup. Not Required for Shopee Pickup.
If this is blank, the system will choose earliest time. Ex. 18-06-2020
address
String
Pickup location keyword for pickup. Required if the shipment is Shopee Pickup. Ex. "10420" - Postcode of pickup location.
trackingno
String
Tracking No.
Not require if shipment by marketplace.
shipment*
String
Shipment provider. This is shipping channel, if the order is non-marketplace. If this order is from marketplace, please specify marketplace shipment. Ex. Shopee - "pickup" or "dropoff" Lazada - "lex" or default shipping channel of order. If in order doesn't have shipping channel please use "lex". Tiktok Shop- "pickup" or "dropoff"
warehousecode
String
Warehouse Code
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Book Order Shipment
POST https://api.zortout.com/api.aspx
Call shipment provider. The available shipment is “flashexpress” (Flash Express), “jtexpress” (J&T) and “kerry” (Kerry). The status will be changed to “Waiting”. Support only non- marketplace order.
Query Parameters
method*
String
“BOOKORDERSHIPMENT”
shipment*
String
Shipment provider. flashexpress – Flash Express jtexpress – J&T kerry – Kerry
shopeeexpress – Shopee Express
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Update Order Serial No
POST https://api.zortout.com/api.aspx
Update serial number of order.
Query Parameters
method*
String
“UPDATEORDERSERIALNO”
serialno*
String
Serial Number
sku
String
Product Sku Require if productid = 0 or null
*Must have either productid or sku
productid
Int
Product ID
*Must have either productid or sku
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Update Order Expiry/Lot
POST https://api.zortout.com/api.aspx
Update expiry/lot of order.
Query Parameters
method*
String
“UPDATEORDEREXPIRYLOT”
lotnumber*
Double
Lot Number
lot*
String
Lot Name
sku
String
Product Sku Require if productid = 0 or null
*Must have either productid or sku
productid
Int
Product ID
*Must have either productid or sku
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
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
Add Expense Order
POST https://api.zortout.com/api.aspx
Add expense to order.
Query Parameters
method*
String
“ADDEXPENSEWITHORDER”
id*
Int
Order ID
version*
String
3
format
String
json (Default), xml
Headers
storename
String
Store Name
apikey
String
API Key
apisecret
String
API Secret
Request Body
name*
String
Expense Name
paymentname*
String
Payment Method
amount*
Double
Amount
isvat
Int
Vat Status 0 - No Vat (Default)
1 - Include Vat
Add Order Tag
POST https://api.zortout.com/api.aspx
Add tag to order.
Query Parameters
method*
String
“ADDORDERTAG”
tag*
String
Tag
number
String
Order Number Require if id = 0 or null
*Must have either id or number
id
Int
Order ID
*Must have either id or number
version*
String
3
format
String
json (Default), xml
Headers
apisecret*
String
API Secret
storename*
String
Store Name
apikey*
String
API Key
Last updated