Vínculo com grupos
Coloque um usuário num grupo, mude o status do vínculo, tire-o do grupo e veja a quais grupos ele pertence.
O vínculo liga um usuário a um grupo e tem um status próprio (A ativo, P pendente, F disponível, D recusado; veja Grupos de usuários). Só vínculos ativos (A) contam para preço, pagamento e promoções.
Use estas operações para refletir no sistema as regras do seu ERP ("este cliente agora é Atacado"), ou para aprovar quem pediu para entrar num grupo. Para colocar muitos clientes de uma vez, por CNPJ, veja Sincronização por CNPJ.
Ao tirar alguém de um grupo, o vínculo não é apagado: ele vira F (disponível). A linha fica guardada e o usuário pode voltar. O gesto é um DELETE ou um PUT com status: "F", e a resposta é 204.
/api/v1.0/users/{user_id}/usergroupsAdminGrupos de um usuário
Lista os grupos do usuário e o status de cada vínculo. Grupos desativados (D) não aparecem. Também responde em /api/users/{user_id}/usergroups.
Parâmetros de caminho
user_idstringobrigatório{
"usergroups": [
{ "usergroup_id": "f4652f1d-fa2c-4ac8-9cc8-bba8c308f19b", "usergroup": "Atacado", "status": "A" },
{ "usergroup_id": "83dfbe9c-9ae4-49c9-a3f6-960ade0a0f52", "usergroup": "Atacado Sul", "status": "P" }
]
}/api/v1.0/users/{user_id}/usergroupsAdminVincular um usuário a um grupo (indisponível)
Esta rota só está ligada em lojas com um modo de compatibilidade específico. Nas demais, responde 404 com o texto 404 page not found, como qualquer rota que não existe. Para vincular, use PUT /api/v1.0/users/{user_id}/usergroups/{group_id}.
Parâmetros de caminho
user_idstringobrigatório/api/v1.0/users/{user_id}/usergroups/{group_id}AdminConsultar o vínculo de um usuário com um grupo (indisponível)
Rota do contrato da Venddor 1.0 que só existe em lojas com um modo de compatibilidade específico ligado. Nas demais, responde 404 com o texto 404 page not found, como qualquer rota que não existe.
Parâmetros de caminho
user_idstringobrigatóriogroup_idstringobrigatório/api/v1.0/users/{user_id}/usergroups/{group_id}AdminConsultar o vínculo de um usuário com um grupo (indisponível)
Rota do contrato da Venddor 1.0 que só existe em lojas com um modo de compatibilidade específico ligado. Nas demais, responde 404 com o texto 404 page not found, como qualquer rota que não existe.
Parâmetros de caminho
user_idstringobrigatóriogroup_idstringobrigatório/api/v1.0/users/{user_id}/usergroups/{group_id}AdminDefinir o status de um usuário num grupo
Cria o vínculo se não existe, ou muda o status se já existe. status: "F" equivale a tirar do grupo (responde 204). O grupo precisa existir e não pode estar desativado.
Parâmetros de caminho
user_idstringobrigatóriogroup_idstringobrigatórioCorpo da requisição
statusstringobrigatórioAPFD{
"user_id": "3dc023ca-3746-4b6e-8afd-686a4a9af99f",
"usergroup_id": "83dfbe9c-9ae4-49c9-a3f6-960ade0a0f52",
"status": "P",
"message": "status_changed"
}/api/v1.0/users/{user_id}/usergroups/{group_id}AdminTirar um usuário de um grupo
Marca o vínculo como F (disponível): o usuário deixa de contar como membro, mas a linha é guardada. Responde 204.
Parâmetros de caminho
user_idstringobrigatóriogroup_idstringobrigatórioErros
| Status | Quando | Corpo |
|---|---|---|
| 400 | status ausente ou inválido | PUT sem status: {"message":"Required field: status","status":400} |
| 401 | Sem credenciais ou token expirado | {"message":"Invalid credentials","status":401} |
| 403 | Usuário que não é administrador | {"message":"Forbidden: admin scope required","status":403} |
| 404 | POST ou GET de um vínculo em loja comum | 404 page not found |
| 500 | Grupo inexistente ou status inválido | {"message":"usergroup ... not found","status":500} |