Vendas
Listar
GET /api/v1/vends
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.
start_date: a data de início das vendas.
Se passado, a consulta retorna somente vendas ocorridas a partir desta data e hora, inclusive.
Deve-se passar a data e também a hora; se não passada, considerada-se 00:00 UTC.
Um formato possível é dd/mm/yyyy hh:mi:ss. Nesse caso a data e hora devem estar em UTC.
Este campo também suporta o formato ISO 8601.
Caso o formato da data seja inválido, é retornado erro com o código HTTP 400 (bad request).
end_date: a data final das vendas.
Se passado, a consulta retorna somente vendas ocorridas até esta data e hora, inclusive.
Deve-se passar a data e também a hora; se não passada, considerada-se 00:00 UTC.
Um formato possível é dd/mm/yyyy hh:mi:ss. Nesse caso a data e hora devem estar em UTC.
Este campo também suporta o formato ISO 8601.
Caso o formato da data seja inválido, é retornado erro com o código HTTP 400 (bad request).
client_id: o id do cliente das vendas.
Se passado, a consulta retorna somente vendas ocorridas para este cliente.
location_id: o id do local das vendas.
Se passado, a consulta retorna somente vendas ocorridas neste local.
machine_id: o id da máquina das vendas.
Se passado, a consulta retorna somente vendas ocorridas nesta máquina.
installation_id: o id da instalação das vendas.
Se passado, a consulta retorna somente vendas ocorridas nesta instalação.
category_id: a categoria dos produtos das vendas.
Se passado, a consulta retorna somente vendas de produtos desta categoria.
manufacturer_id: o fabricante dos produtos das vendas.
Se passado, a consulta retorna somente vendas de produtos deste fabricante.
good_id: o produto das vendas.
vend_id_greater_than: o id da venda.
Se passado, a consulta irá retornar somente as vendas com o id maior que o informado.
audit_id: a auditoria a que pertencem as vendas.
Se passado, a consulta retorna somente vendas desta auditoria.
A auditoria das vendas passou a ser preenchida em 09/10/2021. Vendas anteriores a esta data não possuem informação de auditoria.
Retorno
É retornado um JSON contendo um array com objetos que correspondem às vendas. O array é ordenado por data e hora de venda, da mais recente para a mais antiga. Os campos de cada venda são os seguintes:
id: o id da venda.
occurred_at: a data e hora da venda, no formato ISO 8601.
client_id: o id do cliente da venda.
location_id: o id do local da venda.
machine_id: o id da máquina da venda.
installation_id: o id da instalação da venda.
planogram_item_id: o id do item de planograma em que ocorreu a venda (canaleta, seleção ou combo).
good_id: o id do produto (composto ou não) vendido.
audit_id: o id da auditoria da venda.
A auditoria das vendas passou a ser preenchida em 09/10/2021. Vendas anteriores a esta data não possuem informação de auditoria.
coil: o número do item de planograma em que ocorreu a venda (canaleta, seleção ou combo).
quantity: a quantidade vendida do item.
value: o valor total da venda.
client: detalhes do cliente da venda.
location: detalhes do local da venda.
machine: detalhes da máquina da venda.
good: detalhes do produto vendido.
Segue um exemplo de retorno de consulta:
[
{
"id":123489,
"occurred_at":"2016-01-26T07:45:36.000-02:00",
"client_id":1,
"location_id":2,
"machine_id":3,
"installation_id":4,
"planogram_item_id":5,
"good_id":7,
"coil":"1",
"quantity":1,
"value":2.5,
"client": {
"name":"Client X"
},
"location": {
"client_id":1,
"name":"Location X"
},
"machine": {
"machine_model_id":9,
"asset_number":"123"
},
"good": {
"type":"Product",
"category_id":1,
"manufacturer_id":2,
"name":"Product X",
"upc_code":"333",
"barcode": "1234567890"
}
},
{
"id":123456,
"occurred_at":"2016-01-26T07:14:24.000-02:00",
"client_id":1,
"location_id":2,
"machine_id":3,
"installation_id":4,
"planogram_item_id":6,
"good_id":8,
"coil":"3",
"quantity":1,
"value":2.5,
"client": {
"name":"Client X"
},
"location": {
"client_id":1,
"name":"Location X"
},
"machine": {
"machine_model_id":9,
"asset_number":"123"
},
"good": {
"type":"Product",
"category_id":1,
"manufacturer_id":3,
"name":"Product Y",
"upc_code":"444",
"barcode": "1234567890"
}
}
]