# Order ## Get Orders `GET` `https://api.zortout.com/api.aspx` Get list of orders. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------- | | 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)

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 | Name | Type | Description | | ------------------------------------------- | ------ | ---------------------------------------------------------- | | 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 | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Property (Array) | Type | Description/Example | | ---------------- | ------ | ------------------- | | id | Int | Property ID | | name | String | Property Name | | value | String | Property Value | | Agent | Type | Description/Example | | ------- | ------ | ------------------- | | id | Int | Agent ID | | name | String | Agent Name | | phone | String | Agent Phone | | email | String | Agent Email | | address | String | Agent Address | | ExpiryLot (Array) | Type | Description/Example | | ----------------- | ------ | ------------------- | | id | Int | Expiry lot ID | | name | String | Expiry lot Name | | number | Double | Expiry lot Quantity | | expiryDate | Date | Expired Date | | SerialNo (Array) | Type | Description/Example | | ---------------- | ------ | ------------------- | | id | Int | Serial no ID | | name | String | Serial no Name |

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)

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
discountamount	Double	Total discount of product line.
totalprice	Double	Total Price
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.
serialnolist	SerialNo (Array)	Serial no List
expirylotlist	ExpiryLot (Array)	Expiry lot List

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, Packed, Shipping, Success, Partial Transfer, Voided)
paymentstatus	String	Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount	Double	Net Amount
vatamount	Double	Vat Amount
shippingchannel	String	Shipping Channel
shippingamount	Double	Shipping 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
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
platformdiscount	Double	Platform Discount. This discount is subsidized from Marketplace for buyer. (Ex. Lazada, Shopee, JDCentral)
voucheramount	Double	Subsidized Amount from Marketplace for seller.
discountamount	Double	Total summary of order discount. (Include discount and voucheramount). discountamount = discount - voucheramount discountamount = sellerdiscount + platformdiscount - voucheramount
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)
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.)
agent	Agent	Agent Detail
uniquenumber	String	Unique Number
properties	Property (Array)	Custom Properties List

| Parameter | Type | Description/Example | | --------- | ------------- | ------------------------------------- | | res | Response |

Response Code
200- Success

| | list | Order (Array) | Order List (Array) | | count | Int | Total order number by filter | ## Get Order Detail `GET` `https://api.zortout.com/api.aspx` Get order detail. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ------------------- | | method\* | String | “GETORDERDETAIL” | | version\* | String | 3 | | format | String | json (Default), xml | | id\* | Int | Order ID | #### Headers | Name | Type | Description | | ------------------------------------------- | ------ | ----------- | | storename\* | String | Store Name | | apisecret\* | String | API Secret | | apikey\* | String | API Key | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Property (Array) | Type | Description/Example | | ---------------- | ------ | ------------------- | | id | Int | Property ID | | name | String | Property Name | | value | String | Property Value |

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

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

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

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)

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
discountamount	Double	Total discount of product line.
totalprice	Double	Total Price
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.
serialnolist	SerialNo (Array)	Serial no List
expirylotlist	ExpiryLot (Array)	Expiry lot List

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, Packed, Shipping, Success, Partial Transfer, Voided)
paymentstatus	String	Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount	Double	Net Amount
vatamount	Double	Vat Amount
shippingchannel	String	Shipping Channel
shippingamount	Double	Shipping 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
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
platformdiscount	Double	Platform Discount. This discount is subsidized from Marketplace for buyer. (Ex. Lazada, Shopee, JDCentral)
voucheramount	Double	Subsidized Amount from Marketplace for seller.
discountamount	Double	Total summary of order discount. (Include discount and voucheramount). discountamount = discount - voucheramount discountamount = sellerdiscount + platformdiscount - voucheramount
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)
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.)
agent	Agent	Agent Detail
uniquenumber	String	Unique Number
properties	Property (Array)	Custom Properties List

## Get Voucher Detail `GET` `https://api.zortout.com/api.aspx` Get list of voucher subsidized by Marketplace. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ------------------- | | method\* | String | “GETVOUCHERDETAIL” | | id\* | Int | Order ID | | version\* | String | 3 | | format | String | json (Default), xml | #### Headers | Name | Type | Description | | ------------------------------------------- | ------ | ----------- | | apisecret\* | String | API Secret | | storename\* | String | Store Name | | apikey\* | String | API Key | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Voucher (Array) | Type | Description/Example | | --------------- | ------ | ------------------- | | id | Int | ID | | name | String | Voucher Name | | amount | Double | Amount | ## Get Expense Order Detail `GET` `https://api.zortout.com/api.aspx` Get list of expenses of order. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ----------------------- | | method\* | String | “GETEXPENSEORDERDETAIL” | | id\* | Int | Order ID | | version\* | String | 3 | | format | String | json (Default), xml | #### Headers | Name | Type | Description | | ------------------------------------------- | ------ | ----------- | | apisecret\* | String | API Secret | | storename\* | String | Store Name | | apikey\* | String | API Key | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | 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://api.zortout.com/api.aspx` Get movement list of products according to each order. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ------------------------- | | method\* | String | ““GETMOVEMENTORDERDETAIL” | | id\* | Int | Order ID | | version\* | String | 3 | | format | String | json (Default), xml | #### Headers | Name | Type | Description | | ------------------------------------------- | ------ | ----------- | | apisecret\* | String | API Secret | | storename\* | String | Store Name | | apikey\* | String | API Key | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | 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 | | 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 | ## Get Movement Orders `GET` `https://api.zortout.com/api.aspx` Get movement list of products for orders. #### Query Parameters | Name | Type | Description | | -------------------------------------------- | ------ | ---------------------------------------- | | 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 | Name | Type | Description | | ------------------------------------------- | ------ | ----------- | | apisecret\* | String | API Secret | | storename\* | String | Store Name | | apikey\* | String | API Key | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | 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 | | 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 | | 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 | ## Get Shipment Labels `GET` `https://api.zortout.com/api.aspx` Get shipment label list of orders. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ------------------- | | method\* | String | "GETSHIPMENTLABELS" | | version\* | String | 3 | | format | String | json (Default), xml | #### Headers | Name | Type | Description | | ------------------------------------------- | ------ | ---------------------------------------------------------- | | storename\* | String | Store Name | | orderidlist | String |

List Of Order ID
Ex. “123,124,125”

List Of Order Number
Ex. “SO-001,SO-002,SO-003”

| {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | 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"

| | list | Int (Array) | List Of Order ID | ## Add Order `POST` `https://api.zortout.com/api.aspx` Add order. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ------------------------------------------------------------------------------------------- | | 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 | 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

Shipping Date

Ex. “2021-09-15”

| | shippingvat | Int |

Shipping Vat Status
0 - No Shipping Vat (Default)
1 – Have Shipping Vat

Payment Amount

("paymentmethod" must be required.)

Order Date
Ex. "2021-09-15"

Discount
Ex. 5.00, 10%

Payment Datetime
Ex. “2021-09-15 21:05”

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.

Expired Date
Ex. "2021-09-15"

Property ID

\*Must have either id or name

Property Name Require if id = 0 or null

\*Must have either id or name

| {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% tab title="Ex. URL" %} URL : {% endtab %} {% tab title="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 } ] } ``` {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Parameter | Type | Description/Example | | --------- | ------ | ------------------------------------- | | resCode | String |

Response Code
200- Success

| | resDesc | String | Response Description | ## Update Order Status `POST` `https://api.zortout.com/api.aspx` Update status of order. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ----------------------------------------------------------------------------------- | | method\* | String | “UPDATEORDERSTATUS” | | status | Int |

1 = Success (Default)
3 = Waiting
6 = Shipping

Order Number Require if id = 0 or null

\*Must have either id or number

| | id | Int |

Order ID

\*Must have either id or number

Response Code
200- Success

| | resDesc | String | Response Description | ## Update Order Payment `POST` `https://api.zortout.com/api.aspx` Update payment of order. #### Query Parameters | Name | Type | Description | | ----------------------------------------------- | ------ | ----------------------------------------------------------------------------------- | | method\* | String | “UPDATEORDERPAYMENT” | | verifyslipid | Int | Verify Slip ID | | paymentdate | String |

Payment Datetime
Ex. “2021-09-15 21:05”

Order Number Require if id = 0 or null

\*Must have either id or number

| | id | Int |

Order ID

\*Must have either id or number

Response Code
200- Success

| | resDesc | String | Response Description | ## Verify Slip `POST` `https://api.zortout.com/api.aspx` Verify slip of order. #### Path Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------------------------------------------------------------------------------- | | method\* | String | “VERIFYORDERSLIP” | | id | Int |

Order ID

\*Must have either id or number

Order Number Require if id = 0 or null

\*Must have either id or number

| #### Query Parameters | Name | Type | Description | | ------------------------------------------ | ------ | ----------------------------------------------------------------------------------- | | 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 | Name | Type | Description | | ------------------------------------------- | ------ | ----------- | | storename\* | String | Store Name | | apisecret\* | String | API Secret | | apikey\* | String | API Key | #### Request Body | Name | Type | Description | | -------------------------------------- | ---- | ---------------- | | file\* | File | File Binary Data | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Parameter | Type | Description/Example | | --------- | ------ | ------------------------------------- | | resCode | String |

Response Code
200- Success

| | resDesc | String | Response Description | ## Update Partial Order `POST` `https://api.zortout.com/api.aspx` Update partial product of order. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ----------------------------------------------------------------------------------- | | 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 | 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 | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% tab title="Ex. Request JSON" %} ``` [ { "sku": "P0001", "number": 24 }, { "productid": 1234, "number": 25 } ] ``` {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Parameter | Type | Description/Example | | --------- | ------ | ------------------------------------- | | resCode | String |

Response Code
200- Success

| | resDesc | String | Response Description | ## Edit Order Info `POST` `https://api.zortout.com/api.aspx` Edit order info. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ----------------------------------------------------------------------------------- | | 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

Shipping Date

Ex. “2021-09-15”

Order Date
Ex. “2021-09-15”

Expired Date
Ex. “2021-09-15”

| | reference | String | Reference | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% tab title="Ex. Request JSON" %} ``` { "number": "SO-0001", "orderdate": "2021-05-31" } ``` {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Parameter | Type | Description/Example | | --------- | ------ | ------------------------------------- | | resCode | String |

Response Code
200- Success

| | resDesc | String | Response Description | ## Edit Order `POST` `https://api.zortout.com/api.aspx` Edit order. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ----------------------------------------------------------------------------------- | | 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 | Name | Type | Description | | ------------------------------------------- | ------ | ----------- | | storename\* | String | Store Name | | apisecret\* | String | API Secret | | apikey\* | String | API Key | #### Request Body | Name | Type | Description | | -------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | number | String | Order Number | | shippingname | String | Shipping Name | | shippingdate | String |

Shipping Date

Ex. “2021-09-15”

Expired Date
Ex. “2021-09-15”

| | orderdate | String |

Order Date
Ex. “2021-09-15”

Discount
Ex. 5.00, 10%

| | shippingvat | Int |

Shipping Vat Status
0 - No Shipping Vat (Default)
1 – Have Shipping Vat

| | 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 | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% tab title="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 } ] } ``` {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Parameter | Type | Description/Example | | --------- | ------ | ------------------------------------- | | resCode | String |

Response Code
200- Success

| | resDesc | String | Response Description | ## Void Order `POST` `https://api.zortout.com/api.aspx` Void order. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ----------------------------------------------------------------------------------- | | 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

Response Code
200- Success

| | resDesc | String | Response Description | ## Void Order Payment `POST` `https://api.zortout.com/api.aspx` Delete payment in order. #### Query Parameters | Name | Type | Description | | ------------------------------------------- | ------ | ----------------------------------------------------------------------------------- | | 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

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

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

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 | Name | Type | Description | | ------------------------------------------- | ------ | ----------- | | apisecret\* | String | API Secret | | storename\* | String | Store Name | | apikey\* | String | API Key | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | 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 | | Parameter | Type | Description/Example | | --------- | ------ | ------------------------------------- | | resCode | String |

Response Code
200- Success

| | resDesc | String | Response Description | | detail | Detail | Response detail | ## 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 | Name | Type | Description | | ------------------------------------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------- | | 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 | Name | Type | Description | | ------------------------------------------- | ------ | ----------- | | apisecret\* | String | API Secret | | storename\* | String | Store Name | | apikey\* | String | API Key | {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | 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 | | Parameter | Type | Description/Example | | --------- | ------ | ------------------------------------- | | resCode | String |

Response Code
200- Success

| | resDesc | String | Response Description | | detail | Detail | Response detail | ## Update Order Serial No `POST` `https://api.zortout.com/api.aspx` Update serial number of order. #### Query Parameters | Name | Type | Description | | ------------------------------------------ | ------ | --------------------------------------------------------------------------------------------- | | 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

Response Code
200- Success

| | resDesc | String | Response Description | ## Update Order Expiry/Lot `POST` `https://api.zortout.com/api.aspx` Update expiry/lot of order. #### Query Parameters | Name | Type | Description | | ------------------------------------------- | ------ | --------------------------------------------------------------------------------------------- | | 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

Response Code
200- Success

| | resDesc | String | Response Description | ## Add Expense Order `POST` `https://api.zortout.com/api.aspx` Add expense to order. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | --------------------- | | method\* | String | “ADDEXPENSEWITHORDER” | | id\* | Int | Order ID | | version\* | String | 3 | | format | String | json (Default), xml | #### 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

| {% tabs %} {% tab title="200: OK Success" %} {% tabs %} {% tab title="Response" %} {% endtab %} {% endtabs %} {% endtab %} {% endtabs %} | Parameter | Type | Description/Example | | --------- | ------ | ------------------------------------- | | resCode | String |

Response Code
200- Success

| | resDesc | String | Response Description | ## Add Order Tag `POST` `https://api.zortout.com/api.aspx` Add tag to order. #### Query Parameters | Name | Type | Description | | ----------------------------------------- | ------ | ----------------------------------------------------------------------------------- | | 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

Response Code
200- Success

| | resDesc | String | Response Description | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developers-v3.zortout.com/api-reference/order.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.