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

Visibilidade do seller

Esconde um seller da vitrine ou o restringe a grupos de clientes, e lista as regras de visibilidade de todos os sellers.

Por padrão a loja de um seller aparece para todo mundo. A visibilidade deixa o administrador mudar isso: esconder o seller por completo (is_hidden) ou liberá-lo só para certos grupos de clientes (allowed_usergroups), útil em B2B quando um fornecedor só atende alguns clientes. O módulo vendor-visibility precisa estar ligado. Ler exige view_vendors ou manage_vendors; gravar exige manage_vendor_visibility ou manage_vendors.

Listar todos os sellers com a visibilidade

Devolve todo seller ativo com a regra de visibilidade dele (uma regra padrão, "visível a todos", para quem nunca teve uma).

GET/api/v1/admin/vendors/visibilityAdmin

Lista a visibilidade de todos os sellers

Parâmetros de consulta

searchstring
Parte da razão social do seller.
pageintegerpadrão: 1
Página, a partir de 1.
per_pageintegerpadrão: 20
Itens por página, de 1 a 100.
200Visibilidade dos sellers
json
{
  "vendors": [
    {
      "vendor_id": "c0000000-0000-0000-0000-000000000003",
      "company_name": "Casa & Cia",
      "is_hidden": false,
      "allowed_usergroups": [],
      "customer_mode": "",
      "customer_ids": null,
      "customer_visibility_available": false,
      "updated_at": "2026-07-20T02:21:09Z"
    }
  ],
  "total": 12,
  "page": 1,
  "per_page": 20,
  "total_pages": 1
}

Campos da resposta

vendorsarray
Sellers da página. Pode vir null quando não há nenhum.
vendors[].vendor_iduuid
Seller.
vendors[].company_namestring
Razão social.
vendors[].is_hiddenboolean
true esconde o seller de toda a vitrine.
vendors[].allowed_usergroupsarray
Ids dos grupos de clientes que enxergam o seller. Vazio = todos (se não estiver oculto).
vendors[].customer_modestring
Modo de visibilidade por cliente, definido pelo próprio seller (all ou uma lista). Vazio/ausente nas listas.
vendors[].customer_idsarray
Clientes liberados no modo por cliente.
vendors[].customer_visibility_availableboolean
Se a loja tem o recurso de visibilidade por cliente.
vendors[].updated_atstring
Última alteração da regra (RFC 3339).
totalinteger
Total.
pageinteger
Página.
per_pageinteger
Itens por página.
total_pagesinteger
Número de páginas.

Listar sellers com regra gravada

Mesmo formato, mas só os sellers que têm uma regra gravada (mesmo que ela diga "visível a todos"). Apesar do nome hidden, não filtra por is_hidden.

GET/api/v1/admin/vendors/visibility/hiddenAdmin

Lista os sellers com regra de visibilidade gravada

Parâmetros de consulta

searchstring
Parte da razão social.
pageintegerpadrão: 1
Página.
per_pageintegerpadrão: 20
Itens por página, de 1 a 100.

A resposta tem o mesmo formato da lista anterior, ordenada da regra mais recente para a mais antiga.

Ler a visibilidade de um seller

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

Lê a regra de visibilidade de um seller

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.
200Visibilidade
json
{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "company_name": "Loja Seller Teste",
  "is_hidden": false,
  "allowed_usergroups": [],
  "customer_mode": "all",
  "customer_ids": [],
  "customer_visibility_available": false,
  "updated_at": "2026-07-14T00:34:48Z"
}

Para um seller sem regra gravada, a resposta é a padrão (visível a todos). Isso inclui um UUID que não é de nenhum seller: a leitura não dá 404.

Definir a visibilidade

Grava a regra do seller (cria ou substitui). Os dois campos são gravados juntos: o que você não enviar volta ao padrão (is_hidden: false, sem grupos).

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

Define a regra de visibilidade de um seller

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller. Precisa existir.

Corpo da requisição

is_hiddenbooleanpadrão: false
true esconde o seller da vitrine.
allowed_usergroupsarraypadrão: []
Ids dos grupos de clientes que podem ver o seller. Vazio libera para todos.
bash
curl -X PUT "$BASE_URL/api/v1/admin/vendors/94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36/visibility" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"is_hidden": false, "allowed_usergroups": ["a1111111-1111-1111-1111-111111111111"]}'

A resposta (200) é a regra gravada, no formato da leitura.

Erros

StatusQuandoCorpo de exemplo
400Corpo do PUT não é JSON.{"error":"INVALID_REQUEST_BODY","detail":"..."}
500PUT em seller que não existe.{"error":"VENDOR_VISIBILITY_SET_FAILED","detail":"vendor ... not found"}
500vendorId que não é UUID.{"error":"VENDOR_VISIBILITY_GET_FAILED","detail":"..."}
401 / 403Sem token, módulo desligado ou sem privilégio.{"error":"module_disabled","module":"vendor-visibility"}
Esconder o seller esconde a loja inteira

Com is_hidden: true, o seller deixa de aparecer na vitrine, inclusive nas listagens de sellers. Confira na sua vitrine o efeito sobre os produtos dele antes de usar em produção.

A regra por cliente é do seller

customer_mode e customer_ids mostram a regra que o próprio seller configurou pelo painel dele. O administrador a vê aqui, mas não a altera por estas rotas.

Veja também

  • Férias do seller
  • Visão geral
Anterior
Privilégios do seller
Próxima
Férias do seller
Nesta página
  • Listar todos os sellers com a visibilidade
  • Listar sellers com regra gravada
  • Ler a visibilidade de um seller
  • Definir a visibilidade
  • Erros
  • Veja também