VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Importação e exportação

Exportar usuários, pedidos e conteúdo

Baixa usuários, pedidos, páginas de conteúdo e promoções em CSV, XLSX ou XLS, com filtros por data, status e ids.

Estas quatro rotas exportam o que não é catálogo: a base de clientes, os pedidos para o financeiro ou o BI, as páginas institucionais e as promoções. Como todas as exportações da seção, devolvem um arquivo e aceitam format (csv, xlsx, xls) e count=1 (só a contagem). Veja a home da seção para o formato do CSV e os privilégios.

Dados pessoais

A exportação de usuários traz CPF, CNPJ, razão social e e-mail de clientes. A de pedidos traz endereço, telefone e e-mail. Trate o arquivo como dado pessoal (LGPD): não deixe em pasta pública e apague depois de usar.

GET/api/v1/admin/export/usersAdmin

Exporta usuários

Privilégio manage_users. Exporta usuários não excluídos, de todos os tipos. Colunas: id, email, first_name, last_name, user_type, status, person_type, cpf, cnpj, legal_name, trade_name, state_reg, responsible_name, created_at. CPF e CNPJ saem sem máscara. O separador é a vírgula.

Parâmetros de consulta

user_typestring
customervendoradminroot_admin
Filtra pelo tipo de usuário. customer é o cliente da loja; vendor é o administrador de um seller.
person_typestring
FJ
Pessoa física (F) ou jurídica (J). Vale o tipo efetivo: o declarado ou, se não houver, o derivado do CNPJ.
date_fromstring
Cadastro a partir desta data, YYYY-MM-DD.
date_tostring
Cadastro até esta data, YYYY-MM-DD.
idsstring
Lista de ids de usuário separados por vírgula.
formatstringpadrão: csv
csvxlsxxls
Formato do arquivo.
countstring
1trueyesonly
Devolve só a contagem.
GET/api/v1/admin/export/ordersAdmin

Exporta pedidos

Privilégio manage_orders. O arquivo segue um layout de planilha de pedidos (colunas como Status, Order ID, First name, E-mail, Vendor, Total, Date, Shipping: address...), com ; como separador e valores em decimal com ponto (2579.80). As datas saem como dd/mm/aaaa hh:mm.

O parâmetro status aceita a letra ou o código de status desta loja. Uma situação que a loja não conhece volta 400 unknown_order_status e a mensagem lista as situações válidas, no formato letra (nome).

Parâmetros de consulta

statusstring
Letra ou código de status do pedido (C, S...). Veja os status em Status de pedido.
vendor_iduuid
Só os pedidos deste seller.
date_fromstring
Pedidos criados a partir desta data, YYYY-MM-DD.
date_tostring
Pedidos criados até esta data, YYYY-MM-DD.
idsstring
Lista de ids de pedido separados por vírgula. Com ids, sub-pedidos também saem, mesmo que sem filtro eles fossem omitidos.
formatstringpadrão: csv
csvxlsxxls
Formato do arquivo.
countstring
1trueyesonly
Devolve só a contagem.
GET/api/v1/admin/export/pagesAdmin

Exporta páginas de conteúdo

Privilégio manage_content. Colunas: id, title, slug, page_type, status, body, seo_title, seo_description, position. O corpo (body) sai em HTML.

Parâmetros de consulta

statusstring
AHD
Filtra pelo status da página.
idsstring
Lista de ids de página separados por vírgula.
formatstringpadrão: csv
csvxlsxxls
Formato do arquivo.
countstring
1trueyesonly
Devolve só a contagem.
GET/api/v1/admin/export/promotionsAdmin

Exporta promoções

Privilégio manage_content. Colunas: id, name, code, type, discount_raw, discount_unit, min_order_cents, max_discount_cents, usage_limit, usage_count, status, priority, valid_from, valid_until, description. Aqui os valores de dinheiro estão em centavos, e discount_unit diz como ler discount_raw: basis_points quer dizer centésimos de por cento (2400 = 24%).

Parâmetros de consulta

statusstring
AD
Filtra pelo status da promoção. A coluna aceita as letras A (ativa), D (inativa) e E. Uma letra solta que a coluna não tem passa pelo filtro e devolve um arquivo só com o cabeçalho.
idsstring
Lista de ids de promoção separados por vírgula.
formatstringpadrão: csv
csvxlsxxls
Formato do arquivo.
countstring
1trueyesonly
Devolve só a contagem.

Exemplo de requisição

bash
# pedidos entregues em setembro, em XLSX
curl "$BASE_URL/api/v1/admin/export/orders?status=C&date_from=2026-09-01&date_to=2026-09-30&format=xlsx" \
  -H "Authorization: Bearer $TOKEN" -o pedidos-setembro.xlsx

# só quantos clientes pessoa jurídica existem
curl "$BASE_URL/api/v1/admin/export/users?person_type=J&count=1" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Contagem (count=1)
json
{ "count": 402 }
200Arquivo de usuários (exemplo reduzido)
text
id,email,first_name,last_name,user_type,status,person_type,cpf,cnpj,legal_name,trade_name,state_reg,responsible_name,created_at
df09667c-85ff-4916-9413-a599eacb1930,maria.souza@example.com,Maria,Souza,customer,A,F,12345678909,,,,,,2021-07-01 14:19:49

Erros

StatusQuandoCorpo de exemplo
400date_from maior que date_to{"error":"invalid_date_range","detail":"date_from must be on or before date_to"}
400Pedidos: status que a loja não tem{"error":"unknown_order_status","detail":"situação de pedido desconhecida: \"xyz\". Situações desta loja: A (Pagamento Confirmado), O (Pendente), ..."}
400Páginas e promoções: palavra de status desconhecida{"error":"unknown_record_status","detail":"situação desconhecida: ..."}
401Token ausente ou expirado{"error":"invalid or expired token"}
403Falta o privilégio do grupo{"error":"insufficient privileges","required":"manage_orders"}
500Falha ao montar o arquivo{"error":"export orders failed","detail":"..."}

As mensagens de unknown_order_status e unknown_record_status vêm em português do servidor.

Pedidos: um arquivo em formato de planilha

O arquivo de pedidos mantém um layout fixo de planilha para que planilhas e integrações construídas sobre ele continuem funcionando. Por isso o dinheiro sai em decimal com ponto e as colunas têm nomes em inglês, ao contrário do restante da API, que usa centavos.

Veja também

  • Exportar catálogo
  • Listar pedidos
  • Paginação e filtros
Anterior
Exportar catálogo
Próxima
Modelos de planilha
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também