Order

Get Orders

GET https://open-api.zortout.com/v4/Order/GetOrders

Get list of orders.

Query Parameters

Name	Type	Description
orderdateafter	String	Order Date After ..... (yyyy-MM-dd)
orderdatebefore	String	Order Date Before ..... (yyyy-MM-dd)
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)
serialno	Int	Show serial no status 0 - No (Default) 1 - Yes
paymentstatus	String	Payment status 0 - Pending 1 - Paid 2 - Voided 3 - Partial Payment 4 - Excess Payment Ex. "0,1,3,4"
status	String	Status 0 - Pending 1 - Success 2 - Voided 3 - Waiting 4 - Returned 5 - Packed 6 - Shipping 7 - Failed Shipment Ex. "0,1,3,4"
createusername	String	Created by (Username)
warehousecode	String	Warehouse Code
warehouseCodeList	String	Warehouse Code List Ex. "W0001,W0002"
topaymentamount	Double	Maximum payment amount
frompaymentamount	Double	Minimum payment amount
keyword	String	Keyword to search
saleschannel	String	Sales channel
expirylot	Int	Show expiry lot status 0 - No (Default) 1 - Yes
sortdirection	String	Sorting Type By id DESC - Descending (Default) ASC - Ascending
options	String	Optional features to include in the response. Use comma-separated values. Available options: returnorders : Return orders
limit	Int	Limit per page (Max = 500)
page	Int	Page (Default = 1)

Headers

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

Response

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

Order (Array)	Type	Description/Example
id	Int	Order ID
number	String	Order Number
customerid	Int	Customer ID
customercode	String	Customer Code
customername	String	Customer Name
customeridnumber	String	Customer ID Number/Tax ID
customeremail	String	Customer Email
customerphone	String	Customer Phone
customeraddress	String	Customer Address
customerbranchname	String	Customer Branch Name
customerbranchno	String	Customer Branch No
status	String	Status (Pending, Waiting, Returned, Packed, Shipping, Success, Partial Transfer, Voided, Failed Shipment)
paymentstatus	String	Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount	Double	Net Amount
amount_pretax		Pretax Amount
vatamount	Double	Vat Amount
shippingchannel	String	Shipping Channel
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
shippingdate	Date	Shipping Date
shippingdateString	String	Shipping Date Text (yyyy-MM-dd)
shippingname	String	Shipping Name
shippingaddress	String	Shipping Address
shippingphone	String	Shipping Phone
shippingemail	String	Shipping Email
trackingno	String	Tracking No
trackingList	TrackingNo (Array)	Tracking No List
orderdate	Date	Order Date
orderdateString	String	Order Date Text (yyyy-MM-dd)
paymentamount	Double	Payment Amount
reference	String	Reference
description	String	Description
discount	String	Discount. Discount includes sellerdiscount and platformdiscount. Ex.5.00, 10%
sellerdiscount	Double	Seller Discount
sellerdiscount_pretax	Double	Pretax Seller Discount
sellerdiscount_vat	Double	Seller Discount Vat
platformdiscount	Double	Platform Discount. This discount is subsidized from Marketplace for buyer. (Ex. Lazada, Shopee, Tiktok)
platformdiscount_pretax	Double	Pretax Platform Discount
platformdiscount_vat	Double	Platform Discount Vat
voucheramount	Double	Subsidized Amount from Marketplace for seller.
voucheramount_pretax	Double	Subsidized Pretax amount from Marketplace for seller.
voucheramount_vat	Double	Subsidized Vat amount from Marketplace for seller.
shippingVoucher	Double	Shipping Voucher Amount
shippingVoucher_pretax	Double	Pretax Shipping Voucher Amount
shippingVoucher_vat	Double	Shipping Voucher Vat
discountamount	Double	Total summary of order discount. (Include discount and voucheramount). discountamount = discount - voucheramount discountamount = sellerdiscount + platformdiscount - voucheramount
discountamount_pretax	Double	Total summary of pretax order discount.
discountamount_vat	Double	Total summary of order vat.
vattype	Int	Vat Type 1 – No Vat (Default) 2 – Exclude VAT 3 – Include VAT
saleschannel	String	Sales Channel
warehousecode	String	Warehouse Code
list	OrderProduct (Array)	Product List
totalproductamount	Double	Total Product Price of 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)
expiredate	Date	Expired Date
expiredateString	String	Expired Date Text (yyyy-MM-dd)
successDate	Date	The date that order was completed.
successDateString	String	The date text that order was completed. (yyyy-MM-dd)
receivedate	Date	The date that buyer receive order from Marketplace. (Only customized merchant)
receivedateString	String	The date text that buyer receive order from Marketplace. (Only customized merchant) (yyyy-MM-dd)
createuserid	Int	Created User ID
createusername	String	Created User (Username)
createdby	String	Created User (Display name)
isCOD	Boolean	COD Status
integrationName	String	Integration Channel Name (Only Order from Integrated Channel.)
integrationShop	String	Integration Shop Name (Only Order from Integrated Channel.)
integrationCustomerId	String	Integration Customer ID (Only Order from Integrated Channel - Shopee and Tiktok only)
integrationCustomer	String	Integration Customer User (Only Order from Integrated Channel - Shopee and Tiktok only)
agent	Agent	Agent Detail
uniquenumber	String	Unique Number
currency	String	Currency
properties	Property (Array)	Custom Properties List

OrderProduct (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
producttype	Int	Product Type 0 - Product (Default) 1 - Service
bundleid	Int (Nullable)	Bundle ID
bundleitemid	Int (Nullable)	ID of bundle group in product line.
bundlenumber	Double (Nullable)	Bundle Quantity
bundleCode	String	Bundle Code/Sku
bundleName	String	Bundle Name
integrationItemId	String	Item Id of Integration.
integrationVariantId	String	Variant Id of Integration.
vat_status	Int	Sell vat status 0 - Follow Vat Type in Order 1 - No Vat 2- Have Vat 3 - Vat 0%
serialnolist	SerialNo (Array)	Serial no List
expirylotlist	ExpiryLot (Array)	Expiry lot List

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)

SerialNo (Array)	Type	Description/Example
id	Int	Serial no ID
name	String	Serial no Name

ExpiryLot (Array)	Type	Description/Example
id	Int	Expiry lot ID
name	String	Expiry lot Name
number	Double	Expiry lot Quantity
expiryDate	Date	Expired Date

Agent	Type	Description/Example
id	Int	Agent ID
name	String	Agent Name
phone	String	Agent Phone
email	String	Agent Email
address	String	Agent Address

TrackingNo (Array)	Type	Description/Example
id	Int	Tracking No ID
trackingno	String	Tracking No
trackingurl	String	Tracking No Url
shippingdate	Date	Shipping Date
shippingchannel	String	Shipping Channel
status	String	Tracking No Status (Normal, Voided)

Property (Array)	Type	Description/Example
id	Int	Property ID
name	String	Property Name
value	String	Property Value

Get Order Detail

GET https://open-api.zortout.com/v4/Order/GetOrderDetail

Get order detail.

Query Parameters

Name	Type	Description
id*	Int	Order ID

Headers

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

Response

Parameter	Type	Description/Example
id	Int	Order ID
number	String	Order Number
customerid	Int	Customer ID
customercode	String	Customer Code
customername	String	Customer Name
customeridnumber	String	Customer ID Number/Tax ID
customeremail	String	Customer Email
customerphone	String	Customer Phone
customeraddress	String	Customer Address
customerbranchname	String	Customer Branch Name
customerbranchno	String	Customer Branch No
status	String	Status (Pending, Waiting, Returned, Packed, Shipping, Success, Partial Transfer, Voided, Failed Shipment)
paymentstatus	String	Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount	Double	Net Amount
amount_pretax		Pretax Amount
vatamount	Double	Vat Amount
shippingchannel	String	Shipping Channel
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
shippingdate	Date	Shipping Date
shippingdateString	String	Shipping Date Text (yyyy-MM-dd)
shippingname	String	Shipping Name
shippingaddress	String	Shipping Address
shippingphone	String	Shipping Phone
shippingemail	String	Shipping Email
trackingno	String	Tracking No
trackingList	TrackingNo (Array)	Tracking No List
orderdate	Date	Order Date
orderdateString	String	Order Date Text (yyyy-MM-dd)
paymentamount	Double	Payment Amount
reference	String	Reference
description	String	Description
discount	String	Discount. Discount includes sellerdiscount and platformdiscount. Ex.5.00, 10%
sellerdiscount	Double	Seller Discount
sellerdiscount_pretax	Double	Pretax Seller Discount
sellerdiscount_vat	Double	Seller Discount Vat
platformdiscount	Double	Platform Discount. This discount is subsidized from Marketplace for buyer. (Ex. Lazada, Shopee, Tiktok)
platformdiscount_pretax	Double	Pretax Platform Discount
platformdiscount_vat	Double	Platform Discount Vat
voucheramount	Double	Subsidized Amount from Marketplace for seller.
voucheramount_pretax	Double	Subsidized Pretax amount from Marketplace for seller.
voucheramount_vat	Double	Subsidized Vat amount from Marketplace for seller.
shippingVoucher	Double	Shipping Voucher Amount
shippingVoucher_pretax	Double	Pretax Shipping Voucher Amount
shippingVoucher_vat	Double	Shipping Voucher Vat
discountamount	Double	Total summary of order discount. (Include discount and voucheramount). discountamount = discount - voucheramount discountamount = sellerdiscount + platformdiscount - voucheramount
discountamount_pretax	Double	Total summary of pretax order discount.
discountamount_vat	Double	Total summary of order vat.
vattype	Int	Vat Type 1 – No Vat (Default) 2 – Exclude Vat 3 – Include Vat
saleschannel	String	Sales Channel
warehousecode	String	Warehouse Code
list	OrderProduct (Array)	Product List
totalproductamount	Double	Total Product Price of 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)
expiredate	Date	Expired Date
expiredateString	String	Expired Date Text (yyyy-MM-dd)
successDate	Date	The date that order was completed.
successDateString	String	The date text that order was completed. (yyyy-MM-dd)
receivedate	Date	The date that buyer receive order from Marketplace. (Only customized merchant)
receivedateString	String	The date text that buyer receive order from Marketplace. (Only customized merchant) (yyyy-MM-dd)
createuserid	Int	Created User ID
createusername	String	Created User (Username)
createdby	String	Created User (Display name)
isCOD	Boolean	COD Status
integrationName	String	Integration Channel Name (Only Order from Integrated Channel.)
integrationShop	String	Integration Shop Name (Only Order from Integrated Channel.)
integrationCustomerId	String	Integration Customer ID (Only Order from Integrated Channel - Shopee and Tiktok only)
integrationCustomer	String	Integration Custome User (Only Order from Integrated Channel - Shopee and Tiktok only)
agent	Agent	Agent Detail
uniquenumber	String	Unique Number
currency	String	Currency
properties	Property (Array)	Custom Properties List

OrderProduct (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
producttype	Int	Product Type 0 - Product (Default) 1 - Service
bundleid	Int (Nullable)	Bundle ID
bundleitemid	Int (Nullable)	ID of bundle group in product line.
bundlenumber	Double (Nullable)	Bundle Quantity
bundleCode	String	Bundle Code/Sku
bundleName	String	Bundle Name
integrationItemId	String	Item Id of Integration.
integrationVariantId	String	Variant Id of Integration.
vat_status	Int	Sell vat status 0 - Follow Vat Type in Order 1 - No Vat 2- Have Vat 3 - Vat 0%
serialnolist	SerialNo (Array)	Serial no List
expirylotlist	ExpiryLot (Array)	Expiry lot List

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)

SerialNo (Array)	Type	Description/Example
id	Int	Serial no ID
name	String	Serial no Name

ExpiryLot (Array)	Type	Description/Example
id	Int	Expiry lot ID
name	String	Expiry lot Name
number	Double	Expiry lot Quantity
expiryDate	Date	Expired Date

Agent	Type	Description/Example
id	Int	Agent ID
name	String	Agent Name
phone	String	Agent Phone
email	String	Agent Email
address	String	Agent Address

TrackingNo (Array)	Type	Description/Example
id	Int	Tracking No ID
trackingno	String	Tracking No
trackingurl	String	Tracking No Url
shippingdate	Date	Shipping Date
shippingchannel	String	Shipping Channel
status	String	Tracking No Status (Normal, Voided)

Property (Array)	Type	Description/Example
id	Int	Property ID
name	String	Property Name
value	String	Property Value

Get Voucher Detail

GET https://open-api.zortout.com/v4/Order/GetVoucherOrderDetail

Get list of voucher subsidized by Marketplace.

Query Parameters

Name	Type	Description
id*	Int	Order ID

Headers

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

Response

Voucher (Array)	Type	Description/Example
id	Int	ID
name	String	Voucher Name
amount	Double	Amount

Get Expense Order Detail

GET https://open-api.zortout.com/v4/Order/GetExpenseOrderDetail

Get list of expenses of order.

Query Parameters

Name	Type	Description
id*	Int	Order ID

Headers

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

Response

Expense (Array)	Type	Description/Example
id	Int	ID
name	String	Expense Name
amount	Double	Amount
paymentname	String	Payment Method Name
paymentdatetime	Datetime	Payment Datetime
paymentdatetimeString	String	Payment Datetime Text (yyyy-MM-dd HH:mm)
isvat	Int	Vat Status 0 - No Vat 1 - Include Vat

Get Movement Order Detail

GET https://open-api.zortout.com/v4/Order/GetMovementOrderDetail

Get movement list of products according to each order.

Query Parameters

Name	Type	Description
id*	Int	Order ID

Headers

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

Response

MovementOrder (Array)	Type	Description/Example
id	Int	ID
list	OrderProduct (Array)	Movement List
actionDate	Date (Array)	List of action date
actionDateString	String (Array)	List of action date text (yyyy-MM-dd)
orderid	Int	Order ID

OrderProduct (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 Orders

GET https://open-api.zortout.com/v4/Order/GetMovementOrders

Get movement list of products for 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

Response

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

MovementOrder (Array)	Type	Description/Example
id	Int	ID
list	OrderProduct (Array)	Movement List
actionDate	Date (Array)	List of action date
actionDateString	String (Array)	List of action date text (yyyy-MM-dd)
orderid	Int	Order ID

OrderProduct (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 Shipment Labels

GET https://open-api.zortout.com/v4/Order/GetShipmentLabels

Get shipment label list of orders.

Headers

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

Response

ShipmentLabel (Array)	Type	Description/Example
linkurl	String	Url of Shipment Label
type	String	Type of Shipment Label. Ex. "general, lazada, shopee, jdcentral, tiktok, flashexpress, jtexpress, kerry, shopeeexpress"
Format	String	Pdf, Html, Url
Data	String	Shipment Label Data (Follow on Format)
list	Int (Array)	List Of Order ID

Add Order

POST https://open-api.zortout.com/v4/Order/AddOrder

Add order.

Query Parameters

Name	Type	Description
uniquenumber	String	Unique Number. This value is unique and used to prevent duplicate transaction.
link	Int	Link to generate. 0 – None (Default) 1 – Share link

Headers

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

Request Body

Name	Type	Description
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"
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”
list	OrderProduct (Array)	Product List
∟ sku*	String	Product Sku
∟ name*	String	Product Name
∟ number*	Double	Product Quantity
∟ pricepernumber*	Double	Product Price/Quantity
∟ discount	String	Discount Per Unit
∟ vat_status	Int	Sell vat status 0 - Follow Vat Type in Order (Default) 1 - No Vat 2- Have Vat 3 - Vat 0% Remark: Only Merchant With Addon "Advance Vat".
∟ totalprice*	Double	Total Price
∟ producttype	Int	Product Type 0 - Product (Default) 1 - Service
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
∟ email	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

Response

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

Detail	Type	Description/Example
id	Int	Order ID

Ex. Request JSON

{
  "number": "SO-0001",
  "orderdate": "2021-05-31",
  "amount": 68,
  "shippingamount": 10,
  "vatamount": 0,
  "paymentmethod": "Cash",
  "paymentamount": 50,
  "list": [
    {
      "sku": "P0001",
      "name": "Product1",
      "number": 24,
      "pricepernumber": 2,
      "discount": "0",
      "totalprice": 48
    },
    {
      "sku": "P0002",
      "name": "Product2",
      "number": 1,
      "pricepernumber": 10,
      "discount": "0",
      "totalprice": 10
    }
  ]
}

Update Order Status

POST https://open-api.zortout.com/v4/Order/UpdateOrderStatus

Update status of order.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
status	int	1 = Success (Default) 3 = Waiting 4 = Returned 5 = Packed 6 = Shipping
warehousecode	String	Warehouse Code
number	String	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

Response

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

Update Order Payment

POST https://open-api.zortout.com/v4/Order/UpdateOrderPayment

Update payment of order.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
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

Headers

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

Response

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

Verify Slip

POST https://open-api.zortout.com/v4/Order/VerifyOrderSlip

Verify slip of order.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
filename*	String	File Name
number	String	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

Request Body

Name	Type	Description
file*	File	File Binary Data

Response

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

Update Partial Order

POST https://open-api.zortout.com/v4/Order/UpdatePartialOrder

Update partial product of order.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
number	String	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

Request Body

Name	Type	Description
	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

Response

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

Ex. Request JSON

[
    {
      "sku": "P0001",
      "number": 24
    },
    {
      "productid": 1234,
      "number": 25
    }
]

Edit Order Info

POST https://open-api.zortout.com/v4/Order/EditOrderInfo

Edit order info.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
number	String	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

Request Body

Name	Type	Description
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
∟ name	String	Agent Name
∟ phone	String	Agent Phone
∟ email	String	Agent Email
∟ address	String	Agent Address
expiredate	String	Expired Date Ex. “2021-09-15”
reference	String	Reference

Response

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

Ex. Request JSON

{
  "number": "SO-0001",
  "orderdate": "2021-05-31"
}

Edit Order

POST https://open-api.zortout.com/v4/Order/EditOrder

Edit order.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
number	String	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

Request Body

Name	Type	Description
number	String	Order Number
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
shippingphone	String	Shipping Phone
shippingaddress	String	Shipping Address
shippingname	String	Shipping Name
shippingdate	String	Shipping Date Ex. “2021-09-15”
shippingchannel	String	Shipping Channel
expiredate	String	Expired Date Ex. “2021-09-15”
orderdate	String	Order Date Ex. “2021-09-15”
trackingno	String	Tracking No
shippingemail	String	Shipping Email
saleschannel	String	Sales Channel
description	String	Description
reference	String	Reference
tag	String (Array)	Tag List (Array)
amount*	Double	Net Amount
agent	Agent	Agent Detail
∟ name	String	Agent Name
∟ phone	String	Agent Phone
∟ email	String	Agent Email
∟ address	String	Agent Address
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
shippingvat	Int	Shipping Vat Status 0 - No Shipping Vat (Default) 1 – Have Shipping Vat
discount	String	Discount Ex. 5.00, 10%
list	OrderProduct (Array)	Product List
∟ sku*	String	Product Sku
∟ name*	String	Product Name
∟ number*	Double	Product Quantity
∟ pricepernumber*	Double	Product Price/Quantity
∟ discount	String	Discount Per Unit
∟ vat_status	Int	Sell vat status 0 - Follow Vat Type in Order (Default) 1 - No Vat 2- Have Vat 3 - Vat 0% Remark: Only Merchant With Addon "Advance Vat".
∟ totalprice*	Double	Total Price

Response

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

Ex. Request JSON

{
  "number": "SO-0001",
  "orderdate": "2021-05-31",
  "amount": 68,
  "shippingamount": 10,
  "vatamount": 0,
  "list": [
    {
      "sku": "P0001",
      "name": "Product1",
      "number": 24,
      "pricepernumber": 2,
      "discount": "0",
      "totalprice": 48
    },
    {
      "sku": "P0002",
      "name": "Product2",
      "number": 1,
      "pricepernumber": 10,
      "discount": "0",
      "totalprice": 10
    }
  ]
}

Void Order

POST https://open-api.zortout.com/v4/Order/VoidOrder

Void order.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
number	String	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

Response

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

Void Order Payment

POST https://open-api.zortout.com/v4/Order/VoidOrderPayment

Delete payment in order.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
paymentid*	Int	Payment ID
number	String	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

Response

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

Ready To Ship

POST https://open-api.zortout.com/v4/Order/ReadyToShip

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

Name	Type	Description
id	Int	Order ID *Must have either id or number
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

Headers

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

Response

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

Parameter (Detail)	Type	Description/Example
id	Int	Order ID
number	String	Order Number
shippingchannel	String	Shipping Channel
trackingno	String	Tracking No
link	String	Shipping Label Link

Book Order Shipment

POST https://open-api.zortout.com/v4/Order/BookOrderShipment

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

Name	Type	Description
id	Int	Order ID *Must have either id or number
shipment*	String	Shipment provider. thailandpost - Thailand Post flashexpress – Flash Express kerry – Kerry shopeeexpress – Shopee Express dhl - DHL
number	String	Order Number Require if id = 0 or null *Must have either id or number
useShippingPoint	Boolean	Define this shipment uses shipping point. True : Shipping Point False : Direct Payment (Default when shipment is valid.) Remark: Shipping Point is supported only Thailand Post, Flash Express, Shopee Exporess and DHL.
isPickup	Boolean	Define this shipment is pickup. True : Pickup (Default when Shipping Point of shipment is valid.) False : Drop off

Headers

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

Request Body (Not Required)

if no request body, this order will use address of merchant profile and shipping/customer address in this order.

Name	Type	Description
senderName	String	Sender Name
senderPhone	String	Sender Phone
senderEmail	String	Sender Email
senderAddress	String	Sender Address
senderDistrict	String	Sender District
senderCity	String	Sender City
senderProvince	String	Sender Province
senderPostcode	String	Sender Postcode
recipientName	String	Recipient Name
recipientPhone	String	Recipient Phone
recipientEmail	String	Recipient Email
recipientAddress	String	Recipient Address
recipientDistrict	String	Recipient District
recipientCity	String	Recipient City
recipientProvince	String	Recipient Province
recipientPostcode	String	Recipient Postcode
codAmount	Double	COD Amount (Assign this value = 0, if this order is not COD.)
parcelWeight	Decimal (Not Required)	Parcel Weight (Gram)
parcelWidth	Decimall (Not Required)	Parcel Width (cm)
parcelLength	Decimall (Not Required)	Parcel Length (cm)
parcelHeight	Decimall (Not Required)	Parcel Height (cm)

Response

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

Parameter (Detail)	Type	Description/Example
id	Int	Order ID
number	String	Order Number
shippingchannel	String	Shipping Channel
trackingno	String	Tracking No
link	String	Shipping Label Link

Update Order Serial No

POST https://open-api.zortout.com/v4/Order/UpdateOrderSerialNo

Update serial number of order.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
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

Headers

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

Response

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

Update Order Expiry/Lot

POST https://open-api.zortout.com/v4/Order/UpdateOrderExpiryLot

Update expiry/lot of order.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
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

Headers

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

Response

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

Add Expense Order

POST https://open-api.zortout.com/v4/Order/AddExpenseWithOrder

Add expense to order.

Query Parameters

Name	Type	Description
id*	Int	Order ID

Headers

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

Request Body

Name	Type	Description
name*	String	Expense Name
paymentname*	String	Payment Method
amount*	Double	Amount
isvat	Int	Vat Status 0 - No Vat (Default) 1 - Include Vat

Response

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

Add Order Tag

POST https://open-api.zortout.com/v4/Order/AddOrderTag

Add tag to order.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
tag*	String	Tag
number	String	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

Response

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

Delete Order Tag

POST https://open-api.zortout.com/v4/Order/DeleteOrderTag

Delete tag of order.

Query Parameters

Name	Type	Description
id	Int	Order ID *Must have either id or number
tag*	String	Tag
number	String	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

Response

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