Rupturas
Listar
GET /api/v1/ruptures
Filtros
Os parâmetros abaixo podem ser passados como uma query string. Mais de um filtro pode ser passado na mesma consulta.
Este serviço suporta paginação.
period_type: o tipo de período das rupturas. Se passado, a consulta retorna somente rupturas geradas neste período.
Os valores possíveis são: * started_at: rupturas geradas no período entre period_start e period_end. * ended_at: rupturas finalizadas no período entre period_start e period_end.
Se não for passado, será considerado o valor current.
date: a data de início ou término das rupturas * A consulta retorna somente rupturas geradas até esta data e hora, ou terminadas após esta data, inclusive. * Se não for passado, será considerada a data atual. * Se o formato da data for inválido, será retornado erro com o código HTTP 400 (bad request). * Se a data for maior que a do filtro end_date, será retornado erro com o código HTTP 400 (bad request). * Se a data for menor que 30 dias antes da data do filtro end_date, será retornado erro com o código HTTP 400 (bad request). * Deve-se passar a data e também a hora; se não for passada, será considerado 00:00:00 UTC. * Os segundos passados na hora são desconsiderados. O sistema considera sempre 00. * Um formato possível é dd/mm/yyyy hh:mi. Nesse caso a data e hora devem estar em UTC. * Este filtro também suporta o formato ISO 8601.
start_date: a data de início das rupturas
A consulta retorna somente rupturas geradas a partir desta data e hora, inclusive.
Este filtro é obrigatório quando period_type for started_at ou ended_at. Se não for passado, será retornado erro com o código HTTP 400 (bad request).
Se o formato da data for inválido, será retornado erro com o código HTTP 400 (bad request).
Se a data for maior que a do filtro end_date, será retornado erro com o código HTTP 400 (bad request).
Se a data for menor que 30 dias antes da data do filtro end_date, será retornado erro com o código HTTP 400 (bad request).
Deve-se passar a data e também a hora; se não for passada, será considerado 00:00:00 UTC.
Os segundos passados na hora são desconsiderados. O sistema considera sempre 00.
Um formato possível é dd/mm/yyyy hh:mi. Nesse caso a data e hora devem estar em UTC.
Este filtro também suporta o formato ISO 8601.
end_date: a data final das rupturas.
A consulta retorna somente rupturas geradas até esta data e hora, inclusive.
Este filtro é obrigatório quando period_type for started_at ou ended_at. Se não for passado, será retornado erro com o código HTTP 400 (bad request).
Se o formato da data for inválido, será retornado erro com o código HTTP 400 (bad request).
Se a data for menor que a do filtro start_date, será retornado erro com o código HTTP 400 (bad request).
Se a data for maior que 30 dias depois da data do filtro start_date, será retornado erro com o código HTTP 400 (bad request).
Deve-se passar a data e também a hora; se não for passada, será considerado 23:59:59 UTC.
Os segundos passados na hora são desconsiderados. O sistema considera sempre 59.
Um formato possível é dd/mm/yyyy hh:mi. Nesse caso a data e hora devem estar em UTC.
Este filtro também suporta o formato ISO 8601.
client_id: o id do cliente das rupturas. Se passado, a consulta retorna somente rupturas geradas por esse cliente.
location_id: o id do local das rupturas. Se passado, a consulta retorna somente rupturas geradas neste local.
machine_id: o id da máquina das rupturas. Se passado, a consulta retorna somente rupturas geradas nesta máquina.
machine_type_id: o id do tipo de máquinas das rupturas. Se passado, a consulta retorna somente rupturas desse tipo de máquina.
distribution_center_id: o id do centro de distribuição das rupturas. Se passado, a consulta retorna somente rupturas das instalações deste centro de distribuição.
route_id: o id da rota das rupturas. Se passado, a consulta retorna somente rupturas geradas nesta rota.
category_id: o id da categoria das rupturas. Se passado, a consulta retorna somente rupturas com produtos desta categoria.
good_id: o id do produto das rupturas. Se passado, a consulta retorna somente rupturas com este produto.
trigger: o gatinho que gerou as rupturas. Se passado, a consulta retorna somente rupturas geradas por este gatinho.
tags: as tags das rupturas. Se passado, a consulta retorna somente rupturas para máquinas ou produtos com estas tags.
ignore_products: Booleano. Se verdadeiro ignora rupturas com produtos inativos e suspensos. O valor padrão é true.
Retorno
É retornado um JSON contendo um array com objetos que correspondem às rupturas.
id: o id da ruptura.
started_at: a data e hora de início, no formato ISO 8601.
ended_at: a data e hora de término, no formato ISO 8601.
trigger: gatinho que gerou a ruptura.
balance: saldo do produto no momento da ruptura.
operador: o id, nome do operador.
client: o id e nome do cliente.
location: o id e nome do local.
machine: o id e número de série da máquina.
planogram_item: item do planograma da ruptura.
good: detalhes do produto, incluindo sua categoria
routes: array com detalhes das rotas da instalação
Segue um exemplo de retorno de consulta:
[
{
"id": 4275,
"balance": 0.0,
"trigger": "planogram",
"started_at": "2023-06-12T20:26:41.000Z",
"ended_at": null,
"operator": {
"id": 1,
"name": "Operador 1"
},
"client": {
"id": 6874,
"name": "Cliente 1"
},
"location": {
"id": 2271,
"name": "Local 1"
},
"machine": {
"id": 1,
"asset_number": "0001"
},
"planogram_item": {
"id": 216096,
"name": "abc123"
},
"good": {
"id": 137160,
"name": "Toddynho 200ml",
"upc_code": null,
"display_name": "Toddynho 200ml",
"category": {
"id": 2340,
"name": "Refrigerados"
}
},
"routes": [
{
"id": 76,
"name": "Rota 01"
}
]
}
]