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

Feeds de dados

Como gerar arquivos de produtos para Google Shopping, Meta, Mercado Livre e outros destinos, com link público e geração agendada, e o mapa das rotas.

Um feed de dados é um arquivo (XML, CSV ou JSON) com os produtos da loja, no formato que um canal externo espera: o Google Merchant Center para o Google Shopping, o catálogo do Meta (Facebook e Instagram), o Mercado Livre, ou um formato livre para um ERP e para análises. Você cadastra o feed uma vez (tipo, formato, filtros), a plataforma gera o arquivo e entrega um link público que o canal consulta de tempos em tempos.

Pontos-chave
  • O recurso depende do módulo data-feeds. Se a loja não o tiver ligado, todas as rotas respondem 403 module_disabled.
  • Privilégio exigido: manage_data_feeds ou manage_catalog.
  • O arquivo só existe depois de gerar. O link público devolve 404 enquanto não houver uma geração.
  • O link público não precisa de login e contém um token secreto de 64 caracteres. Quem tem o link lê o feed.
  • Um feed pode ser regerado a cada N segundos (schedule_interval). Com 0, só se você mandar gerar.
  • Preços em filtros são em centavos (min_price: 4990 = R$ 49,90).

Como funciona

Ciclo de uso

  1. Escolher o tipo e os campos

    GET /data-feeds/fields/{feed_type} lista os campos que o tipo suporta. Para google_shopping, facebook e mercado_livre, a lista é a exigida pelo canal.

  2. Criar o feed

    POST /data-feeds com nome, tipo, formato, filtros e, se quiser, o agendamento. A resposta já traz o public_url.

  3. Gerar

    POST /data-feeds/{id}/generate monta o arquivo, grava no servidor e devolve o conteúdo.

  4. Entregar o link ao canal

    Cadastre o public_url no Google Merchant Center, no Meta ou onde for. Daí em diante a plataforma atualiza o arquivo no ritmo do agendamento.

Tipos de feed

feed_typePara quêFormato do arquivo gerado
google_shoppingGoogle Merchant Center (Atom com o namespace g:)Sempre XML
facebookCatálogo do MetaSempre CSV
mercado_livreMercado LivreCSV; JSON se file_format for json
customQualquer destinoO file_format escolhido: xml, csv ou json

Os três primeiros tipos têm o formato imposto pelo canal: o file_format é gravado, mas o conteúdo gerado segue a tabela. Só o custom obedece ao file_format.

Status

O feed é A (ativo) ou D (desativado). Ao gravar você pode mandar a letra ou active e disabled; a resposta devolve sempre a letra. Apenas feeds ativos com schedule_interval maior que zero são regerados pelo agendador.

Conceitos-chave

Filtros

O objeto filters escolhe quais produtos entram. Todos os campos são opcionais:

CampoTipoEfeito
statustextoStatus do produto. active (padrão), disabled, hidden ou a letra.
category_idslista de UUIDSó produtos destas categorias principais.
vendor_idslista de UUIDSó produtos destes sellers.
min_price, max_priceinteiroFaixa de preço de venda, em centavos.
in_stockbooleanoSe true, só produtos com estoque.

Produtos excluídos nunca entram.

Mapeamento de campos

field_mapping guarda os campos escolhidos. Nos feeds do Google, do Meta e do Mercado Livre, desmarcar um campo opcional o tira do arquivo. Um feed sem mapeamento ({}) gera todos os campos opcionais. No feed do Google, a entrada g:google_product_category com default_value define a categoria do Google para o feed inteiro.

O link público

https://<domínio da loja>/api/v1/feeds/<token>.<xml|csv|json>. O link serve o último arquivo gerado, não regera na hora, e fica em cache por uma hora. Gerar um novo token invalida o link antigo.

Feeds de seller

Cada feed pode pertencer à loja (marketplace) ou a um seller (vendor_id). A lista aceita vendor_id e marketplace_only=true para separar.

Endpoints

MétodoCaminhoPara que serveAuth
GET/api/v1/admin/data-feedsLista os feedsadmin
GET/api/v1/admin/data-feeds/{id}Consulta um feedadmin
GET/api/v1/admin/data-feeds/fields/{feed_type}Lista os campos de um tipo de feedadmin
POST/api/v1/admin/data-feedsCria um feedadmin
PUT/api/v1/admin/data-feeds/{id}Altera um feedadmin
DELETE/api/v1/admin/data-feeds/{id}Apaga um feedadmin
POST/api/v1/admin/data-feeds/{id}/generateGera o arquivo agoraadmin
POST/api/v1/admin/data-feeds/{id}/regenerate-tokenTroca o token do link públicoadmin

Erros comuns

  • Entregar o link ao Google antes de gerar: o link responde 404 ("Feed has not been generated yet") até a primeira geração.
  • Esperar que file_format: "json" mude um feed google_shopping: o formato do Google é sempre XML.
  • Filtrar preço em reais: min_price e max_price são em centavos.
  • Colar o link público em um lugar visível: ele não tem senha. Se vazou, gere um novo token.
  • Esperar que o link atualize sozinho com a loja: ele serve o último arquivo gerado. Use schedule_interval ou chame generate.
  • Confundir 403 module_disabled com falta de privilégio: é o módulo data-feeds que está desligado na loja.
  • Enviar schedule_interval pequeno demais: o agendador acorda a cada 15 minutos, então valores menores que isso não adiantam.

Próximos passos

Criar e alterar feeds
Corpo, filtros e validações.
Gerar e trocar o token
Gerar o arquivo e proteger o link.
Consultar feeds
Lista, detalhe e campos por tipo.
Anterior
Variantes da caixa
Próxima
Consultar feeds
Nesta página
  • Como funciona
  • Ciclo de uso
  • Tipos de feed
  • Status
  • Conceitos-chave
  • Filtros
  • Mapeamento de campos
  • O link público
  • Feeds de seller
  • Endpoints
  • Erros comuns
  • Próximos passos