POST api/{ext}/order/Search

Request Information

URI Parameters

Name	Description	Type	Additional information
ext		string	None.

Body Parameters

SearchOrderParm

Name	Type	Additional information
AccountNumber	string	None.
StartDate	date	None.
EndDate	date	None.
TrackingNumber	string	None.
Contents	string	None.
Reference	string	None.
Reference2	string	None.
Reference3	string	None.
Reference4	string	None.
Reference5	string	None.
ReferenceTypeID	integer	None.
ReferenceTypeID2	integer	None.
ReferenceTypeID3	integer	None.
ReferenceTypeID4	integer	None.
ReferenceTypeID5	integer	None.
PickupCityName	string	None.
PickupCountryID	string	None.
DeliveryCityName	string	None.
DeliveryCountryID	string	None.
WeightUOM	string	None.
SizeUOM	string	None.
DistanceUOM	string	None.
InvoiceNumber	integer	None.
CalledInBy	string	None.
TmsType	string	None.
OrderStatus	string	None.
PickupPostalCode	string	None.
PickupStateProvID	string	None.
DeliveryPostalCode	string	None.
DeliveryStateProvID	string	None.
ReferenceTypeID6	integer	None.
ReferenceTypeID7	integer	None.
ReferenceTypeID8	integer	None.
ReferenceTypeID9	integer	None.
Format	string	None.
Columns	Collection of SearchOrdersLayoutColumn	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountNumber": "sample string 1",
  "StartDate": "2025-11-01T00:06:08.3941434+00:00",
  "EndDate": "2025-11-01T00:06:08.3941434+00:00",
  "TrackingNumber": "sample string 2",
  "Contents": "sample string 3",
  "Reference": "sample string 4",
  "Reference2": "sample string 5",
  "Reference3": "sample string 6",
  "Reference4": "sample string 7",
  "Reference5": "sample string 8",
  "ReferenceTypeID": 1,
  "ReferenceTypeID2": 1,
  "ReferenceTypeID3": 1,
  "ReferenceTypeID4": 1,
  "ReferenceTypeID5": 1,
  "PickupCityName": "sample string 9",
  "PickupCountryID": "sample string 10",
  "DeliveryCityName": "sample string 11",
  "DeliveryCountryID": "sample string 12",
  "WeightUOM": "sample string 13",
  "SizeUOM": "sample string 14",
  "DistanceUOM": "sample string 15",
  "InvoiceNumber": 1,
  "CalledInBy": "sample string 16",
  "TmsType": "sample string 17",
  "OrderStatus": "sample string 18",
  "PickupPostalCode": "sample string 19",
  "PickupStateProvID": "sample string 20",
  "DeliveryPostalCode": "sample string 21",
  "DeliveryStateProvID": "sample string 22",
  "ReferenceTypeID6": 1,
  "ReferenceTypeID7": 1,
  "ReferenceTypeID8": 1,
  "ReferenceTypeID9": 1,
  "Format": "sample string 23",
  "Columns": [
    {
      "Title": "sample string 1",
      "Key": "sample string 2",
      "DataIndex": "sample string 3",
      "DefaultHidden": true,
      "Type": "sample string 5"
    },
    {
      "Title": "sample string 1",
      "Key": "sample string 2",
      "DataIndex": "sample string 3",
      "DefaultHidden": true,
      "Type": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<SearchOrderParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.ShipperPortal.Models">
  <AccountNumber>sample string 1</AccountNumber>
  <CalledInBy>sample string 16</CalledInBy>
  <Columns>
    <SearchOrdersLayoutColumn>
      <DataIndex>sample string 3</DataIndex>
      <DefaultHidden>true</DefaultHidden>
      <Key>sample string 2</Key>
      <Title>sample string 1</Title>
      <Type>sample string 5</Type>
    </SearchOrdersLayoutColumn>
    <SearchOrdersLayoutColumn>
      <DataIndex>sample string 3</DataIndex>
      <DefaultHidden>true</DefaultHidden>
      <Key>sample string 2</Key>
      <Title>sample string 1</Title>
      <Type>sample string 5</Type>
    </SearchOrdersLayoutColumn>
  </Columns>
  <Contents>sample string 3</Contents>
  <DeliveryCityName>sample string 11</DeliveryCityName>
  <DeliveryCountryID>sample string 12</DeliveryCountryID>
  <DeliveryPostalCode>sample string 21</DeliveryPostalCode>
  <DeliveryStateProvID>sample string 22</DeliveryStateProvID>
  <DistanceUOM>sample string 15</DistanceUOM>
  <EndDate>2025-11-01T00:06:08.3941434+00:00</EndDate>
  <Format>sample string 23</Format>
  <InvoiceNumber>1</InvoiceNumber>
  <OrderStatus>sample string 18</OrderStatus>
  <PickupCityName>sample string 9</PickupCityName>
  <PickupCountryID>sample string 10</PickupCountryID>
  <PickupPostalCode>sample string 19</PickupPostalCode>
  <PickupStateProvID>sample string 20</PickupStateProvID>
  <Reference>sample string 4</Reference>
  <Reference2>sample string 5</Reference2>
  <Reference3>sample string 6</Reference3>
  <Reference4>sample string 7</Reference4>
  <Reference5>sample string 8</Reference5>
  <ReferenceTypeID>1</ReferenceTypeID>
  <ReferenceTypeID2>1</ReferenceTypeID2>
  <ReferenceTypeID3>1</ReferenceTypeID3>
  <ReferenceTypeID4>1</ReferenceTypeID4>
  <ReferenceTypeID5>1</ReferenceTypeID5>
  <ReferenceTypeID6>1</ReferenceTypeID6>
  <ReferenceTypeID7>1</ReferenceTypeID7>
  <ReferenceTypeID8>1</ReferenceTypeID8>
  <ReferenceTypeID9>1</ReferenceTypeID9>
  <SizeUOM>sample string 14</SizeUOM>
  <StartDate>2025-11-01T00:06:08.3941434+00:00</StartDate>
  <TmsType>sample string 17</TmsType>
  <TrackingNumber>sample string 2</TrackingNumber>
  <WeightUOM>sample string 13</WeightUOM>
</SearchOrderParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.