POST api/v1/connect/order/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
platform_account_id	integer	None.
shipto_id	string	None.
shipto_name	string	None.
billto_id	string	None.
orderby_id	string	None.
consignee_code	string	None.
consignee_name	string	None.
shipto_state	string	None.
shipto_zip	string	None.
consignee_state	string	None.
consignee_zip	string	None.
query	string	None.
status	string	None.
cdl_only	boolean	None.
order_no	string	None.
driver_id	string	None.
driver_name	string	None.
sortby	string	None.
sortop	string	None.
order_type	string	None.
reference	string	None.
start	date	None.
end	date	None.

Request Formats

application/json, text/json

Sample:

{
  "platform_account_id": 1,
  "shipto_id": "sample string 2",
  "shipto_name": "sample string 3",
  "billto_id": "sample string 4",
  "orderby_id": "sample string 5",
  "consignee_code": "sample string 6",
  "consignee_name": "sample string 7",
  "shipto_state": "sample string 8",
  "shipto_zip": "sample string 9",
  "consignee_state": "sample string 10",
  "consignee_zip": "sample string 11",
  "query": "sample string 12",
  "status": "sample string 13",
  "cdl_only": true,
  "order_no": "sample string 15",
  "driver_id": "sample string 16",
  "driver_name": "sample string 17",
  "sortby": "sample string 18",
  "sortop": "sample string 19",
  "order_type": "sample string 20",
  "reference": "sample string 21",
  "start": "2025-12-21T04:56:08.3233894+00:00",
  "end": "2025-12-21T04:56:08.3233894+00:00"
}

application/xml, text/xml

Sample:

<OrderFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cogent.BL.Models">
  <billto_id>sample string 4</billto_id>
  <cdl_only>true</cdl_only>
  <consignee_code>sample string 6</consignee_code>
  <consignee_name>sample string 7</consignee_name>
  <consignee_state>sample string 10</consignee_state>
  <consignee_zip>sample string 11</consignee_zip>
  <driver_id>sample string 16</driver_id>
  <driver_name>sample string 17</driver_name>
  <end xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-21T04:56:08.3233894Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </end>
  <order_no>sample string 15</order_no>
  <order_type>sample string 20</order_type>
  <orderby_id>sample string 5</orderby_id>
  <platform_account_id>1</platform_account_id>
  <query>sample string 12</query>
  <reference>sample string 21</reference>
  <shipto_id>sample string 2</shipto_id>
  <shipto_name>sample string 3</shipto_name>
  <shipto_state>sample string 8</shipto_state>
  <shipto_zip>sample string 9</shipto_zip>
  <sortby>sample string 18</sortby>
  <sortop>sample string 19</sortop>
  <start xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-21T04:56:08.3233894Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </start>
  <status>sample string 13</status>
</OrderFilter>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OrderFilter'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.