The Volt Task Results endpoints can be used to retrieve, create, update, or delete task results.
Endpoints
GET Task Results
Get the results of an active task.
Mandatory Headers
| Parameter | Description | Required | Sample Value |
|---|---|---|---|
| WM_CONSUMER.ID | The Walmart-provided unique ID required to access the API. | Yes | 9489efe4-3fe7-47c9-9f7b-30f8dc99b10d |
| WM_SVC.NAME | The Service Registry Application Key. | Yes | WATT_TASK_QA |
| WM_SVC.ENV | The Service Registry environment name (i.e, stg, prod). | Yes | stg |
| WM-SITE-ID | The Walmart-provided Site ID from which the call originated (Ex. WM-US, WMT-MX, WMT-CA). | Yes | 1694066566785477000 |
Path Parameters
| Parameter | Description | Required | Sample Value |
|---|---|---|---|
| task-id | The ID of the associated task. | Yes | 6f8bc617-dc24-4fd0-acb3-5c797cab597d |
Response Body Details
| Parameter | Description | Data Type |
|---|---|---|
| task_id | The ID of the associated task. | String |
| duration_minutes | The number of minutes actually spent on the task by all of the Reps that worked on it. | Integer |
| performed_by | The array of users that worked on the task. | Array |
| reference_number | The reference number of the user that performed the task. | String |
| performed_at | The time that the task was performed, in UTC format. | String |
POST Task Results
Create or update a task result.
Mandatory Headers
| Parameter | Description | Required | Sample Value |
|---|---|---|---|
| WM_CONSUMER.ID | The Walmart-provided unique ID required to access the API. | Yes | 9489efe4-3fe7-47c9-9f7b-30f8dc99b10d |
| WM_SVC.NAME | The Service Registry Application Key. | Yes | WATT_TASK_QA |
| WM_SVC.ENV | The Service Registry environment name (i.e, stg, prod). | Yes | stg |
| WM-SITE-ID | The Walmart-provided Site ID from which the call originated (Ex. WM-US, WMT-MX, WMT-CA). | Yes | 1694066566785477000 |
Path Parameters
| Parameter | Description | Required | Sample Value |
|---|---|---|---|
| task-id | The ID of the associated task. | Yes | 6f8bc617-dc24-4fd0-acb3-5c797cab597d |
Request Body Parameters
| Parameter | Description | Data Type |
|---|---|---|
| duration_minutes | The number of minutes that the task is expected to take. | Integer |
| performed_by | The array of users that will work on the task. | Array |
| reference_number | The reference number of the user that performed the task. | String |
| performed_at | The time that the task was performed, in UTC format. | Date |
Response Body Details
| Parameter | Description | Data Type |
|---|---|---|
| task_id | The ID of the associated task. | String |
| duration_minutes | The number of minutes actually spent on the task by all of the Reps that worked on it. | Integer |
| performed_by | The array of users that worked on the task. | Array |
| reference_number | The reference number of the user that performed the task. | String |
| performed_at | The time that the task was performed, in UTC format. | Date |
DELETE Task Results
Delete a task result using the referenceNumber and fieldGroupid composite key.
Mandatory Headers
| Parameter | Description | Required | Sample Value |
|---|---|---|---|
| WM_CONSUMER.ID | The Walmart-provided unique ID required to access the API. | Yes | 9489efe4-3fe7-47c9-9f7b-30f8dc99b10d |
| WM_SVC.NAME | The Service Registry Application Key. | Yes | WATT_TASK_QA |
| WM_SVC.ENV | The Service Registry environment name (i.e, stg, prod). | Yes | stg |
| WM-SITE-ID | The Walmart-provided Site ID from which the call originated (Ex. WM-US, WMT-MX, WMT-CA). | Yes | 1694066566785477000 |
Path Parameters
| Parameter | Description | Required | Sample Value |
|---|---|---|---|
| task-id | The ID of the associated task. | Yes | 6f8bc617-dc24-4fd0-acb3-5c797cab597d |
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
