Tool to search for orders in OptimoRoute based on criteria. Use when you need to find orders by date range, order identifiers, or order status. At least one of 'orders' or 'date_range' must be provided.
limitintegerMaximum number of orders to return per request. Use with after_tag for paginated retrieval.
ordersarrayList of order identifier objects to search for. Each object can contain either 'orderNo' or 'id' field.
afterTagstringCursor for pagination. Pass the 'afterTag' value from a previous response to retrieve the next page of results.
dateRangeobjectDate range criteria for searching orders.
orderStatusarrayFilter by order status values (e.g., 'failed', 'rejected')
includeOrderDatabooleanWhen true, includes full order data in the response. Default: false.
includeScheduleInformationbooleanWhen true, includes scheduling information in the response. Default: false.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.