Operation Get Orders By Criteria
Method: HTTP POST method
Endpoint:http://<host_address>:<port_address>/v1/ordersByCriteria
Parameter content type: application/json
The order search criteria is 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
:
{ "sortCriteria": { "sortFields": [ { "field": "ORDER_ID", "sortBy": "ASC", "sortSequence": 0 } ] }, "orderId": "string", "orderRef": "string", "customerID": "string", "subscriberID": "string", "dateRange": { "startDate": "2022-09-13T09:51:54.778Z", "endDate": "2022-09-13T09:51:54.778Z" }, "status": [ "string" ], "headerUdfs": [ { "name": "string", "value": "string" } ], "orderLineUdfs": [ { "name": "string", "value": "string" } ], "pagination": { "startRecord": 0, "endRecord": 0, "totalRecords": 0 }, "count": 0, "orderSummary": true, "criteria": "string", "parameters": { "params": [ { "key": "string", "value": "string" } ] }, "externalBusinessTransactionID": "string" }