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

Equipe do seller

Lista, adiciona e remove os usuários que administram o painel de um seller, com papéis de gerente e membro.

A equipe de um seller são os usuários que entram no painel dele. Cada pessoa tem um papel: owner (dono, um por seller, criado com o cadastro), manager ou member. O administrador da loja pode acrescentar e remover gerentes e membros. Ler exige view_vendors ou manage_vendors; escrever exige manage_vendors. O dono também gerencia a própria equipe pelo painel do seller.

Listar a equipe

GET/api/v1/admin/vendors/{id}/teamAdmin

Lista os usuários da equipe de um seller

Parâmetros de caminho

iduuidobrigatório
Id do seller.
200Equipe
json
{
  "members": [
    {
      "user_id": "0fd409fb-9869-4c50-a18c-a810a19abeed",
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "role": "owner",
      "first_name": "Aurora",
      "last_name": "Menezes",
      "email": "aurora@lojateste.example.com",
      "status": "A",
      "email_verified": true,
      "created_at": "2026-07-13T04:19:10Z"
    },
    {
      "user_id": "ba6b819a-eea7-4265-a9ae-b65815b5a4ec",
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "role": "manager",
      "first_name": "Mateus",
      "last_name": "Fonseca",
      "email": "mateus@lojateste.example.com",
      "status": "A",
      "email_verified": true,
      "created_at": "2026-06-19T17:18:07Z"
    }
  ]
}

Campos da resposta

membersarray
Usuários da equipe.
members[].user_iduuid
Id do usuário.
members[].rolestring
ownermanagermember
Papel na equipe.
members[].first_namestring
Nome.
members[].last_namestring
Sobrenome.
members[].emailstring
E-mail de login.
members[].statusstring
Status da conta de usuário, em letra (A ativa).
members[].email_verifiedboolean
Se o e-mail foi confirmado.
members[].created_atstring
Quando entrou na equipe.

Adicionar à equipe

Procura um usuário pelo e-mail. Se ele já existe e é do tipo seller, é só vinculado ao seller. Se não existe, é criado (a senha é obrigatória). Se o e-mail pertence a um cliente ou administrador, a operação é recusada.

POST/api/v1/admin/vendors/{id}/teamAdmin

Adiciona um usuário à equipe do seller

Parâmetros de caminho

iduuidobrigatório
Id do seller.

Corpo da requisição

emailstringobrigatório
E-mail do usuário. Minúsculas e sem espaços.
rolestringpadrão: member
managermember
Papel. owner é reservado e devolve 400 invalid_role.
passwordstring
Senha. Obrigatória quando o usuário ainda não existe.
first_namestring
Nome (usuário novo).
last_namestring
Sobrenome (usuário novo).
usergroup_idsarray
Grupos de privilégio do seller a conceder ao usuário. Grupos que falham são ignorados em silêncio.
bash
curl -X POST "$BASE_URL/api/v1/admin/vendors/94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36/team" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"mateus@lojateste.example.com","role":"manager","password":"Senha-Forte-2026","first_name":"Mateus","last_name":"Fonseca"}'
201Usuário adicionado
json
{
  "user_id": "ba6b819a-eea7-4265-a9ae-b65815b5a4ec",
  "members": [
    { "user_id": "ba6b819a-eea7-4265-a9ae-b65815b5a4ec", "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36", "role": "manager", "email": "mateus@lojateste.example.com", "status": "A" }
  ]
}

A resposta traz o user_id e a equipe atualizada.

Remover da equipe

Tira o vínculo do usuário com o seller. A conta de usuário não é apagada. O dono não pode ser removido por aqui.

DELETE/api/v1/admin/vendors/{id}/team/{userId}Admin

Remove um usuário da equipe do seller

Parâmetros de caminho

iduuidobrigatório
Id do seller.
userIduuidobrigatório
Id do usuário.
200Removido
json
{ "removed": true }

Erros

StatusQuandoCorpo de exemplo
400Falta email.{"error":"email_required","detail":"email is required"}
400role fora de manager/member.{"error":"invalid_role","detail":"role must be 'manager' or 'member'"}
400Usuário novo sem password.{"error":"password_required","detail":"a password is required to create a new vendor administrator"}
400Falha ao criar o usuário ou ao vincular.{"error":"user_create_failed","detail":"..."}
409O e-mail é de uma conta que não é de seller.{"error":"email_in_use","detail":"this email already belongs to a non-vendor account"}
409Tentativa de remover o dono.{"error":"cannot_remove_owner","detail":"cannot remove vendor owner via team-member API"}
500id que não é UUID (na listagem).{"error":"list_team_failed","detail":"..."}
401 / 403Sem token ou sem privilégio.{"error":"missing authorization header"}
A equipe pode listar usuários sem dados

Na lista pode aparecer um membro com email e nomes vazios e status vazio: é um vínculo sem usuário correspondente. Se não for o dono, pode ser removido com DELETE.

Dar acesso é dar acesso ao painel inteiro

Um membro entra no painel do seller com os privilégios dos grupos que você conceder em usergroup_ids. Conceda apenas o necessário.

Veja também

  • Configurações do seller
  • Visão geral
Anterior
Saldo, extrato e receita do seller
Próxima
Configurações do seller
Nesta página
  • Listar a equipe
  • Adicionar à equipe
  • Remover da equipe
  • Erros
  • Veja também