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

Produtos do seller

Visão geral do catálogo do seller: ciclo de vida, status, dinheiro e o mapa de todas as rotas de produto.

Este é o catálogo do seller (lojista): o vendedor que opera dentro do marketplace da loja com produtos, pedidos e financeiro próprios. As rotas de /api/v1/vendor/products deixam o seller criar, alterar, publicar e organizar os seus produtos, e é por elas que o painel do seller e as integrações de catálogo trabalham. O seller nunca vê nem altera produto de outro seller ou da própria loja.

Pontos principais
  • Todas as rotas exigem o token de um usuário seller. O token de administrador recebe 403.
  • O dono do produto vem do token: o vendor_id enviado no corpo é ignorado.
  • Preços são inteiros em centavos. O corpo também aceita decimais em reais (134.34 vira 13434), então 50 são 50 centavos e não R$ 50,00.
  • Se a loja usa premoderação, produto novo (e edição de produto ativo) fica R (pendente) até um administrador aprovar.
  • Produto ligado ao catálogo mestre tem campos travados: a alteração desses campos volta 409.

Como funciona

O ciclo de vida de um produto do seller depende de a loja ligar a premoderação. Com ela ligada, tudo que o seller publica passa por revisão:

Criado (R)→Aprovado (A, D ou H)
StatusSignificado
AAtivo: aparece na vitrine e pode ser comprado.
DDesativado: existe, mas não aparece na vitrine.
HOculto: não aparece nas listas, mas o link direto pode funcionar.
RPendente de aprovação: aguardando um administrador.
XRejeitado: o administrador recusou, o motivo vem em rejected_reason.

Você só escolhe A, D ou H. R e X pertencem ao fluxo de moderação: ao criar, o status que você pede vira o intended_status (o destino depois da aprovação) e o produto nasce R. Sem premoderação ele nasce direto no status pedido, e A se você não disser nada.

Conceitos importantes

Dinheiro

Todo valor monetário do produto (price, list_price, cost_price, shipping_freight) é um inteiro em centavos. Na entrada, o decodificador também aceita decimais (49.9 vira 4990) e textos como "R$ 49,90". Um inteiro puro sempre vale centavos. Mande sempre inteiros para evitar surpresa.

Quem pode chamar

Além de ser seller, o usuário precisa de um privilégio de catálogo (por exemplo vendor_catalog ou vendor_manage_products). O privilégio de leitura vendor_view_catalog também abre as rotas de escrita desta seção, então não o conceda a quem não deve alterar produtos. Seller em análise de cadastro recebe 403 com vendor_pending_review.

Produto do catálogo mestre

O catálogo mestre é uma lista de produtos curada pela loja (nome, descrição, imagem, características). Um produto do seller ligado a um mestre herda esses dados, e só preço, estoque, SKU interno e medidas de envio continuam livres. Ver Catálogo mestre.

Variações, opções e preços por quantidade

Variações (produtos filhos), opções de compra, escalas de preço e produtos obrigatórios têm a própria seção: Variações e opções.

Endpoints

MétodoCaminhoPara que serve
GET/api/v1/vendor/productsLista os produtos do seller.
GET/api/v1/vendor/products/{id}Lê um produto.
POST/api/v1/vendor/productsCria um produto.
PUT/api/v1/vendor/products/{id}Altera um produto (parcial).
DELETE/api/v1/vendor/products/{id}Exclui um produto (lixeira).
POST/api/v1/vendor/products/bulk/cellsEdita até 200 produtos como planilha.
GET/api/v1/vendor/products/exportBaixa os produtos em CSV.
POST/api/v1/vendor/products/importImporta produtos de CSV ou XLSX (envio direto).
GET/api/v1/vendor/products/import/templateBaixa o modelo de planilha.
POST/api/v1/vendor/products/{id}/imagesAdiciona uma imagem.
PUT/api/v1/vendor/products/{id}/images/reorderReordena as imagens.
PUT/api/v1/vendor/products/{id}/images/{imageId}/primaryDefine a imagem principal.
PUT/api/v1/vendor/products/{id}/images/spin-groupMonta a sequência 360 graus.
GET/api/v1/vendor/products/{id}/videosLista os vídeos.
POST/api/v1/vendor/products/{id}/videosAdiciona um vídeo.
POST/api/v1/vendor/products/{id}/videos/reorderReordena os vídeos.
DELETE/api/v1/vendor/products/{id}/videos/{videoId}Remove um vídeo.
GET/api/v1/vendor/products/{id}/attachmentsLista os arquivos para download.
POST/api/v1/vendor/products/{id}/attachmentsAnexa um arquivo.
PUT/api/v1/vendor/products/{id}/attachments/reorderReordena os anexos.
GET/api/v1/vendor/products/{id}/featuresLê as características.
PUT/api/v1/vendor/products/{id}/featuresGrava as características.
GET/api/v1/vendor/products/{id}/seoLê o SEO.
PUT/api/v1/vendor/products/{id}/seoAltera o SEO e o slug.
POST/api/v1/vendor/products/{id}/seo/generateGera o SEO a partir do produto.
POST/api/v1/vendor/products/{id}/link-masterVincula ao catálogo mestre.
DELETE/api/v1/vendor/products/{id}/unlink-masterDesvincula do catálogo mestre.
GET/api/v1/vendor/products/{id}/shipping-packagingLê a embalagem medida.
PUT/api/v1/vendor/products/{id}/shipping-packagingGrava a embalagem medida.
GET/api/v1/vendor/products/{id}/recurringLê assinatura e compra programada.
PUT/api/v1/vendor/products/{id}/recurringGrava assinatura e compra programada.

Erros comuns

  1. Mandar 50 esperando R$ 50,00. Inteiro é centavos: use 5000.
  2. Esquecer a categoria. category_id é obrigatório na criação; sem ele a resposta é 400 validation_failed.
  3. Esperar o produto ativo logo após criar. Com premoderação ele fica R. Leia status e intended_status na resposta.
  4. Ativar produto físico sem peso e medidas em loja que exige dados de frete: volta physical_shipping_data_required. Salve como D até completar.
  5. Editar campo travado de produto do catálogo mestre. Volta 409 com locked_fields.
  6. Usar o token de administrador. Estas rotas são só de seller; o administrador usa /api/v1/admin/products.
  7. Reenviar price zerado achando que é erro. Preço zero é aceito; o que acontece na compra depende de zero_price_action.

Próximos passos

Criar produto
O corpo completo e os erros de validação.
Importar e exportar
CSV direto para cargas pequenas.
Assistente de importação
Mapeamento de colunas para planilhas grandes.
Variações e opções
Cores, tamanhos e escalas de preço.
Anterior
Personalização
Próxima
Listar produtos
Nesta página
  • Como funciona
  • Conceitos importantes
  • Dinheiro
  • Quem pode chamar
  • Produto do catálogo mestre
  • Variações, opções e preços por quantidade
  • Endpoints
  • Erros comuns
  • Próximos passos