Consultar medidas (reales)
Este endpoint permite consultar las medidas reales para un periodo de tiempo no superior a 30 días.
GET /api/v1/business/{businessId}/product/{productId}/demand/from/{from}/to/{to}La URL debe contener los siguientes parámetros:
-
Identificador externo del negocio (businessId).
-
Identificador externo del producto o sección (productId).
-
Fecha de inicio de la consulta en formato
yyyy-MM-dd(from). -
Fecha de fin de la consulta en formato
yyyy-MM-dd(to).
Si los datos incluidos en la petición son correctos, la respuesta contendrá el listado de medidas reales del producto en el intervalo de tiempo definido.
A continuación, se muestra un fragmento de respuesta:
GET /api/v1/business/BUSINESSID/product/PRODUCTID/demand/from/2024-07-15/to/2024-07-31[
{
"value": 0.75,
"from": "2024-07-18T20:30:00.000Z",
"to": "2024-07-18T20:45:00.000Z",
"measure": "SALES"
},
{
"value": 0.75,
"from": "2024-07-18T20:45:00.000Z",
"to": "2024-07-18T21:00:00.000Z",
"measure": "SALES"
},
{
"value": 1.25,
"from": "2024-07-17T22:00:00.000Z",
"to": "2024-07-17T22:15:00.000Z",
"measure": "TICKETS"
},
{
"value": 1.25,
"from": "2024-07-17T22:15:00.000Z",
"to": "2024-07-17T22:30:00.000Z",
"measure": "TICKETS"
}
]Aspectos que tener en cuenta
Esta petición devuelve los datos de todas las medidas del producto, sin ordenar.
Los datos siempre se devuelven en UTC y en intervalos de 15 minutos, independientemente de cómo se hayan registrado.
Si no hay medidas reales para ese intervalo, la petición devolverá un array vacío [].
Si el producto especificado en la URL no existe en el negocio, la petición devolverá un error 404 Not Found indicando not exists.
Si el periodo de tiempo consultado excede los 30 días, la petición devolverá un error 406 Not Acceptable.
Filtrar resultados
Debido a que algunos negocios tienen numerosas medidas configuradas, este endpoint posibilita acotar la respuesta y filtrar por tipo.
Para ello, será necesario añadir el parámetro demandTypeNames a la URL:
GET /api/v1/business/{businessId}/product/{productId}/demand/from/{from}/to/{to}?demandTypeNames={demandTypeNames}Ver ejemplo
GET /api/v1/business/BUSINESSID/product/PRODUCTID/demand/from/2024-07-15/to/2024-07-31?demandTypeNames=SALESFragmento de respuesta:
[
{
"value": 1.25,
"from": "2024-07-17T22:00:00.000Z",
"to": "2024-07-17T22:15:00.000Z",
"measure": "SALES"
},
{
"value": 1.25,
"from": "2024-07-17T22:15:00.000Z",
"to": "2024-07-17T22:30:00.000Z",
"measure": "SALES"
},
{
"value": 1.25,
"from": "2024-07-17T22:30:00.000Z",
"to": "2024-07-17T22:45:00.000Z",
"measure": "SALES"
},
{
"value": 1.25,
"from": "2024-07-17T22:45:00.000Z",
"to": "2024-07-17T23:00:00.000Z",
"measure": "SALES"
}
]Para consultar múltiples tipos de medidas, se pueden incluir varios valores separados por comas.
Ver ejemplo
GET /api/v1/business/BUSINESSID/product/PRODUCTID/demand/from/2024-07-15/to/2024-07-31?demandTypeNames=SALES,TICKETSFragmento de respuesta:
[
{
"value": 1.0,
"from": "2024-07-17T21:30:00.000Z",
"to": "2024-07-17T21:45:00.000Z",
"measure": "TICKETS"
},
{
"value": 1.0,
"from": "2024-07-17T21:45:00.000Z",
"to": "2024-07-17T22:00:00.000Z",
"measure": "TICKETS"
},
{
"value": 1.25,
"from": "2024-07-17T22:00:00.000Z",
"to": "2024-07-17T22:15:00.000Z",
"measure": "SALES"
},
{
"value": 1.25,
"from": "2024-07-17T22:15:00.000Z",
"to": "2024-07-17T22:30:00.000Z",
"measure": "SALES"
}
]|
Si no se especifica el parámetro |