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

Operação da loja do seller

Modo férias, aceite dos termos da plataforma e calendário de mudanças agendadas dos produtos do seller.

Três recursos do dia a dia do seller (lojista) que não têm ligação entre si, mas moram no mesmo painel: o modo férias (avisar que a loja está parada), os termos (o contrato do marketplace que o seller precisa aceitar) e o calendário de publicação (preços e status de produtos que mudam sozinhos numa data).

Pontos principais
  • Modo férias é um interruptor: ligado, os produtos do seller saem com vendor_on_vacation: true e a vitrine pode avisar o cliente. O carrinho não é bloqueado pela API.
  • A data until das férias é informativa: a plataforma não desliga as férias sozinha ao passar a data. Encerre com DELETE.
  • Aceitar os termos exige enviar o terms_id no corpo; o id que vai no caminho é ignorado.
  • O calendário só lista e cancela mudanças dos produtos do próprio seller; não há rota de criação aqui.
  • Férias e termos não exigem privilégio além do token de seller; o calendário exige um privilégio de catálogo.

Como funciona

Modo férias: is_on_vacation é false por padrão. POST liga (e pode ser repetido para trocar a mensagem), DELETE desliga e apaga mensagem e data. Termos: o administrador publica versões; só uma é a ativa. O seller aceita a ativa, e uma nova versão exige novo aceite (has_accepted volta a false). Calendário: cada linha é uma mudança de um campo de um produto (price, list_price ou status) numa data.

scheduled→applied→reverted
statusSignificado (calendário)
scheduledAguardando a data. É o único estado que o seller pode cancelar.
appliedA mudança já foi aplicada ao produto.
revertedTinha data de fim e voltou ao valor anterior.
cancelledCancelada antes de ser aplicada.
failedNão pôde ser aplicada; veja error.

Conceitos-chave

Dinheiro e datas

No calendário, new_value de price e list_price é um inteiro em centavos. Datas são RFC 3339; o mês do calendário é AAAA-MM.

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1/vendor/vacationMostra o estado do modo férias.vendor
POST/api/v1/vendor/vacationLiga o modo férias.vendor
DELETE/api/v1/vendor/vacationDesliga o modo férias.vendor
GET/api/v1/vendor/termsDevolve os termos ativos.vendor
GET/api/v1/vendor/terms/statusDiz se o seller aceitou os termos ativos.vendor
POST/api/v1/vendor/terms/{termsId}/acceptRegistra o aceite dos termos.vendor
GET/api/v1/vendor/publishing-calendarLista as mudanças agendadas.vendor
GET/api/v1/vendor/publishing-calendar/calendarAgrupa as mudanças por dia de um mês.vendor
POST/api/v1/vendor/publishing-calendar/{id}/cancelCancela uma mudança agendada.vendor

Erros comuns

  1. Confiar em until para encerrar as férias. Nada o executa sozinho; chame DELETE.
  2. Mandar o id dos termos só no caminho. O corpo precisa de terms_id, senão 400 terms_id is required.
  3. Aceitar uma versão antiga. Só a versão ativa pode ser aceita.
  4. Pedir um mês no formato errado. month=11/2026 dá 400; use 2026-11.
  5. Esperar que o calendário mostre mudanças de banner e página. Só aparecem mudanças de produtos do seller.
  6. Usar from e to fora de RFC 3339. Eles são ignorados em silêncio e a lista vem sem o filtro de datas.

Próximos passos

Modo férias
Ligar e desligar.
Termos
Ler e aceitar.
Calendário de publicação
Mudanças agendadas.
Anterior
Catálogo de gatilhos e ações
Próxima
Modo férias
Nesta página
  • Como funciona
  • Conceitos-chave
  • Dinheiro e datas
  • Endpoints
  • Erros comuns
  • Próximos passos