POST api/orders/select

Retrieves a list of orders that match the given criteria.

Request Information

URI Parameters

None.

Body Parameters

The criteria model to filter orders by.

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	None.
TenantId	globally unique identifier	None.
UserId	globally unique identifier	None.
Temporary	boolean	None.
Completed	boolean	None.
Dispatched	boolean	None.
Status	string	None.
ExternalProductionId	string	None.
SearchQuery	string	None.
CreationDateStartUtc	date	None.
CreationDateEndUtc	date	None.
ModifiedDateStartUtc	date	None.
ModifiedDateEndUtc	date	None.
PaymentDateStartUtc	date	None.
PaymentDateEndUtc	date	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "45becfd9-bcc4-4efc-9e1d-bad1c181891e",
  "Name": "sample string 1",
  "TenantId": "a11c3602-4ad6-4941-9f6e-b4bbc90ecbf4",
  "UserId": "fce7864c-a8d7-4a7e-94fb-e9e0f90b5ca8",
  "Temporary": true,
  "Completed": true,
  "Dispatched": true,
  "Status": "sample string 2",
  "ExternalProductionId": "sample string 3",
  "SearchQuery": "sample string 4",
  "CreationDateStartUtc": "2026-01-21T09:38:54.7309061+00:00",
  "CreationDateEndUtc": "2026-01-21T09:38:54.7309061+00:00",
  "ModifiedDateStartUtc": "2026-01-21T09:38:54.7309061+00:00",
  "ModifiedDateEndUtc": "2026-01-21T09:38:54.7309061+00:00",
  "PaymentDateStartUtc": "2026-01-21T09:38:54.7309061+00:00",
  "PaymentDateEndUtc": "2026-01-21T09:38:54.7309061+00:00"
}

application/xml, text/xml

Sample:

<PayOrderFilterCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Pay.Models.FilterCriteria">
  <Completed>true</Completed>
  <CreationDateEndUtc>2026-01-21T09:38:54.7309061+00:00</CreationDateEndUtc>
  <CreationDateStartUtc>2026-01-21T09:38:54.7309061+00:00</CreationDateStartUtc>
  <Dispatched>true</Dispatched>
  <ExternalProductionId>sample string 3</ExternalProductionId>
  <Id>45becfd9-bcc4-4efc-9e1d-bad1c181891e</Id>
  <ModifiedDateEndUtc>2026-01-21T09:38:54.7309061+00:00</ModifiedDateEndUtc>
  <ModifiedDateStartUtc>2026-01-21T09:38:54.7309061+00:00</ModifiedDateStartUtc>
  <Name>sample string 1</Name>
  <PaymentDateEndUtc>2026-01-21T09:38:54.7309061+00:00</PaymentDateEndUtc>
  <PaymentDateStartUtc>2026-01-21T09:38:54.7309061+00:00</PaymentDateStartUtc>
  <SearchQuery>sample string 4</SearchQuery>
  <Status>sample string 2</Status>
  <Temporary>true</Temporary>
  <TenantId>a11c3602-4ad6-4941-9f6e-b4bbc90ecbf4</TenantId>
  <UserId>fce7864c-a8d7-4a7e-94fb-e9e0f90b5ca8</UserId>
</PayOrderFilterCriteria>

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.