Operation Get Orders By Criteria
Method: HTTP POST method
Endpoint: http://<host_address>:<port_address>/v2/orders/criteria
Parameter content type: application/json
The order of search criteria are as follows:
orderId
orderRef
customerId
subscriberId
dateRange
status
headerUdfs
orderLineUdfs
Note:
Only the following combinations are allowed and no other combinations of search criteria are allowed:
dateRange
andstatus
dateRange
andheaderUdfs
dateRange
andorderLineUdfs
Example of
ordersByCriteria
:
{ "orderId": [ "string" ], "orderRef": [ "string" ], "customerID": [ "string" ], "subscriberID": [ "string" ], "dateRange": { "startDate": "2023-10-09T19:37:50.867Z", "endDate": "2023-10-09T19:37:50.867Z" }, "status": [ "START, BLOCKED, PENDING, OPD, OPDERROR, EXECUTION, COMPLETE, CANCELLED, SUSPENDED, SUSPENDING, PREQUALIFICATIONFAILED, WITHDRAWN, FEASIBILITY" ], "headerUdfs": [ { "name": "string", "value": "string" } ], "orderLineUdfs": [ { "name": "string", "value": "string" } ], "currentPage": 0, "recordsPerPage": 0, "filterOperator": "IN" }