Skip to main content
All CollectionsAPI
Get Customer’s Tasks
Get Customer’s Tasks

Learn how to get Customers' Tasks

eLogii avatar
Written by eLogii
Updated over 8 months ago

View Customer’s Tasks

Tasks can be attributed to commonly served clients who are referred to as customers on the eLogii platform. This may be for the purpose of reporting or automatically applying task attributes such as pickup or delivery location based on the customer configuration settings. Depending on the setup, tasks can either be set for a specific date or viable for execution over a range of days.

Get Customer’s Tasks for a specific date

To get the list of tasks for a customer, the request must contain the ‘customer UID’ which is indicated as customer.uid=CUS-XXXXXXXX or ‘customer ID’ indicated as customer._id=00000000000000 and the date.

The customer UID and customer ID can be found in the response received when viewing all customers ‘GET:/customers’ . Alternatively, the customer UID can also be found on eLogii→ customers→profile.

Example:

Request

Customer ID

Customer UID

Response

{
"_id": "64f5505f72c72cfc9db8c74f",
"uid": "T-Q0BHVWMN",
"organization": "64706d34cb58b5e1345160d2",
"path": "64706d34cb58b5e1345160d2",
"type": 2,
"dateRange": null,
"allowedWeekDays": null,
"pickup": {
.......
},
"location": {
......
}
}

Get customers’ tasks set for a date range

To retrieve tasks for a date range, the request should contain two dates: the start date and the end date and either the customer UID or customer ID indicates as (customer.uid=CUS-XXXXXXXX , customer._id=00000000000000) respectively.

Example:

Request

Customer ID

Customer UID

Response:

{
"_id": "65110cbf09e31ab5c8d41e2a",
"uid": "T-8WTWS962",
"organization": "64706d34cb58b5e1345160d2",
"path": "64706d34cb58b5e1345160d2",
"type": 2,
"dateRange": {
"startDate": 20240405,
"endDate": 20240407
},
"allowedWeekDays": null,
"pickup": {
........
},
"location": {
.........
},
"size": {
"Weight": 0
},
"items": [],
"customer": {
"_id": "65f0daf95b61d1812d249c11",
"uid": "CUS-NUNV1QAI",
"info": {
"name": "Test customer"
}
}
Did this answer your question?