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

Modelos de planilha

Baixa o CSV de exemplo de produtos, categorias, características, marcas e preços por quantidade, com as colunas certas para importar.

Antes de montar uma planilha de importação, baixe o modelo. Ele traz o cabeçalho exato que a plataforma espera e duas ou três linhas de exemplo, no mesmo separador e na mesma formatação (vírgula decimal, por exemplo) que a importação lê. Apague as linhas de exemplo, preencha as suas e envie pela rota de importação do mesmo cadastro.

Todas as cinco rotas são GET, não têm parâmetros e devolvem um CSV em UTF-8 com BOM como anexo. O modelo de importação de produtos também existe em /api/v1/admin/import/products/template, com o mesmo conteúdo.

GET/api/v1/admin/export/products/templateAdmin

Baixa o modelo de produtos

Privilégio manage_catalog. Arquivo products_template.csv, separador ;.

GET/api/v1/admin/export/categories/templateAdmin

Baixa o modelo de categorias

Privilégio manage_catalog. Arquivo categories_template.csv, separador ,. Na coluna parent_id você pode usar o id ou o slug da categoria pai; o valor - move a categoria para a raiz.

GET/api/v1/admin/export/features/templateAdmin

Baixa o modelo de características

Privilégio manage_features. Arquivo caracteristicas_modelo.csv, separador ;. Os valores possíveis de uma característica de lista vão em variants, separados por |.

GET/api/v1/admin/export/brands/templateAdmin

Baixa o modelo de marcas

Privilégio manage_features. Arquivo brands_template.csv, separador ;.

GET/api/v1/admin/export/qty-discounts/templateAdmin

Baixa o modelo de preços por quantidade

Privilégio manage_catalog. Arquivo qty_discounts_template.csv, separador ;. O cabeçalho está em inglês, no formato padrão de importação.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/export/products/template" \
  -H "Authorization: Bearer $TOKEN" -o modelo-produtos.csv

Resposta

200Modelo de produtos
text
product_code;name;price;list_price;status;quantity;weight;category_id;vendor_id;description;short_description
SKU-001;Produto Exemplo 1;49,90;59,90;A;100;0,500;Higiene e Beleza;Nome do vendedor (ou slug/e-mail/ID);Descrição completa;Resumo curto
SKU-002;Produto Exemplo 2;129,00;;A;50;1,200;Higiene e Beleza;Nome do vendedor (ou slug/e-mail/ID);Outra descrição;Outro resumo
200Modelo de categorias
text
id,name,parent_id,slug,description,status,position,meta_title,meta_keywords
,Eletrônicos,,eletronicos,Categoria de eletrônicos,A,0,Eletrônicos,"eletronicos, gadgets"
,Smartphones,eletronicos,smartphones,Telefones celulares,A,1,Smartphones,"celular, telefone"
,Promoções,-,promocoes,Movida para a raiz,A,2,Promoções,promo
200Modelo de preços por quantidade
text
Product code;Price;Value per Kg;Value per Unit;Lower limit;Percentage discount;User group
SKU-001;39,90;;;10;;
SKU-001;0,00;;;25;7,5;registered
7891234567890;35,00;24,75;4,95;50;;Atacado

Erros

StatusQuandoCorpo de exemplo
401Token ausente ou expirado{"error":"invalid or expired token"}
403Falta o privilégio da rota{"error":"insufficient privileges","required":"manage_catalog"}
500Falha ao gerar o arquivo{"error":"export template failed","detail":"..."}
O modelo é só o ponto de partida

O modelo de produtos mostra as colunas básicas. A importação em etapas (Importação avançada) aceita muito mais colunas (preço de custo, SEO, imagens, categorias por caminho...). Consulte a lista em Campos importáveis e exportáveis.

Veja também

  • Importar produtos
  • Importar outros cadastros
  • Exportar catálogo
Anterior
Exportar usuários, pedidos e conteúdo
Próxima
Importar produtos
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também