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

Termos de uso dos sellers

Gerencia as versões dos termos de uso que o seller precisa aceitar para vender, com listar, criar, editar, ativar e excluir.

Os termos de uso são o contrato que o seller aceita para vender no marketplace. A loja guarda versões numeradas (1, 2, 3...), e só uma é a ativa. O seller aceita a versão ativa pelo painel dele; a plataforma registra quem aceitou, quando e de qual endereço de rede (prova jurídica). Quando você publica uma versão nova, os aceites antigos deixam de valer para a versão corrente e o seller é chamado a aceitar de novo.

Todas as rotas desta página pedem manage_vendor_terms ou manage_vendors. O texto (content) é HTML.

Listar versões

Devolve todas as versões, da mais nova para a mais antiga, com o texto completo. Sem paginação.

GET/api/v1/admin/vendor-termsAdmin

Lista as versões dos termos de uso

Sem parâmetros.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/vendor-terms" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Versões retornadas
json
{
  "terms": [
    {
      "id": "6b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
      "title": "Termos de uso do marketplace",
      "content": "<h1>Termos</h1><p>Ao vender na plataforma, você concorda...</p>",
      "version": 2,
      "is_active": true,
      "created_at": "2026-10-11T22:00:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

termsarray
Versões, da maior para a menor.
totalinteger
Quantidade de versões.
terms[].iduuid
Id da versão.
terms[].titlestring
Título.
terms[].contentstring
Texto em HTML.
terms[].versioninteger
Número da versão, sequencial a partir de 1.
terms[].is_activeboolean
Se é a versão que o seller deve aceitar agora.
terms[].created_atstring
Criação, RFC 3339 em UTC.

Erros

StatusQuandoCorpo
401 / 403Sem token ou sem privilégio{"error":"insufficient privileges", ...}
500Falha interna{"error":"TERMS_LIST_FAILED","detail":"..."}

Criar uma versão

Cria a próxima versão (maior número existente mais 1) e já a ativa, desativando a que estava ativa. A partir daí o seller precisa aceitar a nova versão. Para preparar um texto sem publicar, crie e ative depois outra versão; não há rascunho.

POST/api/v1/admin/vendor-termsAdmin

Cria e ativa uma nova versão dos termos

Corpo da requisição

titlestringobrigatório
Título da versão.
contentstringobrigatório
Texto dos termos, em HTML.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/vendor-terms" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Termos de uso do marketplace", "content": "<h1>Termos</h1><p>Ao vender na plataforma, você concorda...</p>"}'

Resposta

201Versão criada
json
{
  "id": "6b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
  "title": "Termos de uso do marketplace",
  "content": "<h1>Termos</h1><p>Ao vender na plataforma, você concorda...</p>",
  "version": 1,
  "is_active": true,
  "created_at": "2026-10-11T22:00:00Z"
}

Erros

StatusQuandoCorpo
400Corpo que não é JSON{"error":"INVALID_INPUT","detail":"invalid JSON body"}
400title ou content vazio{"error":"TERMS_CREATE_FAILED","detail":"content is required"}
Não dá para apagar o que está ativo

Uma versão ativa não pode ser excluída, e não existe rota para "desativar" sem ativar outra. Revise o texto antes de criar: se errar, edite a versão (veja abaixo) ou crie e ative uma nova.

Consultar uma versão

GET/api/v1/admin/vendor-terms/{id}Admin

Detalha uma versão dos termos

Parâmetros de caminho

iduuidobrigatório
Id da versão.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/vendor-terms/6b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Versão retornada
json
{
  "id": "6b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
  "title": "Termos de uso do marketplace",
  "content": "<h1>Termos</h1><p>Ao vender na plataforma, você concorda...</p>",
  "version": 1,
  "is_active": true,
  "created_at": "2026-10-11T22:00:00Z"
}

Erros

StatusQuandoCorpo
404Versão inexistente{"error":"TERMS_NOT_FOUND","detail":"terms version not found"}
500id que não é UUID{"error":"TERMS_GET_FAILED","detail":"..."}

Editar uma versão

Troca título e texto no lugar, sem criar versão nova. Os aceites já registrados continuam valendo. Por isso, use para corrigir erro de digitação; mudança de conteúdo que exija novo aceite pede uma versão nova (Criar uma versão, nesta página).

PUT/api/v1/admin/vendor-terms/{id}Admin

Edita título e texto de uma versão

Parâmetros de caminho

iduuidobrigatório
Id da versão.

Corpo da requisição

titlestringobrigatório
Novo título.
contentstringobrigatório
Novo texto, em HTML.

Exemplo de requisição

bash
curl -X PUT "$BASE_URL/api/v1/admin/vendor-terms/6b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Termos de uso do marketplace", "content": "<h1>Termos</h1><p>Texto corrigido.</p>"}'

Resposta

200Versão editada
json
{
  "id": "6b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
  "title": "Termos de uso do marketplace",
  "content": "<h1>Termos</h1><p>Texto corrigido.</p>",
  "version": 1,
  "is_active": true,
  "created_at": "2026-10-11T22:00:00Z"
}

Erros

StatusQuandoCorpo
400Corpo que não é JSON{"error":"INVALID_INPUT","detail":"invalid JSON body"}
400title ou content vazio, ou versão inexistente{"error":"TERMS_UPDATE_FAILED","detail":"terms 0000... not found"}

Ativar uma versão

Torna a versão indicada a ativa e desativa a atual. Serve para voltar a uma versão antiga. O seller precisará aceitar a versão que ficou ativa, se ainda não aceitou.

POST/api/v1/admin/vendor-terms/{id}/activateAdmin

Ativa uma versão dos termos

Parâmetros de caminho

iduuidobrigatório
Id da versão a ativar.

Sem corpo.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/vendor-terms/6b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e/activate" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Versão ativada
json
{ "status": "activated" }

Erros

StatusQuandoCorpo
400Versão inexistente, ou falha ao gravar{"error":"TERMS_ACTIVATE_FAILED","detail":"terms 0000... not found"}
Id inexistente deixa a loja sem termos ativos

A plataforma desativa a versão corrente antes de procurar a nova. Se o id não existir, a resposta é 400, mas a versão que estava ativa já foi desativada, e nenhuma fica ativa até você ativar uma. Confirme o id na lista antes de chamar.

Excluir uma versão

Remove uma versão inativa e os aceites registrados nela. Versão ativa não pode ser excluída.

DELETE/api/v1/admin/vendor-terms/{id}Admin

Exclui uma versão inativa dos termos

Parâmetros de caminho

iduuidobrigatório
Id da versão.

Exemplo de requisição

bash
curl -X DELETE "$BASE_URL/api/v1/admin/vendor-terms/6b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Versão excluída
json
{ "status": "deleted" }

Erros

StatusQuandoCorpo
400Versão inexistente{"error":"TERMS_DELETE_FAILED","detail":"terms 0000... not found"}
400Versão ativa{"error":"TERMS_DELETE_FAILED","detail":"cannot delete active terms; deactivate first by activating another version"}

Veja também

  • Candidaturas
  • Cadastro de sellers: visão geral
Anterior
Documentos de sellers
Próxima
Vitrines dos sellers
Nesta página
  • Listar versões
  • Exemplo de requisição
  • Resposta
  • Erros
  • Criar uma versão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Consultar uma versão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Editar uma versão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Ativar uma versão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Excluir uma versão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também