Itens de Pick List
Listar
GET /api/v1/pick_list_items
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: tipo do período para consultar os items de pick list.
Este parâmetro não é obrigatório, por padrão o período da consulta será sempre conforme a data de cadastro da pick list, porém também é possível filtrar pela data da visita, adicionando o seguinte parâmetro: period_type=visit_date
start_date: a data de início dos items de pick list.
A consulta retorna somente os items de pick list com data de cadastro ou data de visita, da pick list, a partir desta data e hora, inclusive.
Este filtro é obrigatório. 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 dos items de pick list.
Aconsulta retorna somente os items de pick list com data de cadastro ou data de visita, da pick list, até esta data e hora, inclusive.
Este filtro é obrigatório. 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.
operator_id: o id do operador da pick list vinculada aos items de pick list.
Se passado, a consulta retorna somente os items de pick list, relacionadas a esse operator.
user_id: o id do usuário da pick list vinculada aos items de pick list.
Se passado, a consulta retorna somente os items de pick list, gerados por esse usuário.
client_id: o id do cliente da localização vinculada à instalação da pick list de cada item.
Se passado, a consulta retorna somente os items de pick list, relacionadas à esse cliente.
location_id: o id da localização vinculada à instalação da pick list de cada item.
Se passado, a consulta retorna somente os items de pick list, desta localização.
good_id: o id do produto vinculada ao item de planograma de cada item pick list.
Se passado, a consulta retorna somente os items de pick list com esse produto.
manufacturer_id: o id do fabricante de cada produto relacionado ao item pick list.
Se passado, a consulta retorna somente os items de pick list com produtos desse fabricante.
category_id: o id da categoria, de cada produto relacionado ao item pick list.
Se passado, a consulta retorna somente os items de pick list com produtos dessa categoria.
machine_id: o id da máquina da instalação da pick list dos items de pick list.
Se passado, a consulta retorna somente os items de pick list desta máquina.
distribution_center_id: o id do centro de distribuição, da pick list de cada item.
Se passado, a consulta retorna somente os items de pick list desse centro de distribuição.
equipment_id: o id do equipamento, vinculada à instalação da pick list de cada item.
Se passado, a consulta retorna somente os items de pick list com esse equipamento.
pending_only: pode ser true ou false. Se for true, apenas os items de pick list com pick lists pendentes serão listados.
Caso não seja passado, é considerado true.
current_installations_only: pode ser true ou false. Se for true, apenas os items de pick list com pick lists de instalações ativas serão listadas.
Caso não seja passado, é considerado true.
route_id: o id da rota associada a instalação da pick lists de cada item de pick list
Se passado, a consulta retorna somente os items de pick list da instalação dessa rota.
product_type: um booleano, indicando se o produto vinculado aos items do pick list é ou não fracionável.
tags: as tags associadas aos produtos ou máquinas de cada item de pick list.
Se passado, a consulta retorna somente os items de pick list, cujas máquinas ou produtos contém as tags passadas.
Retorno
É retornado um JSON contendo um array com objetos que correspondem às visitas. O array é ordenado por data e hora de geração da nota fiscal, da mais recente para a mais antiga. Os campos de cada nota fiscal são os seguintes:
operator: id e nome do operador.
pick_list: id, data de criação e atualização da pick list.
visit: id, criação, atualização e data da visita.
user: id e nome do usuário.
distribution_center: id e nome do centro de distribuição.
location: o id e nome do local.
machine: o id e número de fábrica da máquina.
planogram_item_id: id, quantidade e preço desejado do item de planograma.
good: id, nome e preço de custo do produto do item de planograma
Segue um exemplo de retorno de consulta:
[
{
"operator": {
"id": 1789,
"name": "Verti"
},
"pick_list": {
"id": 1478,
"created_at": "2022-12-21T12:34:42.000Z",
"updated_at": "2023-01-12T11:54:09.000Z"
},
"visit": {
"id": 7895,
"created_at": "2022-12-21T18:09:46.000Z",
"occurred_at": "2022-12-21T18:09:46.000Z",
"updated_at": "2022-12-21T18:09:46.000Z"
},
"user": {
"id": 187,
"name": "Admin"
},
"distribution_center": {
"id": 781,
"name": "Padrão"
},
"location": {
"id": 9874,
"name": "Verti"
},
"machine": {
"id": 8741,
"asset_number": "M010 - 0037"
},
"planogram_item": {
"id": 789541,
"good": {
"id": 89631,
"name": "Água Mineral",
"normalize_cost_price": 10.0
},
"quantity": 10,
"desired_price": 10.1
}
}
]
Filtros
GET /api/v1/pick_list_items?access_token=QwRT89RQYcvr89&start_date=01/12/2022&end_date=31/12/2022
&operator_id=100&user_id=180&client_id=789&location_id=632&good_id=78964&manufacturer_id=14785&category_id=6321
&machine_id=2&distribution_center_id=1&equipment_id=8890&tags[]=tag1&tags[]=tag2&route_id=101
&pending_only=false¤t_installations_only=false&period_type=visit_date
Parâmetros de URL:
parâmetro |
descrição |
obrigatório |
|---|---|---|
access_token |
chave de operador |
sim |
start_date |
data de início consulta |
sim |
end_date |
data de fim consulta |
sim |
period_type |
tipo do período da consulta |
não |
operator_id |
id do operador |
não |
user_id |
id do usuário |
não |
client_id |
id do cliente |
não |
location_id |
id da localização |
não |
manufacturer_id |
id do fabricante |
não |
category_id |
id da categoria |
não |
machine_id |
id da máquina |
não |
distribution_center_id |
id do centro de distribuição |
não |
pending_only |
booleano pick lists pendentes |
não |
current_installations_only |
booleano instalações ativas |
não |
tags[] |
tags associadas |
não |
Retorno
status |
descrição |
|---|---|
200 |
OK |
Exemplo:
[
{
"operator": {
"id": 100,
"name": "Operador"
},
"pick_list": {
"id": 1478,
"created_at": "2022-12-01T12:34:42.000Z",
"updated_at": "2023-01-31T11:54:09.000Z"
},
"visit": {
"id": 7895,
"created_at": "2022-12-21T18:09:46.000Z",
"occurred_at": "2022-12-21T18:09:46.000Z",
"updated_at": "2022-12-21T18:09:46.000Z"
},
"user": {
"id": 180,
"name": "Admin"
},
"distribution_center": {
"id": 1,
"name": "Padrão"
},
"location": {
"id": 632,
"name": "Verti"
},
"machine": {
"id": 1,
"asset_number": "M020 - 0029"
},
"planogram_item": {
"id": 895,
"good": {
"id": 78964,
"name": "Água com gás",
"normalize_cost_price": 10.0
},
"quantity": 10,
"desired_price": 10.1
}
}
]