API legada/Referência completa/Grupos de usuários

Filtros

Parâmetros de consulta do GET /api/usergroups que encontram grupos por tipo e status.

Use estes parâmetros para encontrar grupos de usuários com propriedades específicas. Eles ajudam a localizar rapidamente os grupos por tipo e status.

GET/api/usergroupsAdmin

Retorna grupos de usuários filtrados por tipo e status

Parâmetros de consulta

typestring

AC

Mostra os grupos de usuários de um tipo específico.

A: grupo de administradores
C: grupo de clientes

statusstring

AHD

Mostra os grupos de usuários com um status específico.

A: ativo
H: oculto
D: desativado

Exemplos de requisição

Grupos ativos

Esta requisição retorna um array com todos os grupos de usuários ativos.

bash

curl "$BASE_URL/api/usergroups?status=A" \
  -u "$EMAIL:$API_KEY"

Grupos de clientes desativados

Esta requisição retorna um array com todos os grupos de clientes com status Desativado. A referência escreve este exemplo no caminho /users:

text

https://www.venddor.com.br/api/users?status=D&type=C

Exemplo de resposta

200Grupos retornados

json

{
  "usergroups": {
    "3": {
      "usergroup_id": "3",
      "status": "A",
      "type": "C",
      "usergroup": "Premium Customers",
      "privileges": {
        "manage_catalog": "Y",
        "view_reports": "Y"
      }
    },
    "12": {
      "usergroup_id": "12",
      "status": "A",
      "type": "C",
      "usergroup": "Wholesale Buyers",
      "privileges": {
        "manage_catalog": "N",
        "view_reports": "N"
      }
    }
  }
}

Veja também