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

Férias do seller

Lista os sellers de férias, coloca um seller de férias com mensagem e data de fim, encerra as férias e limpa as vencidas.

O modo férias avisa a vitrine de que o seller está temporariamente parado. O seller mesmo pode ativá-lo pelo painel; estas rotas deixam o administrador fazer o mesmo por ele, ver quem está de férias e encerrar. Exige manage_vendor_vacation ou manage_vendors (a lista de horários exige view_vendors ou manage_vendors).

Os erros destas rotas vêm com código em maiúsculas (VENDOR_NOT_FOUND, VACATION_STATUS_FAILED).

Listar os sellers de férias

GET/api/v1/admin/vendors/vacationAdmin

Lista os sellers que estão de férias

200Sellers de férias
json
{
  "vendors": [
    {
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "company_name": "Loja Seller Teste",
      "email": "contato@lojateste.example.com",
      "message": "Voltamos dia 20, obrigado pela paciência!",
      "until": "2026-10-20T00:00:00Z",
      "started_at": "2026-10-11T12:00:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

vendorsarray
Sellers de férias, do início mais recente para o mais antigo. Vem null quando não há nenhum.
vendors[].vendor_iduuid
Seller.
vendors[].company_namestring
Razão social.
vendors[].emailstring
E-mail do seller.
vendors[].logo_urlstring
Logo, quando há.
vendors[].messagestring
Mensagem mostrada na vitrine.
vendors[].untilstring
Data prevista de volta (RFC 3339). Ausente = sem data.
vendors[].started_atstring
Quando as férias começaram.
totalinteger
Quantidade.

Ver as férias de um seller

GET/api/v1/admin/vendors/{vendorId}/vacationAdmin

Lê o estado de férias de um seller

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.
200Estado de férias
json
{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "company_name": "Loja Seller Teste",
  "is_on_vacation": false
}

Campos da resposta

is_on_vacationboolean
Se o seller está de férias.
messagestring
Mensagem, quando de férias.
untilstring
Data prevista de volta, quando há.
started_atstring
Início, quando de férias.

Colocar um seller de férias

POST/api/v1/admin/vendors/{vendorId}/vacationAdmin

Coloca um seller de férias

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.

Corpo da requisição

messagestring
Mensagem exibida na vitrine do seller.
untilstring
Data prevista de volta (RFC 3339). Sem ela, as férias não têm fim programado.
bash
curl -X POST "$BASE_URL/api/v1/admin/vendors/94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36/vacation" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"message": "Voltamos dia 20, obrigado pela paciência!", "until": "2026-10-20T00:00:00Z"}'

A resposta (200) é o estado de férias, no formato da leitura, com is_on_vacation: true.

Encerrar as férias de um seller

DELETE/api/v1/admin/vendors/{vendorId}/vacationAdmin

Encerra as férias de um seller

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.
200Encerradas
json
{ "success": true, "message": "Vendor vacation ended by admin" }

Encerrar as férias vencidas

Encerra de uma vez as férias de todos os sellers cuja data de fim (until) já passou. Pensada para rodar periodicamente.

POST/api/v1/admin/vendors/vacation/auto-endAdmin

Encerra as férias vencidas

200Resultado
json
{ "ended_count": 2 }

Férias sem until nunca são encerradas por esta rota.

Horários de funcionamento

Rota reservada: devolve sempre uma lista vazia, hoje sem dados.

GET/api/v1/admin/vendors/opening-hoursAdmin

Horários de funcionamento (lista vazia)

200Sem horários
json
{ "hours": [], "total": 0 }

Erros

StatusQuandoCorpo de exemplo
400Corpo do POST não é JSON.{"error":"INVALID_REQUEST_BODY","detail":"..."}
404Seller não existe (GET de um, POST, DELETE).{"error":"VENDOR_NOT_FOUND"}
500vendorId que não é UUID.{"error":"VACATION_STATUS_FAILED","detail":"..."} no GET; VACATION_SET_FAILED no POST; VACATION_END_FAILED no DELETE.
401 / 403Sem token ou sem privilégio.{"error":"missing authorization header"}
Seller de férias continua existindo

As férias não mudam o status do seller (A continua A) nem escondem a loja: a vitrine mostra o aviso e o selo "de férias". Para tirar o seller do ar de verdade, suspenda-o ou esconda.

Veja também

  • Visibilidade do seller
  • Visão geral
Anterior
Visibilidade do seller
Próxima
Reputação do seller
Nesta página
  • Listar os sellers de férias
  • Ver as férias de um seller
  • Colocar um seller de férias
  • Encerrar as férias de um seller
  • Encerrar as férias vencidas
  • Horários de funcionamento
  • Erros
  • Veja também