POST api/Order/Search
Request Information
URI Parameters
None.
Body Parameters
SearchOrdersParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| TrackingValue | string |
None. |
|
| PickupNumber | integer |
None. |
|
| WaybillNumber | string |
None. |
|
| AccountNumber | string |
None. |
|
| AccountType | string |
None. |
|
| PuDateStart | date |
None. |
|
| PuDateEnd | date |
None. |
|
| PuDateType | string |
None. |
|
| DelDateStart | date |
None. |
|
| DelDateEnd | date |
None. |
|
| DelDateType | string |
None. |
|
| ServiceID | integer |
None. |
|
| Reference | string |
None. |
|
| PuCode | string |
None. |
|
| PuName | string |
None. |
|
| PuCity | string |
None. |
|
| PuState | string |
None. |
|
| PuPostalCode | string |
None. |
|
| PuCountry | string |
None. |
|
| PuAirport | string |
None. |
|
| DelCode | string |
None. |
|
| DelName | string |
None. |
|
| DelCity | string |
None. |
|
| DelState | string |
None. |
|
| DelPostalCode | string |
None. |
|
| DelCountry | string |
None. |
|
| DelAirport | string |
None. |
|
| OfficeType | string |
None. |
|
| OfficeID | integer |
None. |
|
| CourierID | integer |
None. |
|
| InvoiceNumber | integer |
None. |
|
| DeclaredValueStart | decimal number |
None. |
|
| DeclaredValueEnd | decimal number |
None. |
|
| WeightStart | decimal number |
None. |
|
| WeightEnd | decimal number |
None. |
|
| ChargeCode | string |
None. |
|
| AesITN | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"auth": "sample string 1",
"TrackingValue": "sample string 2",
"PickupNumber": 1,
"WaybillNumber": "sample string 3",
"AccountNumber": "sample string 4",
"AccountType": "sample string 5",
"PuDateStart": "2025-12-03T12:34:13.6686351+00:00",
"PuDateEnd": "2025-12-03T12:34:13.6686351+00:00",
"PuDateType": "sample string 6",
"DelDateStart": "2025-12-03T12:34:13.6686351+00:00",
"DelDateEnd": "2025-12-03T12:34:13.6686351+00:00",
"DelDateType": "sample string 7",
"ServiceID": 1,
"Reference": "sample string 8",
"PuCode": "sample string 9",
"PuName": "sample string 10",
"PuCity": "sample string 11",
"PuState": "sample string 12",
"PuPostalCode": "sample string 13",
"PuCountry": "sample string 14",
"PuAirport": "sample string 15",
"DelCode": "sample string 16",
"DelName": "sample string 17",
"DelCity": "sample string 18",
"DelState": "sample string 19",
"DelPostalCode": "sample string 20",
"DelCountry": "sample string 21",
"DelAirport": "sample string 22",
"OfficeType": "sample string 23",
"OfficeID": 1,
"CourierID": 1,
"InvoiceNumber": 1,
"DeclaredValueStart": 1.0,
"DeclaredValueEnd": 1.0,
"WeightStart": 1.0,
"WeightEnd": 1.0,
"ChargeCode": "sample string 24",
"AesITN": "sample string 25"
}
application/xml, text/xml
Sample:
<SearchOrdersParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <AccountNumber>sample string 4</AccountNumber> <AccountType>sample string 5</AccountType> <AesITN>sample string 25</AesITN> <ChargeCode>sample string 24</ChargeCode> <CourierID>1</CourierID> <DeclaredValueEnd>1</DeclaredValueEnd> <DeclaredValueStart>1</DeclaredValueStart> <DelAirport>sample string 22</DelAirport> <DelCity>sample string 18</DelCity> <DelCode>sample string 16</DelCode> <DelCountry>sample string 21</DelCountry> <DelDateEnd>2025-12-03T12:34:13.6686351+00:00</DelDateEnd> <DelDateStart>2025-12-03T12:34:13.6686351+00:00</DelDateStart> <DelDateType>sample string 7</DelDateType> <DelName>sample string 17</DelName> <DelPostalCode>sample string 20</DelPostalCode> <DelState>sample string 19</DelState> <InvoiceNumber>1</InvoiceNumber> <OfficeID>1</OfficeID> <OfficeType>sample string 23</OfficeType> <PickupNumber>1</PickupNumber> <PuAirport>sample string 15</PuAirport> <PuCity>sample string 11</PuCity> <PuCode>sample string 9</PuCode> <PuCountry>sample string 14</PuCountry> <PuDateEnd>2025-12-03T12:34:13.6686351+00:00</PuDateEnd> <PuDateStart>2025-12-03T12:34:13.6686351+00:00</PuDateStart> <PuDateType>sample string 6</PuDateType> <PuName>sample string 10</PuName> <PuPostalCode>sample string 13</PuPostalCode> <PuState>sample string 12</PuState> <Reference>sample string 8</Reference> <ServiceID>1</ServiceID> <TrackingValue>sample string 2</TrackingValue> <WaybillNumber>sample string 3</WaybillNumber> <WeightEnd>1</WeightEnd> <WeightStart>1</WeightStart> <auth>sample string 1</auth> </SearchOrdersParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SearchOrdersResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| Orders | Collection of SearchOrdersItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2",
"Orders": null
}
application/xml, text/xml
Sample:
<SearchOrdersResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> <Orders i:nil="true" /> </SearchOrdersResp>