Retrieving tasks through the eLogii API requires some parameters to be queried. When the query is invalid, the validation returns a message that says "where" is invalid. The Where is denoted as a question mark on the API endpoint like so GET
(/tasks?date=20230714&customer.uid=CUS-XXXXXXXXX).
This means that the request must contain either of the following:- id, uid, shipment, reference, externalId, date, dateTimeWindows.date
Task ID
The task ID can be found on the API response received when creating tasks (POST /tasks
). This parameter is key when retrieving details about a specific task.
Task UID
Like the task ID, using the task UID as a query parameter is handy when retrieving a single task. It can be found in the response received when creating tasks or on eLogii→ tasks → details → basic info.
elogii
API response
Reference
The task reference can be found on the elogii → tasks → details → basic info.
External ID
This can be found on the elogii → tasks → details → basic info or in the API response received when creating a task.
DateTimeWindows.date
This parameter can be found in the API response received after creating a task through the (POST /tasks
) endpoint.
Date
The date parameter is useful and mandatory when retrieving many tasks or tasks attributed to a specific customer. It should be written in the format ‘YYYYMMDD’