Get Shipment Label
Retrieve the shipment label information for a specific order.
API Endpoint
| URL |
{base url}/api/Order/GetShipmentLabel |
| Method |
GET |
| Authorization |
Bearer Token |
| Content-Type |
application/json |
Request Headers
| Parameter |
Type |
Required |
Description |
| APIKEY |
string |
true |
Application key for authorization |
Request Parameters
| Parameter |
Type |
Required |
Description |
| OrderId |
string (GUID) |
true |
The ID of the order |
| TrackingNo |
string |
true |
The tracking number of the parcel |
| RequestFile |
boolean |
true |
Specify whether to return the label file |
Request Example
{base url}/api/Order/GetShipmentLabel?OrderId={value}&TrackingNo={value}&RequestFile={true/false)
Response Parameters
| Parameter |
Type |
Description |
| Id |
integer |
Error code (e.g., 0 = no error) |
| Success |
boolean |
Indicates whether the request was successful |
| Message |
string |
Response message |
| RequestId |
string |
Request reference ID |
| Size |
integer |
Number of data records returned |
| Data |
object |
Label information |
Data
| Parameter |
Type |
Description |
| OrderId |
string |
The order ID |
| OrderNo |
string |
The order number |
| TrackingNo |
string |
The tracking number |
| Label |
string |
The shipment label file content (e.g., base64 string) |
Response JSON Example
{
"Id": 0,
"Success": true,
"Message": "SUCCESS",
"RequestId": "463F108F-156E-4C0D-B98D-07586C8AD684",
"Size": 1,
"Data": {
"OrderId": "676e34fd-0021-35e8-9764-2d3615a76dd7",
"OrderNo": "250624D2D3T3EE",
"TrackingNo": "TH253700815138L",
"Label": "{label file found in system ...}"
}
}