Obtener tareas por producto

Este endpoint devuelve todas las tareas habilitadas dentro de un producto.

GET /api/v1/businesses/{businessId}/product/{productId}/locations

Si los datos incluidos en la petición son correctos —tanto el businessId como el productId—, la respuesta contendrá las tareas habilitadas para cada zona del producto.

A continuación, se muestra un fragmento de respuesta:

[
    {
        "color": "#c7d0e9",
        "description": "Opening tasks",
        "name": "OPENING",
        "shortName": "OP",
        "requiredLevel": 2,
        "priority": 4,
        "maxResources": 1,
        "type": "FIXED",
        "shouldAvoidOvercover": true,
        "system": false,
        "category": "Fixed tasks",
        "product": "0001-GENERAL",
        "id": "01",
        "active": true,
        "zone": "General"
    },
    {
        "color": "#c7d0e9",
        "description": "Opening tasks",
        "name": "OPENING",
        "shortName": "OP",
        "requiredLevel": 2,
        "priority": 4,
        "maxResources": 1,
        "type": "FIXED",
        "shouldAvoidOvercover": true,
        "system": false,
        "category": "Fixed tasks",
        "product": "0001-GENERAL",
        "id": "01",
        "active": true,
        "zone": "Z1"
    },
    {
        "color": "#425ea9",
        "description": "Replenishment of merchandise",
        "name": "REPLACEMENT",
        "shortName": "REP",
        "requiredLevel": 2,
        "priority": 3,
        "type": "FIXED",
        "shouldAvoidOvercover": false,
        "system": false,
        "category": "Operational",
        "product": "0001-GENERAL",
        "id": "05",
        "active": true,
        "zone": "General"
    }
]

Como se puede apreciar en el ejemplo, si una tarea está habilitada en varias zonas del producto, la respuesta contendrá la información para cada una de las zonas: en este caso, la tarea OPENING está habilitada en las zonas General y Z1, mientras que la tarea REPLACEMENT solo está habilitada en la zona General.

El nivel de detalle de la respuesta dependerá de la información que se haya definido previamente para la tarea. Por ejemplo, si no se ha añadido descripción (description), no aparecerá este campo.

Aspectos que tener en cuenta

Si no hay tareas activas en el producto indicado, la petición devolverá un array vacío [].

Si el producto indicado en la URL no existe en el negocio, la petición devolverá un error 404 Not Found, especificando en el mensaje not exits.

Enlaces de interés

¿Qué es una tarea?

¿Cómo es la estructura de una tarea?