API atual/Referência completa/Indicadores e relatórios

GETExportar relatório em CSV

Baixa um dos relatórios do seller como arquivo CSV pronto para abrir no Excel brasileiro.

Use esta rota quando o seller quer a planilha. O arquivo é UTF-8 com BOM e usa ponto e vírgula como separador e vírgula decimal, o formato que o Excel em português abre sem configuração. Os valores em dinheiro vêm em reais (135,87), diferente do restante da API, que usa centavos.

GET/api/v1/vendor/reports/exportSeller

Exportar relatório em CSV

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de consulta

typestringobrigatório

salesproductsorderscategory

Qual relatório exportar.

fromstringobrigatório

Primeiro dia, YYYY-MM-DD.

tostringobrigatório

Último dia, YYYY-MM-DD. Janela de no máximo 366 dias.

group_bystringpadrão: day

dayweekmonth

Só vale para type=sales. Valor desconhecido vale day.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/reports/export?type=sales&from=2026-10-09&to=2026-10-11" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Arquivo CSV (type=sales)

text

Data;Pedidos;Receita (R$);Valor Médio (R$)
2026-10-09;1;135,87;135,87
2026-10-10;2;450,00;225,00

Campos da resposta

Content-Typeheader

text/csv; charset=utf-8.

Content-Dispositionheader

attachment; filename=...csv. O nome é formado por um prefixo do idioma, o type e as datas.

Erros

Status	Quando	Corpo de exemplo
400	`type` ausente.	`{"error":"type query parameter is required (sales, products, orders, category)"}`
400	`type` fora da lista.	`{"error":"invalid report type; valid values: sales, products, orders, category"}`
400	`from`/`to` ausentes, data inválida, início depois do fim ou janela maior que 1 ano.	`{"error":"from and to query parameters are required (format: 2006-01-02)"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, a loja está em análise de cadastro ou falta o privilégio de ajustes (`vendor_settings` ou equivalente).	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}`

Veja também