API atual/Referência completa/Conta do seller

Minha conta de seller

Identidade, privilégios, preferências de tela e menus escondidos do usuário seller autenticado.

Rotas de "quem sou eu" do usuário seller. Nenhuma exige privilégio específico: cada uma só devolve ou grava dados do usuário do token.

GET/api/v1/vendor/meSeller

Identidade do usuário seller

Devolve a identidade mínima do token: quem é o usuário e a qual seller (loja) ele pertence. É a chamada mais leve para descobrir o vendor_id depois do login.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/me" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Identidade

json

{
  "id": "2c8c0f6e-5d1a-4b7e-9a3f-6e0d1b4a7c52",
  "user_id": "2c8c0f6e-5d1a-4b7e-9a3f-6e0d1b4a7c52",
  "email": "contato@lojaexemplo.com.br",
  "user_type": "vendor",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "company_name": "Loja Exemplo Ltda",
  "slug": "loja-exemplo",
  "status": "A"
}

Campos da resposta

iduuid

Id do usuário (igual a user_id).

user_iduuid

Id do usuário.

emailstring

E-mail do usuário.

user_typestring

Sempre vendor nesta rota.

vendor_iduuid

Id do seller (loja) do usuário. É o vendor_id que as outras seções pedem.

company_namestring

Razão social ou nome da loja.

slugstring

Identificador do seller em URLs.

statusstring

Situação do seller; A é ativo.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
403	O token não é de um usuário seller.	`{"error":"vendor access required"}`
404	Usuário sem seller vinculado.	`{"error":"vendor profile not found"}`

GET/api/v1/vendor/me/privilegesSeller

Privilégios do próprio usuário seller

Lista o que esta pessoa pode fazer no painel do seller. O dono recebe todos os privilégios (is_full_admin: true); um membro recebe só a união dos privilégios dos grupos concedidos, e um membro sem grupo recebe lista vazia. Um usuário que perdeu o vínculo com a loja recebe lista vazia.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/me/privileges" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Privilégios

json

{
  "is_full_admin": false,
  "privileges": [
    "manage_products",
    "manage_orders",
    "view_analytics"
  ]
}

Campos da resposta

privilegesstring[]

Nomes dos privilégios. Nunca é nula.

is_full_adminboolean

true para o dono da loja.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao ler grupos ou privilégios.	`{"error":"failed to get usergroup links","detail":"..."}`

GET/api/v1/vendor/me/preferencesSeller

Ler preferências do usuário seller

Devolve um objeto JSON livre com as preferências de tela do usuário (por exemplo, o layout do painel). Sem nada gravado, {}.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/me/preferences" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Preferências

json

{
  "admin_layout": "classic"
}

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao ler.	`{"error":"failed to get preferences","detail":"..."}`

PUT/api/v1/vendor/me/preferencesSeller

Gravar preferências do usuário seller

Mescla o objeto enviado nas preferências do usuário e devolve o resultado completo.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Corpo da requisição

(qualquer chave)any

Objeto JSON de até 16 KiB. Cada chave de primeiro nível enviada substitui a de mesmo nome; as demais ficam como estão.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/me/preferences" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "admin_layout": "classic"
}'

Resposta

200Preferências após a mescla

json

{
  "admin_layout": "classic"
}

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
400	O corpo não é um objeto JSON.	`{"error":"body must be a JSON object","detail":"..."}`
500	Falha ao gravar.	`{"error":"failed to update preferences","detail":"..."}`

GET/api/v1/vendor/me/panel-menusSeller

Menus escondidos para o seller

Devolve as chaves de menu que a loja escondeu do painel do seller, inclusive para o dono. Serve para interfaces próprias omitirem as mesmas entradas.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/me/panel-menus" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Menus escondidos

json

{
  "hidden": [
    "group:marketing"
  ]
}

Campos da resposta

hiddenstring[]

Chaves escondidas, com prefixo domain:, group: ou item:. Vazia quando nada foi escondido. O valor do exemplo é ilustrativo.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao carregar.	`{"error":"failed to load panel menus","detail":"..."}`

Veja também

Minha conta de seller

Identidade, privilégios, preferências de tela e menus escondidos do usuário seller autenticado.

Rotas de "quem sou eu" do usuário seller. Nenhuma exige privilégio específico: cada uma só devolve ou grava dados do usuário do token.

GET/api/v1/vendor/meSeller

Identidade do usuário seller

Devolve a identidade mínima do token: quem é o usuário e a qual seller (loja) ele pertence. É a chamada mais leve para descobrir o vendor_id depois do login.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/me" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Identidade

json

{
  "id": "2c8c0f6e-5d1a-4b7e-9a3f-6e0d1b4a7c52",
  "user_id": "2c8c0f6e-5d1a-4b7e-9a3f-6e0d1b4a7c52",
  "email": "contato@lojaexemplo.com.br",
  "user_type": "vendor",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "company_name": "Loja Exemplo Ltda",
  "slug": "loja-exemplo",
  "status": "A"
}

Campos da resposta

iduuid

Id do usuário (igual a user_id).

user_iduuid

Id do usuário.

emailstring

E-mail do usuário.

user_typestring

Sempre vendor nesta rota.

vendor_iduuid

Id do seller (loja) do usuário. É o vendor_id que as outras seções pedem.

company_namestring

Razão social ou nome da loja.

slugstring

Identificador do seller em URLs.

statusstring

Situação do seller; A é ativo.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
403	O token não é de um usuário seller.	`{"error":"vendor access required"}`
404	Usuário sem seller vinculado.	`{"error":"vendor profile not found"}`

GET/api/v1/vendor/me/privilegesSeller

Privilégios do próprio usuário seller

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/me/privileges" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Privilégios

json

{
  "is_full_admin": false,
  "privileges": [
    "manage_products",
    "manage_orders",
    "view_analytics"
  ]
}

Campos da resposta

privilegesstring[]

Nomes dos privilégios. Nunca é nula.

is_full_adminboolean

true para o dono da loja.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao ler grupos ou privilégios.	`{"error":"failed to get usergroup links","detail":"..."}`

GET/api/v1/vendor/me/preferencesSeller

Ler preferências do usuário seller

Devolve um objeto JSON livre com as preferências de tela do usuário (por exemplo, o layout do painel). Sem nada gravado, {}.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/me/preferences" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Preferências

json

{
  "admin_layout": "classic"
}

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao ler.	`{"error":"failed to get preferences","detail":"..."}`

PUT/api/v1/vendor/me/preferencesSeller

Gravar preferências do usuário seller

Mescla o objeto enviado nas preferências do usuário e devolve o resultado completo.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Corpo da requisição

(qualquer chave)any

Objeto JSON de até 16 KiB. Cada chave de primeiro nível enviada substitui a de mesmo nome; as demais ficam como estão.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/me/preferences" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "admin_layout": "classic"
}'

Resposta

200Preferências após a mescla

json

{
  "admin_layout": "classic"
}

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
400	O corpo não é um objeto JSON.	`{"error":"body must be a JSON object","detail":"..."}`
500	Falha ao gravar.	`{"error":"failed to update preferences","detail":"..."}`

GET/api/v1/vendor/me/panel-menusSeller

Menus escondidos para o seller

Devolve as chaves de menu que a loja escondeu do painel do seller, inclusive para o dono. Serve para interfaces próprias omitirem as mesmas entradas.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/me/panel-menus" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Menus escondidos

json

{
  "hidden": [
    "group:marketing"
  ]
}

Campos da resposta

hiddenstring[]

Chaves escondidas, com prefixo domain:, group: ou item:. Vazia quando nada foi escondido. O valor do exemplo é ilustrativo.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao carregar.	`{"error":"failed to load panel menus","detail":"..."}`