Vendas detalhadas por período
Vendas do período, com itens, formas de pagamento, cliente e funcionário. Retorna somente vendas válidas; vendas canceladas ou excluídas não são incluídas.
Authorization
userToken Chave de acesso que aparece no cadastro do usuário, no ssOtica. Envie como
Authorization: Bearer {chave}.
In: header
Query Parameters
CNPJ (ou CPF) da loja, com ou sem máscara. Informe cnpj ou empresa.
Código da Licença da loja (chave de contrato). Informe cnpj ou empresa.
Data inicial, no formato AAAA-MM-DD. O intervalo até fim_periodo pode ter no máximo 180 dias (ex.: 2025-07-01 a 2025-12-28 é aceito; 2025-07-01 a 2025-12-31, com 183 dias, é recusado).
Data final, no formato AAAA-MM-DD. O dia informado é considerado por completo. Deve estar a no máximo 180 dias de inicio_periodo.
Data utilizada no filtro: dataVenda (padrão), a data da venda; dataLancamento, a data de registro da venda no sistema, indicada para vendas lançadas com data retroativa.
Número da página, a partir de 1 (padrão 1). As páginas devem ser consultadas até o valor de totalPages informado na resposta.
Itens por página, de 1 a 100. A paginação é ativada ao informar page e/ou perPage; sem esses parâmetros, a resposta traz a lista completa. Quando apenas page é informado, são retornados 10 itens por página. O nome deve ser escrito exatamente como perPage; outras grafias, como per_page, são desconsideradas sem aviso.
Se presente, a resposta é retornada como JSONP.
Response Body
application/json
application/json
text/html
curl -X GET "https://example.com/integracoes/vendas/periodo?inicio_periodo=2026-06-01&fim_periodo=2026-06-30"{ "currentPage": 1, "totalPages": 1, "totalItems": 1, "perPage": 100, "data": [ { "id": 215, "data": "2022-04-07", "hora": "17:33:55", "status": "ATIVA", "numero": 83, "valor_bruto": 599, "acrescimo": 0, "desconto": 29.95, "credito_troca": 0, "valor_liquido": 569.05, "itens": [ { "id": 259, "produto": { "id": 2606248, "referencia": "5011-53-2793", "descricao": "Afop - Pelicula Carmelo Suave-Urban", "grupo": "Armações", "grupo_id": 200232, "grife": "Urban", "grife_id": 2761118, "unidade": "UN", "código_gtin": "7908020002024", "ncm": "90031100" }, "quantidade": 1, "custo": 61.58, "valor_unitario_bruto": 200, "desconto": 10, "acrescimo": 0, "valor_unitario_liquido": 190, "valor_total_liquido": 190, "ordem_servico": { "id": 29, "tipo": "Otica", "numero": 13, "status": "NE", "status_detalhado": "Não Entregue", "abertura": "07/04/2022 17:30:00", "previsao_entrega": "07/04/2022 00:00:00" } }, { "id": 260, "produto": { "id": 2606750, "referencia": "SS498 C1", "descricao": "Arm Ace H Ace F 53-16-140", "grupo": "Armações", "grupo_id": 200232, "grife": "Sabrina Sato", "grife_id": 2761125, "unidade": "PC", "código_gtin": null, "ncm": "90031910" }, "quantidade": 1, "custo": 118.7, "valor_unitario_bruto": 399, "desconto": 19.95, "acrescimo": 0, "valor_unitario_liquido": 379.05, "valor_total_liquido": 379.05, "ordem_servico": { "id": 29, "tipo": "Otica", "numero": 13, "status": "NE", "status_detalhado": "Não Entregue", "abertura": "07/04/2022 17:30:00", "previsao_entrega": "07/04/2022 00:00:00" } } ], "formas_pagamento": [ { "id": 172, "data": "2022-04-07", "valor": "569.05", "qtd_parcelas": 1, "forma_pagamento": "Dinheiro", "codigo_autorizacao": null } ], "cliente": { "id": 2801220, "nome": "Pedro Almeida", "apelido": "Cliente Exemplo", "nascimento": "1988-09-27", "cpf_cnpj": "123.456.789-09", "rg_ie": "1234567890901", "nome_pai": null, "nome_mae": null, "profissao": null, "observacao": null, "ativo": true, "contribuinte_icms": false, "suframa": null, "ie": null, "im": null, "tipo": "PF", "cadastrado_em": "2014-09-02 15:39:00", "sexo": null, "renda_familiar": null, "codigo": null, "convenio": "", "escolaridade": null, "referencia": null, "endereco": { "logradouro": "Rua das Flores", "numero": null, "complemento": null, "bairro": "Centro", "cep": "", "cidade": "Fortaleza", "uf": "CE", "pais": "Brasil" }, "telefones": [ { "numero": "(11) 9.9999-0000", "identificacao": null }, { "numero": "(11) 9.9999-0000", "identificacao": null } ], "emails": [], "origem": "" }, "funcionario": { "id": 28432, "nome": "Maria da Silva", "cpf": "", "cnpj": "12345678909012", "rg": "", "telefone_fixo": "", "telefone_movel": "", "endereco": { "logradouro": "", "bairro": "", "cep": "", "cidade": "", "uf": "" }, "funcao": "Vendedor", "observacao": "Observação de exemplo" }, "origensCliente": [ "Abordagem Frente de Loja" ] } ]}{ "error": "DATA_INVALIDA", "error_info": "O campo \"inicio_periodo\" contém uma data inválida. Utilize o formato AAAA-MM-DD (ex.: 2026-06-30)."}"Unauthorized."Resumo de vendas por funcionário/dia GET
Total de vendas por dia e por funcionário no período. O valor considera os acréscimos e desconta os descontos e os créditos de troca.
Resumo de vendedores (vendas + OS) GET
Vendas e ordens de serviço do período, consolidadas por funcionário. A loja é identificada somente pelo CNPJ.