Grupos internos
Vincula, pelo CNPJ, os usuários de uma loja a um grupo identificado pelo código interno do ERP.
Um grupo interno é um grupo de usuários que o ERP identifica pelo próprio código (internal_code), em vez do nome ou do id da plataforma. A rota recebe o CNPJ do cliente, o código do grupo e o status e responde com o usuário encontrado. Para a gestão normal de grupos e vínculos veja Grupos e Vínculo com grupos.
Informar o grupo de um cliente
/api/v1.0/internal_usergroups/{company_id}AdminInformar o grupo interno de um cliente
Parâmetros de caminho
company_idstringobrigatórioCorpo da requisição
cnpjstringobrigatóriostatusstringobrigatórioA (ativo) ou D (desativado). Qualquer texto não vazio é aceito e devolvido.usergroupstringobrigatórioExemplo de requisição
curl -u "$EMAIL:$API_KEY" -X PUT "$BASE_URL/api/v1.0/internal_usergroups/bdae95a3-b60c-4985-beee-aacd4b886486" \
-H "Content-Type: application/json" \
-d '{"cnpj":"11.222.333/0001-81","status":"A","usergroup":"atacado"}'Resposta
{
"status": "A",
"user_id": "220b672c-90fe-4841-ae86-bd4f1ace982e",
"usergroup": "atacado"
}Campos da resposta
user_iduuidusergroupstringstatusstringErros
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 400 | Corpo que não é JSON. | {"message":"invalid request body","status":400} |
| 400 | cnpj, status ou usergroup ausente. | {"message":"cnpj, status, and usergroup are required","status":400} |
| 401 | Sem credencial. | {"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401} |
| 403 | Usuário que não é administrador. | {"message":"Forbidden: admin scope required","status":403} |
| 404 | Nenhum usuário com esse CNPJ. | {"message":"User Not Found","status":404} |
Rotas do modo de compatibilidade específico
O caminho singular /api/v1.0/internal_usergroup tem mais cinco operações no contrato da Venddor 1.0. Elas só são ligadas em lojas com um modo de compatibilidade específico; nas demais, respondem 404 com 404 page not found.
/api/v1.0/internal_usergroupAdminListar grupos internos (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.
/api/v1.0/internal_usergroup/{company_id}AdminConsultar grupos internos de uma loja (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
company_idstringobrigatório/api/v1.0/internal_usergroupAdminCriar vínculo de grupo interno (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.
/api/v1.0/internal_usergroup/{company_id}AdminAtualizar grupo interno de uma loja (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
company_idstringobrigatório/api/v1.0/internal_usergroup/{company_id}AdminExcluir grupo interno de uma loja (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
company_idstringobrigatório