Transações cashless por venda
Listar
GET /api/v1/cashless_sales
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.
Os registros retornados são de cashless_sale, ou seja, venda cashless. Cada um destes pode conter um ou mais cashless_facts. Ou seja, cada venda paga por meios cashless gera um registro de cashless_sale contendo um cashless_fact para cada item vendido.
start_date: a data de início das vendas cashless.
Se passado, a consulta retorna somente vendas cashless 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 cashless.
Se passado, a consulta retorna somente vendas cashless 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).
sale_id_greater_than: o id da venda cashless.
Se passado, a consulta irá retornar somente as vendas com o id maior que o informado.
Os campos start_date e end_date são desconsiderados caso este parâmetro seja informado.
client_id: o id do cliente das vendas cashless.
Se passado, a consulta retorna somente vendas cashless ocorridas para este cliente.
location_id: o id do local das vendas cashless.
Se passado, a consulta retorna somente vendas cashless ocorridas neste local.
place: local interno da instalção.
Se passado, a consulta retorna somente vendas cashless ocorridas neste local interno.
machine_type_id: o id do tipo da máquina das vendas cashless.
Se passado, a consulta retorna somente vendas cashless ocorridas neste tipo de máquina.
machine_id: o id da máquina das vendas cashless.
Se passado, a consulta retorna somente vendas cashless ocorridas nesta máquina.
machine_model: o id do modelo de máquina das transações cashless.
Se passado, a consulta retorna somente transações cashless ocorridas neste modelo de máquina.
distribution_center_id: o id do centro de distribuição das vendas cashless.
Se passado, a consulta retorna somente vendas cashless ocorridas nas instalações do centro de distribuição.
kind: o tipo das vendas cashless.
Se passado, a consulta retorna somente vendas cashless do tipo informado.
point_of_sale: o ponto de captura das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse ponto de captura.
request_number: o número da requisição das vendas cashless.
Se passado, a consulta retorna somente vendas cashless dessa requisição.
uuid: o número do pedido caso exista.
Se passado, a consulta retorna somente a venda que corresponde ao número do pedido.
route_id: o id da rota associada a instalação das vendas cashless.
Se passado, a consulta retorna somente vendas cashless da instalação dessa rota.
eft_provider_id: o provedor de TEF das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse provedor TEF.
eft_authorizer_id: o adquirente de TEF das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse adquirente.
eft_card_brand_id: o cartão utilizado nas vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse cartão.
eft_card_type_id: o tipo de cartão utilizado nas vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse tipo de cartão.
good_category_id: a categoria do produto das vendas cashless.
Se passado, a consulta retorna somente vendas cashless que contenham produtos pertencentes a essa categoria.
good_manufacturer_id: o fabricante do produto das vendas cashless.
Se passado, a consulta retorna somente vendas cashless que contenham produtos pertencentes a esse fabricante.
good_id: o produto das vendas cashless.
customer_id: o id do consumidor das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse consumidor.
status: o status das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse status.
Valores possíveis:
ok: Transação OK.
cancel: Transação Cancelada.
delivery_failure: Falha na entrega.
delivery_timeout: Tempo de entrega esgotado.
invalid_selection: Seleção inválida.
mdb_error: Erro de MDB
vending_invalid_no_second_selection: Seleção inválida
equipment_id: o id do equipamento das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse equipamento.
payment_authorizer_id: o id do autorizador das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse autorizador.
masked_card_number: o número do cartão mascarado das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse cartão.
product_type: o tipo de produto das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse tipo de produto.
mobile_app_id: o aplicativo móvel das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse aplicativo móvel.
cpf: o CPF do consumidor das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse CPF.
phone: o telefone do consumidor das vendas cashless.
Se passado, a consulta retorna somente vendas cashless desse telefone.
tags: as tags associadas aos produtos ou máquinas das vendas cashless.
Se passado, a consulta retorna somente vendas cashless cujas máquinas ou produtos contém as tags passadas.
Retorno
É retornado um JSON contendo um array com objetos que correspondem às vendas cashless. O array é ordenado por data e hora das vendas, da mais recente para a mais antiga. Os campos de cada venda cashless são os seguintes:
id: o id da venda cashless.
occurred_at: a data e hora da venda cashless, no formato ISO 8601.
installation_id: o id da instalação da venda cashless.
quantity: a quantidade total da venda cashless.
value: o valor total da venda cashless.
discount_value: o valor total de desconto da venda cashless.
cost_price: o preço total de custo dos produtos no momento da venda cashless.
physical_locator: o numero da canaleta do item.
invoice_id: o id da nota fiscal da venda cashless.
point_of_sale: o ponto de captura da venda cashless
kind: o tipo da venda cashless
status: o estado da venda cashless
equipment_id: o id do equipamento da venda cashless.
equipment_label_number: o label do equipamento da venda cashless.
equipment_serial_number: o número serial do equipamento da venda cashless.
masked_card_number: o número do cartão da venda cashless.
number_of_payments: o número de parcelas da venda cashless.
request_number: o número da requisição da venda cashless.
uuid: o número do pedido caso exista.
issuer_authorization_code: o número do código de autorização da venda cashless.
order_id: o id do pedido da venda cashless.
cancel_reason_detailed: a descrição do erro da venda cashless.
place: o local interno da venda cashless.
client: detalhes do cliente da venda cashless.
location: detalhes do local da venda cashless.
machine: detalhes da máquina da venda cashless.
machine_model: detalhes do modelo de máquina da transação cashless
eft_provider: detalhes do provedor de TEF da venda cashless.
eft_authorizer: detalhes do adquirente de TEF da venda cashless.
eft_card_brand: detalhes do cartão utilizado na venda cashless.
eft_card_type: detalhes do tipo de cartão utilizado na venda cashless.
payment_authorizer: detalhes do autorizador do pagamento da venda cashless.
mobile_app: detalhes da aplicacao mobile onde ocorreu a venda cashless.
customer: detalhes da consumidor da venda cashless.
invoice: detalhes da nota fiscal da venda cashless.
cashless_error: detalhes do erro, caso tenha ocorrido na venda cashless.
cashless_facts: detalhes dos cashless_facts da venda cashless.
ATENÇÃO: O campo invoice_id será movido para dentro da chave “invoice” e posteriormente será removido.
Segue um exemplo de retorno de consulta:
[
{
"id": 123456,
"occurred_at": "2023-12-29T12:34:56.000Z",
"installation_id": 12345,
"quantity": 1,
"value": 5.67,
"discount_value": null,
"cost_price": 1.23,
"invoice_id": null,
"point_of_sale": "1234",
"kind": "eft_pinpad",
"status": "CANCEL",
"equipment_id": 1234,
"equipment_label_number": "1234",
"equipment_serial_number": "DEADBEEF01",
"masked_card_number": "457601******2840",
"number_of_payments": 1,
"request_number": "1234509876",
"uuid": "e429b54e-721f-4721-aba3-7f267700e64a",
"issuer_authorization_code": "040349",
"order_id": null,
"cancel_reason_detailed": "Some description",
"place": "Micromarket",
"client": {
"id": 1234,
"name": "Cliente 01"
},
"location": {
"id": 4321,
"name": "Location 01"
},
"machine": {
"id": 123,
"asset_number": "123456"
},
"machine_model": {
"id": 32,
"name": "Totem"
},
"eft_provider": {
"id": 13,
"name": "Vertipay"
},
"eft_authorizer": {
"id": 5,
"name": "Stone"
},
"eft_card_brand": {
"id": 21,
"name": "Visa"
},
"eft_card_type": {
"id": 1,
"name": "Crédito"
},
"cashless_error": {
"complete_description": "123 cancelado"
"friendly_description": "Operação cancelada pelo operador."
},
"cashless_facts": [
{
"id": 123456789,
"quantity": 1,
"value": 5.67,
"discount_value": null,
"cost_price": 1.23,
"planogram_item": {
"id": 1234,
"name": "1"
},
"good": {
"id": 12345,
"type": "Product",
"category_id": 1234,
"manufacturer_id": 1234,
"name": "Coca-cola 350ml",
"upc_code": null,
"barcode" null
}
}
]
},
{
"id": 123457,
"occurred_at": "2023-12-29T12:35:56.000Z",
"installation_id": 12345,
"quantity": 2,
"value": 12.34,
"discount_value": null,
"cost_price": 5.67,
"invoice_id": null,
"point_of_sale": "1234",
"kind": "external_authorizer_vmlink",
"status": "OK",
"equipment_id": 1234,
"equipment_label_number": "1234",
"equipment_serial_number": "DEADBEEF01",
"masked_card_number": null,
"number_of_payments": 1,
"request_number": "1234509877",
"uuid": "e429b54e-721f-4721-aba3-7f267700e64a",
"issuer_authorization_code": "040350",
"order_id": 123,
"cancel_reason_detailed": null,
"place": "Micromarket",
"client": {
"id": 1234,
"name": "Cliente 01"
},
"location": {
"id": 4321,
"name": "Location 01"
},
"machine": {
"id": 123,
"asset_number": "123456"
},
"machine_model": {
"id": 32,
"name": "Totem"
},
"payment_authorizer": {
"id": 8,
"name": "PIX"
},
"cashless_facts": [
{
"id": 123456789,
"quantity": 1,
"value": 5.67,
"discount_value": null,
"cost_price": null,
"physical_locator": "1",
"planogram_item": {
"id": 1234,
"name": "1"
},
"good": {
"id": 12345,
"type": "Product",
"category_id": 1234,
"manufacturer_id": 1234,
"name": "Coca-cola 350ml",
"upc_code": null,
"barcode" null
}
},
{
"id": 123456790,
"quantity": 1,
"value": 6.67,
"discount_value": null,
"cost_price": 1.23,
"physical_locator": "99",
"planogram_item": {
"id": 1243,
"name": "99"
},
"good": {
"id": 12346,
"type": "Combo",
"category_id": 1234,
"manufacturer_id": 1234,
"name": "Ruffles + Amendoin",
"upc_code": null,
"barcode" null
},
"combo_items": [
{
"id": 1,
"quantity": 1,
"good": {
"id": 123457,
"type": "Product",
"category_id": 234,
"manufacturer_id": 234,
"name": "Ruffles 40g",
"upc_code": null,
"barcode": null
}
},
{
"id": 2,
"quantity": 1,
"good": {
"id": 123458,
"type": "Product",
"category_id": 345,
"manufacturer_id": 345,
"name": "Amendoim 30g",
"upc_code": null,
"barcode": null
}
}
]
}
]
},
{
"id": 123457,
"occurred_at": "2023-12-29T12:36:56.000Z",
"installation_id": 12345,
"quantity": 1,
"value": 1.75,
"discount_value": 0.25,
"cost_price": 1.23,
"physical_locator": "3",
"invoice_id": 123456,
"point_of_sale": "1234",
"kind": "private_label_ble",
"status": "OK",
"equipment_id": 1234,
"equipment_label_number": "1234",
"equipment_serial_number": "DEADBEEF01",
"masked_card_number": null,
"number_of_payments": 1,
"request_number": null,
"uuid": null,
"issuer_authorization_code": null,
"order_id": 234,
"place": "Micromarket",
"client": {
"id": 1234,
"name": "Cliente 01"
},
"location": {
"id": 4321,
"name": "Location 01"
},
"machine": {
"id": 123,
"asset_number": "123456"
},
"mobile_app": {
"name": "VMpay"
},
"customer": {
"id": 123,
"name": "Customer 01"
},
"invoice": {
"id": 123456,
"number": "123456789",
"status": "issued"
},
"cashless_facts": [
{
"id": 123456791,
"quantity": 1,
"value": 1.75,
"discount_value": 0.25,
"cost_price": null,
"physical_locator": "2",
"planogram_item": {
"id": 1235,
"name": "2"
},
"good": {
"id": 12347,
"type": "Product",
"category_id": 456,
"manufacturer_id": 654,
"name": "Água com gás",
"upc_code": null,
"barcode" null
}
}
]
}
]