GET api/Order/List/{OrderID}
Retrieve order details
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderID |
Order ID |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
OrderModel| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderNo |
Order No. If you are adding new order, leave this empty. |
string |
None. |
| WarehouseID |
Warehouse Id |
integer |
None. |
| WarehouseCode |
Warehouse Code |
string |
None. |
| AccountNo |
Your account number. |
string |
None. |
| SenderName |
Sender Name |
string |
None. |
| SenderAddress |
Sender Address |
string |
None. |
| AlternateReferenceNumber |
alternate reference number eg Your Tracking number. For us to link back our order record to your data based on this reference number. |
string |
None. |
| ReferenceNumber |
reference number eg Merchant order number. |
string |
None. |
| ReferenceNumber2 |
reference number 2 eg Your system order number. |
string |
None. |
| OrderDate |
Must be in yyyy/MM/dd format. |
string |
None. |
| OrderInfo |
Additional info for this order. |
string |
None. |
| Weight |
Weight in grams. |
decimal number |
None. |
| MerchantName |
Merchant Name |
string |
None. |
| ParcelDescription |
Description of parcel. |
string |
None. |
| ParcelClassification |
parcel classification. |
string |
None. |
| ParcelValue |
Parcel Value in USD |
decimal number |
None. |
| ParcelLength |
Parcel dimension length in CM. |
integer |
None. |
| ParcelHeight |
Parcel dimension height in CM. |
integer |
None. |
| ParcelWidth |
Parcel dimension width in CM. |
integer |
None. |
| DimensionWeight |
Parcel dimension weight in Grams. |
decimal number |
None. |
| OrderReceivedViaAPI |
Order Received Via API 1-Yes, 0-No |
integer |
None. |
| ParcelItemCount |
Number of Item |
integer |
None. |
| Currency |
Set to USD |
string |
None. |
| ConsigneeName |
Consignee Name |
string |
None. |
| ConsigneeContactNumber |
Consignee Contact Number |
string |
None. |
| ConsigneeEmail |
Consignee Email |
string |
None. |
| ConsigneeAddress1 |
Consignee Address 1 |
string |
None. |
| ConsigneeAddress2 |
Consignee Address 2 |
string |
None. |
| ConsigneeCity |
Consignee City |
string |
None. |
| ConsigneeState |
Consignee State |
string |
None. |
| ConsigneePostalCode |
Consignee PostalCode |
string |
None. |
| ConsigneeCountry |
Consignee Country |
string |
None. |
Response Formats
application/json, text/json
{
"OrderNo": "sample string 1",
"WarehouseID": 2,
"WarehouseCode": "sample string 3",
"AccountNo": "sample string 4",
"SenderName": "sample string 5",
"SenderAddress": "sample string 6",
"AlternateReferenceNumber": "sample string 7",
"ReferenceNumber": "sample string 8",
"ReferenceNumber2": "sample string 9",
"OrderDate": "sample string 10",
"OrderInfo": "sample string 11",
"Weight": 12.1,
"MerchantName": "sample string 13",
"ParcelDescription": "sample string 14",
"ParcelClassification": "sample string 15",
"ParcelValue": 16.1,
"ParcelLength": 17,
"ParcelHeight": 18,
"ParcelWidth": 19,
"DimensionWeight": 20.1,
"OrderReceivedViaAPI": 21,
"ParcelItemCount": 22,
"Currency": "sample string 23",
"ConsigneeName": "sample string 24",
"ConsigneeContactNumber": "sample string 25",
"ConsigneeEmail": "sample string 26",
"ConsigneeAddress1": "sample string 27",
"ConsigneeAddress2": "sample string 28",
"ConsigneeCity": "sample string 29",
"ConsigneeState": "sample string 30",
"ConsigneePostalCode": "sample string 31",
"ConsigneeCountry": "sample string 32"
}
application/xml, text/xml
<OrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TreelinkWebAPI"> <AccountNo>sample string 4</AccountNo> <AlternateReferenceNumber>sample string 7</AlternateReferenceNumber> <ConsigneeAddress1>sample string 27</ConsigneeAddress1> <ConsigneeAddress2>sample string 28</ConsigneeAddress2> <ConsigneeCity>sample string 29</ConsigneeCity> <ConsigneeContactNumber>sample string 25</ConsigneeContactNumber> <ConsigneeCountry>sample string 32</ConsigneeCountry> <ConsigneeEmail>sample string 26</ConsigneeEmail> <ConsigneeName>sample string 24</ConsigneeName> <ConsigneePostalCode>sample string 31</ConsigneePostalCode> <ConsigneeState>sample string 30</ConsigneeState> <Currency>sample string 23</Currency> <DimensionWeight>20.1</DimensionWeight> <MerchantName>sample string 13</MerchantName> <OrderDate>sample string 10</OrderDate> <OrderInfo>sample string 11</OrderInfo> <OrderNo>sample string 1</OrderNo> <OrderReceivedViaAPI>21</OrderReceivedViaAPI> <ParcelClassification>sample string 15</ParcelClassification> <ParcelDescription>sample string 14</ParcelDescription> <ParcelHeight>18</ParcelHeight> <ParcelItemCount>22</ParcelItemCount> <ParcelLength>17</ParcelLength> <ParcelValue>16.1</ParcelValue> <ParcelWidth>19</ParcelWidth> <ReferenceNumber>sample string 8</ReferenceNumber> <ReferenceNumber2>sample string 9</ReferenceNumber2> <SenderAddress>sample string 6</SenderAddress> <SenderName>sample string 5</SenderName> <WarehouseCode>sample string 3</WarehouseCode> <WarehouseID>2</WarehouseID> <Weight>12.1</Weight> </OrderModel>