The Volt Tasks endpoints can be used to retrieve, create, update, or delete active tasks.
Please note: Use of the Task APIs requires proper permissioning with the associated field_group_id. If your company has not been permissioned with the field_group_id passed in the request, or you continue to receive a 403 error when attempting to access the APIs, please contact support or your Volt representative.
Endpoints
GET Tasks
Get active tasks.
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 |
Query Parameters
| Parameter | Description | Required | Data Type |
|---|---|---|---|
| field_group_id | Can be used to filter by a specific Field Group ID. | No | String |
| reference_number | Can be used to filter by the reference number of the user that performed the task. | No | String |
| offset | Can be used to retrieve tasks in batches. If not specified it will grab the first “limited amount”. To get the next batch offset by that value. | No | Integer |
| limit | Limits the number of tasks that are returned. Used with Offset to retrieve in batches. | No | Integer |
| sort | The way data being returned should be sorted. Examples: field_group_id, task_id. Prefix the sort request with a minus to sort descending. | No | String |
Response Body Details
| Parameter | Description | Data Type |
|---|---|---|
| offset | The offset value for the response. | Integer |
| limit | The task limit being returned. Used with Offset to retrieve in batches. | Integer |
| total count | The total number of tasks in the response for this Field Group. | Integer |
| sort | Returns the column the data is being sorted by, based on the sort requested. | String |
| items | The array containing the task details. | Array |
| task_id | The ID of the associated task. | String |
| field_group_id | The ID of the associated Field Group. | String |
| name | The Vendor name that the task is being performed on behalf of. | String |
| description | The description of the task. | String |
| service_model | Specifies how the work is generally categorized. Examples: retailer-funded, continuity, project. | String |
| location_id | The ID of the location where the task was performed. | String |
| task_type_id | The ID of the task type that will be performed. This must be a Task Type ID that has been assigned to the Field Group. | String |
| vendor | The Vendor associated with the task. | Object |
| number | The Vendor number that identifies the vendor that the task is being performed on behalf of. | String |
| name | The Vendor name that the task is being performed on behalf of. | String |
| items | The array of items that the task will perform activities for - there must be at least one item. | Array |
| gtin | The 14-digit Global Trade Item Number that uniquely identifies the items. | String |
| department_number | The department number that the task will be performed in - not required if the GTIN is supplied. | String |
| schedule | The object containing the scheduled details. | Object |
| duration_minutes | The number of minutes that the task is expected to take. | Integer |
| visit_start_by | The beginning of the time window that the task is expected to be performed in. | String |
| visit_end_by | The end of the time window that the task is expected to be performed in. | String |
| result_due_by | The time that the task is due to be completed. | String |
| is_active | Indicates whether or not the task is active (True, False). | Boolean |
POST Tasks
Create or update a task with upsert task command.
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 |
Request Parameters
| Parameter | Description | Data Type |
|---|---|---|
| field_group_id | The ID of the associated Field Group. | String |
| reference_number | The reference number associated with the task. | String |
| name | The Vendor name that the task is being performed on behalf of. | String |
| description | The description of the task. | String |
| service_model | Specifies how the work is generally categorized. Examples: retailer-funded, continuity, project. | String |
| location_id | The ID of the location where the task was performed. | String |
| task_type_id | The ID of the task type that will be performed. This must be a Task Type ID that has been assigned to the Field Group. | String |
| vendor_number | Vendor that the task is being performed on behalf of. | String |
| items | The array of items that the task will perform activities for - there must be at least one item. | Array |
| gtin | The 14-digit Global Trade Item Number that uniquely identifies the items. | String |
| department_number | The department number that the task will be performed in - not required if the GTIN is supplied. | String |
| schedule | The object containing the scheduled details. | Object |
| duration_minutes | The number of minutes that the task is expected to take. | Integer |
| visit_start_by | The beginning of the time window that the task is expected to be performed in. | String |
| visit_end_by | The end of the time window that the task is expected to be performed in. | String |
| result_due_by | The time that the task is due to be completed. | String |
Response Body Details
| Parameter | Description | Data Type |
|---|---|---|
| task_id | The ID associated with the task. | String |
| field_group_id | The ID of the associated Field Group. | String |
| reference_number | The reference number associated with the task. | String |
| name | The Vendor name that the task is being performed on behalf of. | String |
| description | The description of the task. | String |
| service_model | Specifies how the work is generally categorized. Examples: retailer-funded, continuity, project. | String |
| location_id | The ID of the location where the task was performed. | String |
| task_type_id | The ID of the task type that will be performed. This must be a Task Type ID that has been assigned to the Field Group. | String |
| vendor | The Vendor associated with the task. | Object |
| number | The Vendor number that identifies the vendor that the task is being performed on behalf of. | String |
| name | The Vendor name that the task is being performed on behalf of. | String |
| items | The array of items that the task will perform activities for - there must be at least one item. | Array |
| gtin | The 14-digit Global Trade Item Number that uniquely identifies the items. | String |
| department_number | The department number that the task will be performed in - not required if the GTIN is supplied. | String |
| schedule | The object containing the scheduled details. | Object |
| duration_minutes | The number of minutes that the task is expected to take. | integer |
| visit_start_by | The beginning of the time window that the task is expected to be performed in. | String |
| visit_end_by | The end of the time window that the task is expected to be performed in. | String |
| result_due_by | The time that the task is due to be completed. | String |
| is_active | Indicates whether or not the task is active (True, False). | Boolean |
DELETE Tasks
Delete a task using the Task ID.
Mandatory Headers
| Parameter | Description | Required | Sample Value |
|---|---|---|---|
| TASK_ID | The ID of the requested task. (Should be a ID of a Existing Task) | Yes | 6f8bc617-dc24-4fd0-acb3-5c797cab597d |
| 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
