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

Privilégios do seller

Lista e controla os recursos extras do painel que cada seller ativo pode usar, como promoções, edição em lote e acesso à API.

O painel do seller tem recursos que todo seller ativo já usa e outros que o administrador libera um a um. Os cinco básicos (manage_products, manage_orders, view_analytics, manage_shipping, manage_profile) são implícitos: não aparecem como concedidos nem se concedem ou revogam. Os oito extras são: manage_promotions, bulk_edit, export_data, api_access, manage_usergroups, manage_delivery_areas, view_customers e manage_messages.

Exige manage_vendor_usergroups ou manage_vendors. Esses privilégios são do seller como empresa, não de cada pessoa da equipe dele.

Ler os privilégios

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

Lista os privilégios de um seller

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.
200Privilégios do seller
json
{
  "privileges": [
    { "privilege": "manage_products", "section_id": "catalog", "description": "Create, edit, and delete own products", "is_default": true },
    { "privilege": "manage_orders", "section_id": "orders", "description": "View and manage orders for own products", "is_default": true },
    { "privilege": "view_analytics", "section_id": "analytics", "description": "View sales analytics and reports", "is_default": true },
    { "privilege": "manage_shipping", "section_id": "shipping", "description": "Configure shipping methods and delivery areas", "is_default": true },
    { "privilege": "manage_profile", "section_id": "profile", "description": "Edit vendor profile, logo, and contact info", "is_default": true }
  ],
  "total": 5
}

Campos da resposta

privilegesarray
Os cinco básicos mais os extras já concedidos. Lista vazia se o seller não está ativo.
privileges[].privilegestring
Nome do privilégio.
privileges[].section_idstring
Seção do painel a que ele pertence (catalog, orders, marketing...).
privileges[].descriptionstring
Descrição (em inglês).
privileges[].is_defaultboolean
true nos cinco básicos; false nos extras concedidos.
totalinteger
Quantidade devolvida.

Substituir os extras

Apaga os extras atuais e grava a lista enviada. Nomes dos cinco básicos na lista são ignorados; qualquer outro nome desconhecido recusa a chamada inteira.

PUT/api/v1/admin/vendors/{vendorId}/privilegesAdmin

Define os privilégios extras de um seller

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.

Corpo da requisição

privilegesarrayobrigatório
Nomes dos extras a conceder. Lista vazia revoga todos.
bash
curl -X PUT "$BASE_URL/api/v1/admin/vendors/94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36/privileges" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"privileges": ["manage_promotions", "bulk_edit"]}'
200Privilégios atualizados
json
{ "message": "vendor privileges updated" }

Conceder um privilégio

POST/api/v1/admin/vendors/{vendorId}/privileges/{privilege}Admin

Concede um privilégio extra

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.
privilegestringobrigatório
manage_promotionsbulk_editexport_dataapi_accessmanage_usergroupsmanage_delivery_areasview_customersmanage_messages
Nome do extra.
200Concedido
json
{ "message": "privilege granted" }

Conceder um privilégio que o seller já tem não dá erro.

Revogar um privilégio

DELETE/api/v1/admin/vendors/{vendorId}/privileges/{privilege}Admin

Revoga um privilégio extra

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.
privilegestringobrigatório
Nome do extra.
200Revogado
json
{ "message": "privilege revoked" }

Erros

StatusQuandoCorpo de exemplo
400Corpo do PUT não é JSON.{"error":"INVALID_REQUEST_BODY","detail":"..."}
400Nome de privilégio desconhecido (PUT ou concessão).{"error":"VENDOR_SET_PRIVILEGES_FAILED","detail":"unknown vendor privilege: x"}
400Tentativa de conceder ou revogar um dos cinco básicos.{"error":"VENDOR_GRANT_PRIVILEGE_FAILED","detail":"privilege \"manage_products\" is a default privilege and cannot be explicitly granted"}
400Revogar um extra que o seller não tem.{"error":"VENDOR_REVOKE_PRIVILEGE_FAILED","detail":"vendor ... does not have privilege ..."}
400Seller não existe (PUT, concessão).{"error":"VENDOR_GRANT_PRIVILEGE_FAILED","detail":"vendor ... not found"}
404GET de seller que não existe.{"error":"vendor not found"}
401 / 403Sem token ou sem privilégio.{"error":"missing authorization header"}
Seller não ativo vê uma lista vazia

Para um seller pendente, suspenso ou recusado, GET devolve privileges: [], não os cinco básicos. Os básicos só valem enquanto o seller está ativo.

Prefira conceder e revogar a substituir

O PUT apaga os extras que você não repetir. Para mexer em um só, use POST ou DELETE e evite derrubar o que outro administrador acabou de conceder.

Veja também

  • Equipe do seller
  • Visão geral
Anterior
Categorias permitidas do seller
Próxima
Visibilidade do seller
Nesta página
  • Ler os privilégios
  • Substituir os extras
  • Conceder um privilégio
  • Revogar um privilégio
  • Erros
  • Veja também