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

Conteúdo da loja do seller

Banners, páginas institucionais e posts de blog que o seller publica na própria vitrine (microsite).

Num marketplace, cada seller (lojista) tem uma vitrine própria, o microsite, com identidade e conteúdo dele. Estas rotas, em /api/v1/vendor, são o CMS do seller: banners (o carrossel de destaque), páginas (Política de trocas, Sobre nós) e posts de blog. Cada seller só enxerga e altera o que ele criou.

Pontos principais
  • O conteúdo do seller é separado do conteúdo da loja (marketplace) e do de outros sellers. O vendor_id do corpo é sempre ignorado.
  • As três áreas têm o mesmo CRUD: listar, consultar, criar, alterar (PUT parcial) e apagar.
  • Os status chegam como palavra (banner e página) ou letra (post). Veja cada página.
  • HTML é limpo de scripts e eventos antes de ser gravado; textos simples perdem as tags.
  • Todas exigem um privilégio de configurações do seller; o dono tem todos.

Como funciona

TipoPara que serveEstadosApagar
BannerImagem (ou texto) de destaque no topo do microsite.active, inactive, scheduled, hiddenDefinitivo
PáginaConteúdo fixo em HTML com URL própria.active, hidden, draftLógico (some das listas)
PostArtigo de blog, com agendamento.A, R, DDefinitivo

Conceitos-chave

Dono do conteúdo

Todo item criado aqui nasce com o vendor_id do seller do token. Consultar, alterar ou apagar um id de outro seller responde 404 (banner, página, post), como se não existisse. O administrador da loja gerencia o conteúdo do marketplace por /api/v1/admin.

Slugs

O slug é a parte da URL. A plataforma o normaliza: minúsculas, espaços viram hífen e tudo que não for a-z, 0-9 ou hífen é removido (acentos incluídos: promoção vira promoo). Envie sempre um slug já em ASCII. Na criação, um slug repetido recebe um sufixo (-2, -3); na alteração, um slug repetido é recusado.

Ver o resultado

Itens do seller aparecem só no microsite do seller, não na home do marketplace. Banner só aparece quando está active e dentro da janela de starts_at e ends_at; página só quando active; post só quando A e com published_at já passado.

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1/vendor/bannersLista os banners.vendor
GET/api/v1/vendor/banners/{id}Devolve um banner.vendor
POST/api/v1/vendor/bannersCria um banner.vendor
PUT/api/v1/vendor/banners/{id}Altera um banner.vendor
DELETE/api/v1/vendor/banners/{id}Apaga um banner.vendor
GET/api/v1/vendor/pagesLista as páginas.vendor
GET/api/v1/vendor/pages/{id}Devolve uma página.vendor
POST/api/v1/vendor/pagesCria uma página.vendor
PUT/api/v1/vendor/pages/{id}Altera uma página.vendor
DELETE/api/v1/vendor/pages/{id}Apaga uma página.vendor
GET/api/v1/vendor/blogLista os posts.vendor
GET/api/v1/vendor/blog/{id}Devolve um post.vendor
POST/api/v1/vendor/blogCria um post.vendor
PUT/api/v1/vendor/blog/{id}Altera um post.vendor
DELETE/api/v1/vendor/blog/{id}Apaga um post.vendor

Erros comuns

  1. Mandar slug com acento. O acento é descartado, não convertido.
  2. Esperar scheduled publicar sozinho. No banner, scheduled é um rascunho; a data não o ativa. Use active com starts_at e ends_at.
  3. Criar post sem status. O padrão é publicado (A): ele vai ao ar na hora.
  4. Tratar a 404 como erro de permissão. O id de outro seller também responde 404.
  5. Mandar image_url de rede interna. Endereços locais e privados são recusados.
  6. Apagar sem querer. Banner e post são apagados de vez; só a página é apagada de forma lógica.

Próximos passos

Banners
O carrossel do microsite.
Páginas
Políticas e institucional.
Blog
Artigos agendáveis.
Anterior
Relatório de personalização
Próxima
Banners do seller
Nesta página
  • Como funciona
  • Conceitos-chave
  • Dono do conteúdo
  • Slugs
  • Ver o resultado
  • Endpoints
  • Erros comuns
  • Próximos passos