API atual/Referência completa/ERP Frente de caixa (PDV)

Indicadores e estabelecimentos

Resume as vendas do PDV e lista os estabelecimentos fiscais disponíveis para emitir NFC-e.

Indicadores de vendas

Resume as vendas: quantidade, receita, ticket médio e receita por forma de pagamento, mais quantas sessões estão abertas agora (esse último número ignora os filtros).

GET/api/v1/vendor/erp/pdv/insightsSeller

Indicadores de vendas do PDV

Parâmetros de consulta

session_iduuid

Só esta sessão.

fromstring

Início, data ou data e hora.

tostring

Fim. Data sem hora vale meia-noite do início do dia.

Exemplo de requisição: Indicadores de vendas

bash

curl "$BASE_URL/api/v1/vendor/erp/pdv/insights?from=2026-10-01" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Indicadores de vendas

200Indicadores

json

{
  "total_sales": 120,
  "revenue_cents": 1450000,
  "avg_ticket_cents": 12083,
  "open_sessions": 2,
  "by_method": [
    {
      "payment_method": "pix",
      "count": 70,
      "revenue_cents": 900000
    },
    {
      "payment_method": "credit",
      "count": 50,
      "revenue_cents": 550000
    }
  ]
}

Campos da resposta

total_salesinteger

Número de vendas.

revenue_centsinteger

Receita total.

avg_ticket_centsinteger

Receita dividida pelas vendas (divisão inteira).

open_sessionsinteger

Sessões abertas neste momento no seller.

by_methodarray

Receita por forma de pagamento, da maior para a menor.

payment_methodstring

Forma de pagamento.

countinteger

Vendas.

revenue_centsinteger

Receita.

Erros: Indicadores de vendas

Status	Quando	Corpo
500	`session_id` não é um UUID válido.	`{"error":"failed to compute insights","detail":"..."}`
401	Cabeçalho `Authorization` ausente, token inválido, expirado ou revogado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador).	`{"error":"insufficient permissions"}`
403	O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (`vendor_pending_review`).	`{"error":"no vendor account associated with this user"}`

Lista os estabelecimentos fiscais da loja que estão ativos e já provisionados no emissor fiscal, para você escolher o establishment_id de uma venda com emit_fiscal. São da loja, não do seller: o seller emite a NFC-e sob um estabelecimento da loja. A resposta usa a chave items (não establishments).

GET/api/v1/vendor/erp/pdv/establishmentsSeller

Estabelecimentos aptos a emitir NFC-e

Exemplo de requisição: Estabelecimentos fiscais

bash

curl "$BASE_URL/api/v1/vendor/erp/pdv/establishments" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Estabelecimentos fiscais

200Estabelecimentos

json

{
  "items": [
    {
      "id": "9e8d7c6b-5a49-4837-a6b5-c4d3e2f1a0b9",
      "name": "Matriz São Paulo"
    }
  ]
}

Campos da resposta

itemsarray

Estabelecimentos, o padrão primeiro.

iduuid

Id do estabelecimento.

namestring

Nome.

Erros: Estabelecimentos fiscais

Status	Quando	Corpo
401	Cabeçalho `Authorization` ausente, token inválido, expirado ou revogado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador).	`{"error":"insufficient permissions"}`
403	O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (`vendor_pending_review`).	`{"error":"no vendor account associated with this user"}`

Veja também

API atual/Referência completa/ERP Frente de caixa (PDV)

Indicadores e estabelecimentos

Resume as vendas do PDV e lista os estabelecimentos fiscais disponíveis para emitir NFC-e.

Indicadores de vendas

Resume as vendas: quantidade, receita, ticket médio e receita por forma de pagamento, mais quantas sessões estão abertas agora (esse último número ignora os filtros).

GET/api/v1/vendor/erp/pdv/insightsSeller

Indicadores de vendas do PDV

Parâmetros de consulta

session_iduuid

Só esta sessão.

fromstring

Início, data ou data e hora.

tostring

Fim. Data sem hora vale meia-noite do início do dia.

Exemplo de requisição: Indicadores de vendas

bash

curl "$BASE_URL/api/v1/vendor/erp/pdv/insights?from=2026-10-01" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Indicadores de vendas

200Indicadores

json

{
  "total_sales": 120,
  "revenue_cents": 1450000,
  "avg_ticket_cents": 12083,
  "open_sessions": 2,
  "by_method": [
    {
      "payment_method": "pix",
      "count": 70,
      "revenue_cents": 900000
    },
    {
      "payment_method": "credit",
      "count": 50,
      "revenue_cents": 550000
    }
  ]
}

Campos da resposta

total_salesinteger

Número de vendas.

revenue_centsinteger

Receita total.

avg_ticket_centsinteger

Receita dividida pelas vendas (divisão inteira).

open_sessionsinteger

Sessões abertas neste momento no seller.

by_methodarray

Receita por forma de pagamento, da maior para a menor.

payment_methodstring

Forma de pagamento.

countinteger

Vendas.

revenue_centsinteger

Receita.

Erros: Indicadores de vendas

Status	Quando	Corpo
500	`session_id` não é um UUID válido.	`{"error":"failed to compute insights","detail":"..."}`
401	Cabeçalho `Authorization` ausente, token inválido, expirado ou revogado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador).	`{"error":"insufficient permissions"}`
403	O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (`vendor_pending_review`).	`{"error":"no vendor account associated with this user"}`

Estabelecimentos fiscais

GET/api/v1/vendor/erp/pdv/establishmentsSeller

Estabelecimentos aptos a emitir NFC-e

Exemplo de requisição: Estabelecimentos fiscais

bash

curl "$BASE_URL/api/v1/vendor/erp/pdv/establishments" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Estabelecimentos fiscais

200Estabelecimentos

json

{
  "items": [
    {
      "id": "9e8d7c6b-5a49-4837-a6b5-c4d3e2f1a0b9",
      "name": "Matriz São Paulo"
    }
  ]
}

Campos da resposta

itemsarray

Estabelecimentos, o padrão primeiro.

iduuid

Id do estabelecimento.

namestring

Nome.

Erros: Estabelecimentos fiscais

Status	Quando	Corpo
401	Cabeçalho `Authorization` ausente, token inválido, expirado ou revogado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador).	`{"error":"insufficient permissions"}`
403	O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (`vendor_pending_review`).	`{"error":"no vendor account associated with this user"}`