Reten Docs
Comércios

Usuários de Comércio

Gerencie usuários, funções e contatos de um comércio.

POST /api/commerces/:cId/users

Cria um usuário para um comércio.

Auth: Obrigatória — permissão commerce:manage

Corpo da Requisição

CampoTipoObrigatórioDescrição
namestringNãoNome completo do usuário do comércio
external_idstringNãoIdentificador do sistema externo
sourcestringNãoOrigem do contato: RETEN ou INTEGRATION
rolesstring[]NãoFunções iniciais: OWNER, ORDERS, FINANCE, ATTENTION, ADMIN, COMMERCE_REP, OTHER

Exemplo

curl -X POST https://api.reten.ai/api/commerces/<cId>/users \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Maria Garcia",
    "external_id": "usr-001",
    "source": "RETEN",
    "roles": ["OWNER"]
  }'
import axios from 'axios';

const response = await axios.post(
  'https://api.reten.ai/api/commerces/<cId>/users',
  {
    name: 'Maria Garcia',
    external_id: 'usr-001',
    source: 'RETEN',
    roles: ['OWNER'],
  },
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

const user = response.data;

Resposta 201 Created

Retorna o objeto de usuário criado.


PATCH /api/commerces/:cId/users/:uId

Atualiza um usuário do comércio.


POST /api/commerces/:cId/users/:uId/roles

Adiciona uma função a um usuário do comércio.

Corpo da Requisição

CampoTipoObrigatórioDescrição
rolestringSimUm de: OWNER, ORDERS, FINANCE, ATTENTION, ADMIN, COMMERCE_REP, OTHER

Resposta 201 Created


DELETE /api/commerces/:cId/users/:uId/roles/:role

Remove uma função de um usuário do comércio.

Resposta 204 No Content


POST /api/commerces/:cId/users/:uId/contacts

Adiciona um contato a um usuário do comércio.

Corpo da Requisição

CampoTipoObrigatórioDescrição
contact_typestringSimEMAIL, PHONE, WHATSAPP ou OTHER
valuestringSimValor do contato (validado de acordo com o tipo)
sourcestringSimOrigem do contato: RETEN ou INTEGRATION
is_primarybooleanNãoDefinir como contato principal para este tipo

Validação

TipoFormato
EMAILExpressão regular de e-mail válido
PHONEFormato E.164 (ex., +56912345678)
WHATSAPPFormato E.164

Resposta 201 Created


PATCH /api/commerces/:cId/users/:uId/contacts/:contactId

Atualiza um contato.


POST /api/commerces/:cId/users/:uId/contacts/:contactId/set-primary

Define um contato como principal para seu tipo.

Notas

  • Apenas um contato principal por tipo por usuário do comércio (entre os contatos ativos)
  • Definir um novo contato principal remove automaticamente o anterior para esse tipo