The Events API retrieves a list of Check In/Out visits (events) that have been executed by Field Employees.

Endpoints

GET

/admin/v3/events

Request Parameters

Parameter	Description	Data Type
UpdatedStart	Returns events searched based on the updated field. If an event is created and not updated, the updated field will match the created field by default.	String($Date-time)
UpdatedEnd	Returns events searched based on the updated field. If an event is created and not updated, the updated field will match the created field by default.	String($Date-time)
EmployeeNumber	The identifying employee number associated with events you are requesting.	String
Limit	Limits the number of events that are returned so system is not overwhelmed. Used with Offset to retrieve in batches.	Integer($int32)
Offset	If not specified it will grab the first “limited amount”. If you want to get the next batch you will need to offset by that value.	Integer($int32)
EventId	This field can be used if you want to get details about a specific event.	Integer($int32)
sort	The way data being returned is sorted. Examples: EmployeeNumber, UpdatedDate. Prefix the sort request with a minus to sort descending.	String

Response Details

Parameter	Description
totalCount	Returns the total number of events in the response for this employee.
results	An Array containing details of the events returned in the response.
id	An ID associated with the event. This is automatically created by the system and can be used to get details of a specific event (optional).
employeeNumber	The employee number of the employee associated with the event.
number	The store number associated with the event.
retailer	The name of the retailer associated with the event.
lat	The latitude coordinate of the event location (optional).
Long	The latitude coordinate of the event location (optional).
invoiced	Denotes whether or not the event is invoiced (true/false).
metersFromLocation	Provides the distance from the store where the user checked in or out on the app.
utilizedBadge	Indicates whether or not the employee checked in/out with their badge.
manuallyAlteredTime	Indicates if the event time has been manually altered (true/false).
reportedTime	The event time reported, in UTC Date/time format.
systemTime	The event time recorded by the system, in UTC Date/time format.
offset	Can be used to retrieve events in batches. If not specified it will grab the first “limited amount”. If you want to get the next batch you will need to offset by that value.
limit	Limits the number of events that are returned. Used with Offset to retrieve in batches.
sortBy	Returns the column name data is being sorted by, based on sort requested.
sortAscending	Indicate if the returned events are sorted ascending (true/false). Prefix with a minus in the sort parameter for descending.

For any technical or support questions, please contact us.

Please note: Provider organizations are responsible for providing support for their employees. Walmart Volt only provides support to Provider Administrators and the Field Group’s technical team, enabling each company to properly support the field reps.

Disclaimer

Your use of the API documentation is at your own discretion and risk. To the maximum extent permitted by law, the APIs, documentation and all related software, components, and support are provided by Walmart on an "as-is" and "as available" basis without any warranties of any kind, and Walmart expressly disclaims any and all express and implied warranties, including, but not limited to, warranties of merchantability, fitness for a particular purpose, title, noninfringement, non-interference, and warranties arising from a course of dealing. You acknowledge that Walmart does not warrant that the APIs will be uninterrupted, timely, secure, or error-free. Walmart may modify and delete API documentation in its sole discretion and without notice.

In no event shall Walmart be liable to you or any third parties for any damages whatsoever, including, without limitation, those resulting from loss of use, damage to your computer system, loss of data or profits, or any liability arising out of or in connection with the use of the APIs, documentation, software, components, or support.