Update Order
Update your order by yourself according to the following order details:
API Endpoint
| URL |
{base url}/api/Order/UpdateOrder |
| Method |
POST |
| Authorization |
Bearer Token |
| Content-Type |
application/json |
Request Headers
| Parameter |
Type |
Required |
Description |
| APIKEY |
string |
true |
System key code |
Request Parameters
| Parameter |
Type |
Required |
Description |
| HID |
string |
false |
OMS Order ID |
| ShopId |
string |
true |
Shop ID. |
| PlatformIdOrName |
string |
false |
Platform ID or name. |
| OrderId |
string |
true |
Order ID. |
| OrderNo |
string |
true |
Order number. (dd-MM-yyyyTHH:mm:ss) |
| OrderDate |
string |
true |
Order date. |
| Campaign |
string |
true |
Campaign name. |
| Customer |
object |
true |
Customer information. |
| Recipient |
object |
true |
Recipient information. |
| LogisticsIdOrName |
string |
true |
Logistics ID or name. |
| TrackingNo |
string |
true |
Tracking number. |
| PayAmount |
decimal |
false |
Product discount. |
| Discount |
decimal |
false |
Product discount. |
| ShippFree |
decimal |
false |
Free shipping. |
| PaymentId |
string |
true |
Payment channel ID. |
| Remark |
string |
false |
Remarks. |
| Tag |
string |
false |
Tags. |
| SLAHOverDate |
string |
false |
SLA Delivery Time Agreement (dd-MM-yyyyTHH:mm:ss) |
| OrderSkus |
object |
true |
Items in the order. |
Recipient/Customer information
| Parameter |
Type |
Required |
Description |
| FullName |
string |
true |
Full name |
| TelNumber |
string |
true |
Contact number |
| Address |
string |
true |
Address |
| ProvinceIdOrName |
string |
true |
Province information can be a standard API ID or a name. |
| DistrictIdOrName |
string |
true |
District information can be a standard API ID or a name. |
| SubdistrictIdOrName |
string |
true |
Subdistrict information can be a standard API ID or a name. |
| PostalCode |
string |
true |
postal code |
| Tag |
string |
false |
Information to search (not required) |
OrderSkus
| Parameter |
Type |
Required |
Description |
| SkuIdOrCode |
string |
true |
SKU ID or code. |
| Qty |
integer |
true |
Quantity. |
| UnitPrice |
decimal |
false |
Unit price. |
| Discount |
decimal |
false |
Discount per unit. |
Request JSON Example
{
"HID": "365FCEF4-B325-44A6-BD5B-44B0CF91A66A",
"ShopId": "",
"PlatformIdOrName": "tiktok",
"OrderId": "ord12345",
"OrderNo": "ORD24110002344",
"OrderDate": "28-11-2024T10:32:00",
"Campaign": "test",
"Customer": {
"FullName": "John Doe",
"TelNumber": "0812345678",
"Address": "123/45 ถนนสุขุมวิท เขตคลองเตย",
"ProvinceIdOrName": "กรุงเทพมหานคร",
"DistrictIdOrName": "คลองเตย",
"SubdistrictIdOrName": "คลองตัน",
"PostalCode": "10110",
"Tag": "ลูกค้าประจำ"
},
"Recipient": {
"FullName": "Jane Smith",
"TelNumber": "0912345678",
"Address": "456/78 หมู่บ้านพฤกษา อำเภอเมือง",
"ProvinceIdOrName": "เชียงใหม่",
"DistrictIdOrName": "เมืองเชียงใหม่",
"SubdistrictIdOrName": "สุเทพ",
"PostalCode": "50200",
"Tag": "ผู้รับใหม่"
},
"LogisticsIdOrName": "dhl",
"TrackingNo": "THR518465112",
"Discount": 0.0,
"ShippFree": 0.0,
"PaymentId": "PAYMENT",
"Remark": "",
"Tag": "#promotion",
"SLAHOverDate": "08-07-2025T17:00:00",
"OrderSkus": [
{
"SkuIdOrCode": "T711L",
"Qty": 2,
"UnitPrice": 150,
"Discount": 0.0
},
{
"SkuIdOrCode": "0924100042374",
"Qty": 1,
"UnitPrice": 0.0,
"Discount": 0.0
}
]
}
Response Parameters
| Parameter |
Type |
Description |
| Id |
integer |
Error status (0 = No error). |
| Success |
boolean |
Request status. |
| Message |
string |
Response message. |
| RequestId |
string |
Reference ID for the request. |
| Size |
integer |
Number of records returned. |
| Data |
object |
Data payload. |
Data
| Parameter |
Type |
Description |
| OrderHID |
string |
Order ID in the OMS system. |
| OrderId |
string |
Order ID. |
| Status |
object |
Status information. |
Response JSON Example
{
"Id": 0,
"Success": true,
"Message": "SUCCESS",
"RequestId": "30B2A080-E1E0-424A-AD0E-748AD5F78957",
"Size": 1,
"Data": {
"OrderHID": "365FCEF4-B325-44A6-BD5B-44B0CF91A66A",
"OrderId": "ord12345",
"Status": {
"Code": "11",
"Name": "ตรวจสอบข้อมูลคำสั่งซื้อ"
}
}
}