The Volt Users API can be used to retrieve, add, invite, and/or update Field employees. Please note that Provider Admins cannot be added using this API.
Endpoints
GET User Log
Get user log details.
Request Parameters
| Parameter | Description | Data Type |
|---|---|---|
| transactionId | A system-assigned identifier that can be found in a POST response. Returns the status of a POST based on the assigned transactionId. | String |
| statusFilter | Returns a response based on a requested status. Examples: Pending, Failed. | String |
Response Details
| Parameter | Description |
|---|---|
| transactionId | The system-assigned identifier. |
| count | The number of logs returned. |
| additionalProp | Variable descriptors of the status. Examples: Pending, Failed. |
| logs | An array containing log details. |
| The email associated with the entry. | |
| status | The status of the entry. Examples: Pending, Failed. |
| employeeNumber | The employee number associated with the entry. |
| message | Messages associated with the entry. |
GET Users
Get user details.
Request Parameters
| Parameter | Description | Data Type |
|---|---|---|
| Sort | The way data being returned is sorted. Examples: EmployeeNumber, UpdatedDate. Prefix the sort request with a minus to sort descending. | 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) |
GET User (Employee Number)
Get users based on Employee Number.
Request Parameters
| Parameter | Description | Data Type |
|---|---|---|
| employeeNumber | The Field Employees's employee number. | String |
POST Users
Post user details.
Request Details
| Parameter | Description |
|---|---|
| nickName | The user's nickname. |
| operatorName | The operator name. |
| firstName | The user's first name. |
| lastName | The user's last name. |
| The user's email. | |
| address1 | The first line of the user's address. |
| address2 | The second line of the user's address. |
| city | The user's city. |
| state | The user's state. |
| zip | The user's zip code. |
| phone | The user's phone number. |
| imageUrl | The user's image. |
| department | The user's department. |
| title | The user's title. |
| manager | An array containing the manager's details. |
| name | The manager's name. |
| employeeNumber | The manager's employee number. |
| The manager's email. | |
| status | The user's status. |
| certifications | The user's certifications. |
Response Details
| Parameter | Description |
|---|---|
| transactionId | The system-assigned identifier. |
| count | The number of logs returned. |
| additionalProp | Variable descriptors of the status. Examples: Pending, Failed. |
| logs | An array containing log details. |
| The email associated with the entry. | |
| status | The status of the entry. Examples: Pending, Failed. |
| employeeNumber | The employee number associated with the entry. |
| message | Messages associated with the entry. |
POST Invites
Post invites details.
Response Details
| Parameter | Description |
|---|---|
| transactionId | The system-assigned identifier. |
| count | The number of logs returned. |
| additionalProp | Variable descriptors of the status. Examples: Pending, Failed. |
| logs | An array containing log details. |
| The email associated with the entry. | |
| status | The status of the entry. Examples: Pending, Failed. |
| employeeNumber | The employee number associated with the entry. |
| message | Messages associated with the entry. |
POST Invites (Employee Number)
Post invites details.
Request Parameters
| Parameter | Description | Data Types |
|---|---|---|
| employeeNumber | The employee number associated with the entry. | String |
Response Details
| Parameter | Description |
|---|---|
| transactionId | The system-assigned identifier. |
| count | The number of logs returned. |
| additionalProp | Variable descriptors of the status. Examples: Pending, Failed. |
| logs | An array containing log details. |
| The email associated with the entry. | |
| status | The status of the entry. Examples: Pending, Failed. |
| employeeNumber | The employee number associated with the entry. |
| message | Messages associated with the entry. |
PUT Users (Employee Number)
Put users details.
Request Parameters
| Parameter | Description | Data Types |
|---|---|---|
| employeeNumber | The employee number associated with the entry. | String |
Request Details
| Parameter | Description |
|---|---|
| nickName | The user's nickname. |
| operatorName | The operator name. |
| firstName | The user's first name. |
| lastName | The user's last name. |
| The user's email. | |
| address1 | The first line of the user's address. |
| address2 | The second line of the user's address. |
| city | The user's city. |
| state | The user's state. |
| zip | The user's zip code. |
| phone | The user's phone number. |
| imageUrl | The user's image. |
| department | The user's department. |
| title | The user's title. |
| manager | An array containing the manager's details. |
| name | The manager's name. |
| employeeNumber | The manager's employee number. |
| The manager's email. | |
| status | The user's status. |
| certifications | The user's certifications. |
Response Details
| Parameter | Description |
|---|---|
| transactionId | The system-assigned identifier. |
| count | The number of logs returned. |
| additionalProp | Variable descriptors of the status. Examples: Pending, Failed. |
| logs | An array containing log details. |
| The email associated with the entry. | |
| status | The status of the entry. Examples: Pending, Failed. |
| employeeNumber | The employee number associated with the entry. |
| message | Messages associated with the entry. |
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.
©️Walmart | All Rights Reserved
