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

Assistente de importação

Importação em massa de produtos do seller em etapas: envio, mapeamento, validação, execução e acompanhamento.

O assistente de importação carrega produtos em massa a partir de uma planilha, mesmo que as colunas dela tenham nomes diferentes dos da plataforma. Ele separa o trabalho em etapas, para você ver o que vai acontecer antes de gravar: envia o arquivo, confere o mapeamento, executa e acompanha. É o caminho certo para planilhas grandes ou com colunas livres; para cargas pequenas no formato exato da plataforma, existe o CSV direto.

Pontos principais
  • Só importa produtos (object_type é sempre products).
  • Todo produto importado pertence ao seu seller; uma coluna vendor_id na planilha é ignorada.
  • Fluxo em quatro chamadas: upload, validate, execute, status. validate não grava nada.
  • Importações com mais de 1.000 linhas rodam em segundo plano: a resposta de execute vem com status: "processing" e você acompanha em status.
  • A planilha pode ser .csv, .txt, .xml, .xlsx ou .xlsm. Em Excel só a primeira aba é lida.
  • Rotas exigem vendor_import_products (ou vendor_manage_products/vendor_catalog).

Como funciona

  1. Envie o arquivo

    upload lê o cabeçalho, mostra 5 linhas de exemplo e devolve job_id, a lista de campos disponíveis e um auto_mapping com a sugestão da plataforma.

  2. Ajuste o mapeamento

    Corrija o auto_mapping onde a sugestão errou. Quando o mapeamento ficar bom, salve-o como modelo para as próximas planilhas.

  3. Valide

    validate percorre todas as linhas e diz quantas serão criadas, atualizadas ou ignoradas, com erros e avisos. Corrija a planilha e envie de novo até valid: true.

  4. Execute

    execute grava. Use options.dry_run: true para um ensaio completo que não grava nada.

  5. Acompanhe

    Consulte status até chegar a completed ou failed.

Status da importaçãoSignificado
pendingEnviada, ainda não executada.
processingEm execução em segundo plano.
completedTerminou. Veja as contagens e os erros por linha.
failedParou por erro geral.

Conceitos importantes

Campos principais

O mapeamento liga cada coluna da planilha a um destes campos (a lista completa vem em available_fields). A importação exige ao menos uma coluna de identidade (name, sku, barcode ou id); para criar produto novo pelo nome, também é preciso a coluna price.

GrupoCampos
Identificaçãoid, sku, barcode, name, slug, status, brand
Preçosprice, list_price, cost_price, ncm_code, cest_code, ipi_rate, icms_rate, tax_cst
Estoquequantity, min_quantity, max_quantity, quantity_step, out_of_stock_actions, zero_price_action
Envioweight, length, width, height, free_shipping, shipping_freight
Conteúdo e SEOdescription, short_description, promo_text, meta_title, meta_description, meta_keywords
Categoriascategory_id, category_name, category_path, secondary_categories
Imagens e extrasmain_image, additional_images, features, variation_group, parent_product_id, usergroup_ids

Preço: o formato importa

No execute, options.price_format define como ler a coluna de preço: auto (padrão) trata 49,90 e 49.90 como reais, mas um inteiro puro como centavos; decimal lê tudo como reais (50 = R$ 50,00); cents lê tudo como centavos e recusa decimais. Para planilhas sem vírgula use decimal e evite surpresa.

Categorias

Mapeie category_path (por exemplo Roupas///Camisetas, com o delimitador de options.category_delimiter, padrão ///) ou category_name, e use options.create_categories: true para criar as que faltarem. As categorias criadas por um seller ficam dele (veja Categorias próprias).

Endpoints

MétodoCaminhoPara que serve
POST/api/v1/vendor/import/uploadEnvia a planilha e recebe o mapeamento sugerido.
POST/api/v1/vendor/import/validateValida o mapeamento linha a linha, sem gravar.
POST/api/v1/vendor/import/executeExecuta a importação.
GET/api/v1/vendor/import/status/{id}Acompanha uma importação.
GET/api/v1/vendor/import/presetsLista os mapeamentos salvos.
POST/api/v1/vendor/import/presetsSalva um mapeamento.
DELETE/api/v1/vendor/import/presets/{id}Exclui um mapeamento salvo.

Erros comuns

  1. Pular a validação. execute com mapeamento errado grava lixo. Rode validate e confira will_create, will_update e os erros.
  2. Planilha com linha em branco. Linha vazia é erro fatal (fatal: true): remova a linha e valide de novo.
  3. Esperar que status já traga o fim em planilhas grandes. Acima de 1.000 linhas a execução é assíncrona; repita status.
  4. Mandar set_zero_quantities. Em loja multi-seller essa opção zera o estoque de todos os produtos da loja, não só dos seus. Nunca use na API do seller.
  5. Preço sem vírgula na planilha. 4990 vira R$ 49,90 no modo auto, mas 50 vira R$ 0,50. Fixe price_format.
  6. Reaproveitar um job_id depois de executar. O arquivo temporário é apagado ao fim; envie a planilha de novo.

Próximos passos

Passo a passo
As quatro chamadas com exemplos.
Modelos de mapeamento
Reaproveite o mapeamento.
CSV direto
Para cargas pequenas.
Anterior
Gerar o arquivo do feed
Próxima
Importar em etapas
Nesta página
  • Como funciona
  • Conceitos importantes
  • Campos principais
  • Preço: o formato importa
  • Categorias
  • Endpoints
  • Erros comuns
  • Próximos passos