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.
PayOrderFilterCriteria| Name | Description | 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": "3935f4db-cc06-400a-894a-70a3f09a495f",
"Name": "sample string 1",
"TenantId": "f555301c-198c-4fa8-8e57-e52d183cffcd",
"UserId": "d19f3285-4021-40d6-9a12-6130b297fb92",
"Temporary": true,
"Completed": true,
"Dispatched": true,
"Status": "sample string 2",
"ExternalProductionId": "sample string 3",
"SearchQuery": "sample string 4",
"CreationDateStartUtc": "2026-07-05T15:23:50.557743+00:00",
"CreationDateEndUtc": "2026-07-05T15:23:50.557743+00:00",
"ModifiedDateStartUtc": "2026-07-05T15:23:50.557743+00:00",
"ModifiedDateEndUtc": "2026-07-05T15:23:50.557743+00:00",
"PaymentDateStartUtc": "2026-07-05T15:23:50.557743+00:00",
"PaymentDateEndUtc": "2026-07-05T15:23:50.557743+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-07-05T15:23:50.557743+00:00</CreationDateEndUtc> <CreationDateStartUtc>2026-07-05T15:23:50.557743+00:00</CreationDateStartUtc> <Dispatched>true</Dispatched> <ExternalProductionId>sample string 3</ExternalProductionId> <Id>3935f4db-cc06-400a-894a-70a3f09a495f</Id> <ModifiedDateEndUtc>2026-07-05T15:23:50.557743+00:00</ModifiedDateEndUtc> <ModifiedDateStartUtc>2026-07-05T15:23:50.557743+00:00</ModifiedDateStartUtc> <Name>sample string 1</Name> <PaymentDateEndUtc>2026-07-05T15:23:50.557743+00:00</PaymentDateEndUtc> <PaymentDateStartUtc>2026-07-05T15:23:50.557743+00:00</PaymentDateStartUtc> <SearchQuery>sample string 4</SearchQuery> <Status>sample string 2</Status> <Temporary>true</Temporary> <TenantId>f555301c-198c-4fa8-8e57-e52d183cffcd</TenantId> <UserId>d19f3285-4021-40d6-9a12-6130b297fb92</UserId> </PayOrderFilterCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.