Return Order

Get Return Orders

GET https://open-api.zortout.com/v4/ReturnOrder/GetReturnOrders

Get list of return orders.

Query Parameters

Name	Type	Description
returnorderdateafter	String	Return Order Date After ….. (yyyy-MM-dd)
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)
returnorderdatebefore	String	Return Order Date Before ….. (yyyy-MM-dd)
keyword	String	Keyword to search
createusername	String	Created by (Username)
warehousecode	String	Warehouse Code
topaymentamount	Double	Maximum payment amount
frompaymentamount	Double	Minimum payment amount
toamount	Double	Maximum amount
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
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”

200: OK Success

Response

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

ReturnOrder (Array)	Type	Description/Example
id	Int	Return Order ID
number	String	Return 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, Shipping, Success, Partial Transfer, Voided)
paymentstatus	String	Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount	Double	Net Amount
amount_pretax	Double	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
trackingno	String	Tracking No
returnorderdate	Date	Return Order Date
returnorderdateString	String	Return Order Date Text (yyyy-MM-dd)
paymentamount	Double	Payment Amount
reference	String	Reference
description	String	Description
discount	String	Discount Ex.5.00, 10%
sellerdiscount	Double	Seller Discount
sellerdiscount_pretax	Double	Pretax Seller Discount
sellerdiscount_vat	Double	Seller Discount Vat
platformdiscount	Double	Platform Discount
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 return order discount.
discountamount_pretax	Double	Total summary of pretax return order discount.
discountamount_vat	Double	Total summary of return 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	ReturnOrderProduct (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 Order ID
referencenumber	String	Reference Order Number

ReturnOrderProduct (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)

Ex. Request JSON

{
   "number":"CN-0001",
   "customername":"CustomerName",
   "status":"Success",
   "amount":"105",
   "vatamount":"0",
   "returnorderdate":"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"
}

Get Return Order Detail

GET https://open-api.zortout.com/v4/ReturnOrder/GetReturnOrderDetail

Get return order detail

Query Parameters

Name	Type	Description
id*	Int	Return Order ID

Headers

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

200: OK Success

Response

Parameter	Type	Description/Example
id	Int	Return Order ID
number	String	Return 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, Shipping, Success, Partial Transfer, Voided)
paymentstatus	String	Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount	Double	Net Amount
amount_pretax	Double	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
trackingno	String	Tracking No
returnorderdate	Date	Return Order Date
returnorderdateString	String	Return Order Date Text (yyyy-MM-dd)
paymentamount	Double	Payment Amount
reference	String	Reference
description	String	Description
discount	String	Discount Ex.5.00, 10%
sellerdiscount	Double	Seller Discount
sellerdiscount_pretax	Double	Pretax Seller Discount
sellerdiscount_vat	Double	Seller Discount Vat
platformdiscount	Double	Platform Discount
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 return order discount.
discountamount_pretax	Double	Total summary of pretax return order discount.
discountamount_vat	Double	Total summary of return 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	ReturnOrderProduct (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 Order ID
referencenumber	String	Reference Order Number

ReturnOrderProduct (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 Order Detail

GET https://open-api.zortout.com/v4/ReturnOrder/GetMovementReturnOrderDetail

Get movement list of products according to each return order.

Query Parameters

Name	Type	Description
id*	Int	Return Order ID

Headers

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

200: OK Success

Response

MovementReturnOrder (Array)	Type	Description/Example
id	Int	ID
list	ReturnOrderProduct (Array)	Movement List
actionDate	Date (Array)	List of action date
actionDateString	String (Array)	List of action date text (yyyy-MM-dd)
returnorderid	Int	Return Order ID

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

GET https://open-api.zortout.com/v4/ReturnOrder/GetMovementReturnOrders

Get movement list of products for return orders.

Query Parameters

Name	Type	Description
dateafter*	String	Date After ….. (yyyy-MM-dd)
datebefore*	String	Date Before ….. (yyyy-MM-dd)
limit	Int	Limit per page (Max = 500)
page	Int	Page (Default = 1)
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
res	Response	Response Code 200- Success
list	MovementReturnOrder (Array)	Movement Return Order List (Array)
count	Int	Total movement order number by filter

MovementReturnOrder (Array)	Type	Description/Example
id	Int	ID
list	ReturnOrderProduct (Array)	Movement List
actionDate	Date (Array)	List of action date
actionDateString	String (Array)	List of action date text (yyyy-MM-dd)
returnorderid	Int	Return Order ID

ReturnOrderProduct (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 Order

POST https://open-api.zortout.com/v4/ReturnOrder/AddReturnOrder

Add return 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 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

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 Order ID

Ex. Request JSON

{
  "number": "CN-0001",
  "customername": "Customer Name",
  "status": "Success",
  "amount": "105",
  "vatamount": "0",
  "returnorderdate": "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 Order Status

POST https://open-api.zortout.com/v4/ReturnOrder/UpdateReturnOrderStatus

Update status of return order.

Query Parameters

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

200: OK Success

Response

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

Update Return Order Payment

POST https://open-api.zortout.com/v4/ReturnOrder/UpdateReturnOrderPayment

Update payment of return order.

Query Parameters

Name	Type	Description
id	Int	Return 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 Order Number Require if id = 0 or null *Must have either id or number

Headers

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

200: OK Success

Response

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

Void Return Order

POST https://open-api.zortout.com/v4/ReturnOrder/VoidReturnOrder

Void return order.

Query Parameters

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

Headers

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

200: OK Success

Response

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

Void Return Order Payment

POST https://open-api.zortout.com/v4/ReturnOrder/VoidReturnOrderPayment

Delete payment in return order.

Query Parameters

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

Headers

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

200: OK Success

Response

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

Add Return Order Tag

POST https://open-api.zortout.com/v4/ReturnOrder/AddReturnOrderTag

Add tag to return order.

Query Parameters

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

Headers

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

200: OK Success

Response

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

Delete Return Order Tag

POST https://open-api.zortout.com/v4/ReturnOrder/DeleteReturnOrderTag

Delete tag of return order.

Query Parameters

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

Headers

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

200: OK Success

Response

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