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

Calendário de publicação

Lista, agrupa por dia e cancela as mudanças agendadas de preço e status dos produtos do seller.

Mudanças agendadas deixam o preço ou o status de um produto mudar sozinhos numa data (uma promoção que começa à meia-noite, por exemplo), e voltar ao valor anterior se houver data de fim. Estas rotas mostram só as dos produtos do seller: mudanças de banner, de página e de produtos de outros sellers nunca aparecem. Exigem um privilégio de catálogo.

Listar mudanças

GET/api/v1/vendor/publishing-calendarSeller

Lista as mudanças agendadas do seller

Por data de aplicação crescente, no máximo 500 itens, sem paginação. Use from e to para reduzir.

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de consulta

fromstring
Início da janela (RFC 3339), sobre apply_at. Valor inválido é ignorado.
tostring
Fim da janela (RFC 3339). Valor inválido é ignorado.
statusstring
scheduledappliedrevertedcancelledfailed
Filtra por status.

Exemplo de requisição

200Mudanças

Campos da resposta

itemsarray

Mudanças agendadas.

iduuid
Id da mudança agendada.
batch_iduuid
Lote em que foi criada.
entity_typestring
Sempre product nesta API.
entity_iduuid
Produto afetado.
entity_labelstring
Nome do produto.
fieldstring
pricelist_pricestatus
Campo alterado: price, list_price (centavos) ou status.
new_valueany
Valor a aplicar. Inteiro em centavos para preços.
revert_valueany
Valor anterior, capturado na hora de aplicar. Ausente antes disso.
apply_atstring
Quando a mudança entra (RFC 3339).
revert_atstring
Quando volta ao valor anterior. null = não volta.
statusstring
scheduledappliedrevertedcancelledfailed
scheduled, applied, reverted, cancelled ou failed.
errorstring
Motivo da falha. Ausente se não falhou.
created_byuuid
Usuário que agendou. null se desconhecido.
created_atstring
Criação.
totalinteger
Quantidade de itens devolvidos (não o total geral).

Ver o calendário do mês

GET/api/v1/vendor/publishing-calendar/calendarSeller

Mudanças agrupadas por dia de um mês

Agrupa as mudanças do mês por dia de aplicação (data em UTC). Só dias com mudanças aparecem, sem ordem garantida: ordene por date no seu lado.

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de consulta

monthstringpadrão: current
Mês no formato AAAA-MM. Padrão: mês atual.

Exemplo de requisição

200Calendário

Campos da resposta

daysarray

Dias com mudanças.

datestring
Dia AAAA-MM-DD (UTC).
itemsarray
Mudanças do dia, no mesmo formato da lista.

Cancelar uma mudança

POST/api/v1/vendor/publishing-calendar/{id}/cancelSeller

Cancela uma mudança agendada

Só funciona para mudanças em scheduled de produtos do seller. O motivo de recusa é o mesmo para "já aplicada", "não existe" e "é de outro seller", para não revelar o que existe.

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de caminho

iduuidobrigatório
Id da mudança agendada.

Exemplo de requisição

200Mudança cancelada

Erros

StatusQuandoCorpo de exemplo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário do seller (equipe) não tem nenhum dos privilégios exigidos. O dono da loja nunca recebe este erro.{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog","vendor_view_catalog","vendor_manage_products","vendor_manage_master","vendor_manage_mix","vendor_manage_quotes","vendor_manage_features","vendor_import_products"]}
403O usuário autenticado não está vinculado a nenhum seller.{"error":"no vendor account associated with this user"}
400month fora do formato AAAA-MM.{"error":"failed","detail":"invalid month (want YYYY-MM)"}
422Cancelamento recusado: já aplicada, inexistente ou de outro seller.{"error":"failed","detail":"not cancellable (already applied, missing, or not yours)"}
Só leitura e cancelamento

O namespace do seller não tem rota para criar ou editar agendamentos. O que se pode fazer aqui é acompanhar e, antes da data, cancelar. O total da lista conta os itens devolvidos (no máximo 500).

Veja também

  • Visão geral
  • Modo férias
  • Ids, dinheiro e datas
Anterior
Termos do marketplace
Próxima
Utilidades da vitrine
Nesta página
  • Listar mudanças
  • Exemplo de requisição
  • Ver o calendário do mês
  • Exemplo de requisição
  • Cancelar uma mudança
  • Exemplo de requisição
  • Erros
  • Veja também
bash
curl -X GET "$BASE_URL/api/v1/vendor/publishing-calendar?status=scheduled&from=2026-11-01T00:00:00Z" \
  -H "Authorization: Bearer $TOKEN"
bash
curl -X GET "$BASE_URL/api/v1/vendor/publishing-calendar/calendar?month=2026-11" \
  -H "Authorization: Bearer $TOKEN"
bash
curl -X POST "$BASE_URL/api/v1/vendor/publishing-calendar/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/cancel" \
  -H "Authorization: Bearer $TOKEN"
json
{
  "items": [
    {
      "id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
      "batch_id": "2b1a9c8d-7e6f-4a5b-9c4d-3e2f1a0b9c8d",
      "entity_type": "product",
      "entity_id": "1c5e8a30-92b4-4d6f-8e21-5a7b9c0d3e44",
      "entity_label": "Chinelo Verão Azul",
      "field": "price",
      "new_value": 3990,
      "revert_value": 4990,
      "apply_at": "2026-11-25T03:00:00Z",
      "revert_at": "2026-11-30T03:00:00Z",
      "status": "scheduled",
      "created_by": "0fd409fb-9869-4c50-a18c-a810a19abeed",
      "created_at": "2026-10-11T12:00:00Z"
    }
  ],
  "total": 1
}
json
{
  "days": [
    {
      "date": "2026-11-25",
      "items": [
        {
          "id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
          "batch_id": "2b1a9c8d-7e6f-4a5b-9c4d-3e2f1a0b9c8d",
          "entity_type": "product",
          "entity_id": "1c5e8a30-92b4-4d6f-8e21-5a7b9c0d3e44",
          "entity_label": "Chinelo Verão Azul",
          "field": "price",
          "new_value": 3990,
          "revert_value": 4990,
          "apply_at": "2026-11-25T03:00:00Z",
          "revert_at": "2026-11-30T03:00:00Z",
          "status": "scheduled",
          "created_by": "0fd409fb-9869-4c50-a18c-a810a19abeed",
          "created_at": "2026-10-11T12:00:00Z"
        }
      ]
    }
  ]
}
json
{
  "status": "cancelled"
}