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

Modo férias

Liga, consulta e desliga o modo férias da loja do seller, com mensagem e data de volta.

Use quando o seller vai parar de despachar por um tempo. Com o modo ligado, os produtos do seller carregam vendor_on_vacation: true nas respostas de catálogo, e a vitrine mostra a message aos clientes. O motor do carrinho não impede a compra: a decisão de avisar ou bloquear é da vitrine.

Consultar

GET/api/v1/vendor/vacationSeller

Estado do modo férias

Cabeçalhos

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

Exemplo de requisição

200Em férias
200Fora de férias

Campos da resposta

vendor_iduuid
Seller.
company_namestring
Nome do seller.
is_on_vacationboolean
true se o modo está ligado.
messagestring
Mensagem aos clientes. Ausente se não definida.
untilstring
Data de volta (RFC 3339). Ausente = sem data. Informativa.
started_atstring
Quando o modo foi ligado pela última vez.

Ligar

POST/api/v1/vendor/vacationSeller

Liga o modo férias

Pode ser chamado de novo com o modo já ligado: message, until e started_at são regravados. Um corpo vazio {} liga o modo sem mensagem e sem data.

Cabeçalhos

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

Corpo da requisição

messagestring
Mensagem mostrada aos clientes. Omita ou envie null para nenhuma.
untilstring
Data de volta (RFC 3339). Omita para indefinido. Não é validada contra o passado.

Exemplo de requisição

200Modo ligado

Desligar

DELETE/api/v1/vendor/vacationSeller

Desliga o modo férias

Desliga e limpa message, until e started_at. Chamar com o modo já desligado também responde 200.

Cabeçalhos

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

Exemplo de requisição

200Modo desligado

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"}
404O usuário não está vinculado a um seller.{"error":"VENDOR_NOT_FOUND"}
400JSON inválido, ou until que não é RFC 3339.{"error":"INVALID_REQUEST_BODY","detail":"..."}
500Falha ao gravar ou ler.{"error":"VACATION_SET_FAILED","detail":"..."}
A data de volta não desliga as férias

Existe uma rotina de administração que encerra férias vencidas, mas ela só roda quando alguém a aciona. Na prática, until é só um aviso aos clientes. Se a sua integração agenda a volta, chame DELETE na data.

Veja também

  • Visão geral
  • Termos
Anterior
Operação da loja do seller
Próxima
Termos do marketplace
Nesta página
  • Consultar
  • Exemplo de requisição
  • Ligar
  • Exemplo de requisição
  • Desligar
  • Exemplo de requisição
  • Erros
  • Veja também
bash
curl -X GET "$BASE_URL/api/v1/vendor/vacation" \
  -H "Authorization: Bearer $TOKEN"
bash
curl -X POST "$BASE_URL/api/v1/vendor/vacation" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "Voltamos em 20/11. Pedidos feitos agora serão enviados na volta.",
  "until": "2026-11-20T00:00:00Z"
}'
bash
curl -X DELETE "$BASE_URL/api/v1/vendor/vacation" \
  -H "Authorization: Bearer $TOKEN"
json
{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "company_name": "Loja Seller Teste",
  "is_on_vacation": true,
  "message": "Voltamos em 20/11. Pedidos feitos agora serão enviados na volta.",
  "until": "2026-11-20T00:00:00Z",
  "started_at": "2026-10-11T12:00:00Z"
}
json
{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "company_name": "Loja Seller Teste",
  "is_on_vacation": false
}
json
{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "company_name": "Loja Seller Teste",
  "is_on_vacation": true,
  "message": "Voltamos em 20/11. Pedidos feitos agora serão enviados na volta.",
  "until": "2026-11-20T00:00:00Z",
  "started_at": "2026-10-11T12:00:00Z"
}
json
{
  "success": true,
  "message": "Vacation mode ended"
}