Início > Grupo de Clientes
Versão: 2.0
Grupo de Clientes
Última Atualização: 22/11/2024
Gerenciamento dos grupos de clientes e associações com CNPJs, criando agrupamentos e segmentar seus clientes de acordo com critérios específicos, facilitando a seleção do público-alvo para ações de vendas ou definição de grupos de preços na plataforma.
Endpoint GET
Parâmetros da requisição
associacaoDeCliente: Boolean
Esse query param, controla se vai exibir somente os grupos com associações de clientes ou listar todos os grupos.
Ex: /onboarding/grupo-clientes?associacaoDeCliente=true
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhes da requisição.
Tipo: JSON.
success
Identificador booleano de sucesso da requisição.
Tipo: Boolean.
message
Mensagem de sucesso ou falha da requisição.
Tipo: String.
data
Detalhes da requisição.
Tipo: Array de Objeto
id
Id referente ao grupo de clientes
Tipo: Integer
nome
Nome do grupo de clientes
Tipo: String
tipo
Tipo do grupo de clientes
Tipo: String
clientes
Clientes associados ao grupo de clientes
Tipo: Array de Objeto
idAssociacao
Id referente à associação do cliente ao grupo de clientes
Tipo: Integer.
cnpj
CNPJ do cliente.
Tipo: String.
Se passado o paramêtro associacaoDeCliente como false e der sucesso, também teremos status code 200:
associacaoDeCliente: false
Ex: /onboarding/grupo-clientes?associacaoDeCliente=false
Sintaxe da Resposta
Elementos da Resposta
detail
Detalhes da requisição.
Tipo: JSON.
success
Identificador booleano de sucesso da requisição.
Tipo: Boolean.
message
Mensagem de sucesso ou falha da requisição.
Tipo: String.
data
Detalhes da requisição.
Tipo: Array de Objeto
id
Id referente ao grupo de clientes
Tipo: Integer
nome
Nome do grupo de clientes
Tipo: String
tipo
Tipo do grupo de clientes
Tipo: String
Respostas para erros
Caso ocorra algum erro durante a requisição, o erro será interno e o time técnico deverá fazer uma análise do que pode ter ocorrido.
500 Internal Server Error
GET Grupo clientes
Última Atualização: 22/11/2024
Este endpoint é responsável por fazer a busca de grupo de clientes e suas respectivas associações com os clientes, através do CNPJ.
POST Grupo de Clientes
Última Atualização: 22/11/2024
Endpoint responsável por cadastrar grupos de clientes e associá-los a uma lista de CNPJs. O fluxo inclui validações de grupos, tipos e clientes.
Endpoint POST
Sintaxe da Requisição
Para que a requisição do método Post seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da Requisição
cnpjs
Lista de CNPJs que serão associados aos grupos
Tipo: Array de String.
grupos*
Lista de grupos a serem criados
Tipo: Array de Objeto.
nome*
Nome do grupo a ser criado
Tipo: String.
tipo*
Tipo do grupo a ser criado
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhes da requisição.
Tipo: Objeto.
success
Identificador booleano de sucesso da requisição.
Tipo: Boolean.
message
Mensagem de sucesso ou falha da requisição.
Tipo: String.
data
Detalhes da requisição.
Tipo: Array de Objeto.
sucesso
Grupos criados e associados aos CNPJs fornecedidos.
Tipo: Array de Objeto.
cnpj
CNPJ do cliente.
Tipo: String.
nome
Nome do grupo de clientes
Tipo: String.
idGrupo
Id referente ao grupo de clientes
Tipo: Integer.
tipo
Tipo do grupo de clientes
Tipo: String.
falha
Detalhes de erros que ocorreram
Tipo: Objeto.
detalhesDeErros
Erros de processamento durante o fluxo de criação e associação do grupo de clientes.
Tipo: Array de String.
camposInvalidos
Erros capturados durante a validação dos dados recebidos na requisição.
Tipo: Array de Objeto.
erroAssociacao
Erros capturados durante a validação dos dados recebidos na requisição.
Tipo: Array de Objeto.
cnpj
CNPJ do cliente.
Tipo: String.
status
Indica se teve algum problema durante a associação, trazendo uma mensagem.
Tipo: String.
nome
Nome do grupo de clientes
Tipo: String.
tipo
Tipo do grupo de clientes
Tipo: String.
Em um cenário onde ocorra erros de associação, porém o grupo de clientes é criado normalmente, o retorno ainda assim será de sucesso mas com uma particularidade, exibindo o erro da associação e devolvendo o status code como 207.
207 Multi-status
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Ausência de campos obrigatórios
400 Bad Request
Falha na associação dos grupos com a lista de CNPJs
PUT Grupo de Clientes
Última Atualização: 26/11/2024
Este endpoint permite atualizar as propriedades "nome" e "tipoe" dos grupos de clientes.
Endpoint PUT
Sintaxe da Requisição
Para que a requisição do método PUT seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da Requisição
grupos*
Lista de grupos a serem criados
Tipo: Array de Objeto.
id*
ID do grupo de clientes
Tipo: Integer.
nome*
Nome do grupo a ser atualizado
Tipo: String.
tipo*
Tipo do grupo a ser atualizado
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhes da requisição.
Tipo: Objeto.
success
Identificador booleano de sucesso da requisição.
Tipo: Boolean.
message
Mensagem de sucesso ou falha da requisição.
Tipo: String.
data
Detalhes da requisição.
Tipo: Array de Objeto.
sucesso
Grupos criados e associados aos CNPJs fornecedidos.
Tipo: Array de Objeto.
id
Id referente ao grupo de clientes
Tipo: Integer.
nome
Nome do grupo de clientes
Tipo: String.
tipo
Tipo do grupo de clientes
Tipo: String.
falha
Detalhes de erros que ocorreram
Tipo: Objeto.
detalhesDeErros
Erros de processamento durante o fluxo de criação e associação do grupo de clientes.
Tipo: Array de String.
camposInvalidos
Erros capturados durante a validação dos dados recebidos na requisição.
Tipo: Array de Objeto.
grupo
Grupo com problema
Tipo: Objeto.
id
id do grupo passado na requisição
nome
Nome do grupo de clientes passado na requisição
tipo
Tipo do grupo de clientes passado na requisição
detalhes
Detalhes dos campos inválidos
Tipo: Array de String.
erroAtualizacao
Erros capturados durante a validação dos dados recebidos na requisição.
Tipo: Array de Objeto.
id
Id do grupo passado na requisição
Tipo: Integer.
nome
Nome do grupo de clientes passado na requisição
Tipo: String.
tipo
Tipo do grupo de clientes passado na requisição
Tipo: String.
status
Indica se teve algum problema durante a associação, trazendo uma mensagem.
Tipo: String.
Em um cenário onde ocorra erros na atualização de alguns grupos, porém os grupos válidos são atualizados normalmente, o retorno ainda assim será de sucesso mas com uma particularidade, exibindo o erro da associação e devolvendo o status code como 207.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Ausência de campos obrigatórios, tipo inválido no campo ou erro específico na atualização do grupo
DELETE Grupo de Clientes
Última Atualização: 26/11/2024
Este endpoint lida com a deleção de grupos de clientes
Endpoint DELETE
Sintaxe da Requisição
Para que a requisição do método DELETE seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da Requisição
grupos*
Lista de ids de grupos a serem deletados.
Tipo: Array de Números.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhes da requisição.
Tipo: Objeto.
success
Identificador booleano de sucesso da requisição.
Tipo: Boolean.
message
Mensagem de sucesso ou falha da requisição.
Tipo: String.
data
Detalhes da requisição.
Tipo: Array de Objeto.
sucesso
Lista com a remoção da associação dos clientes e a deleção dos grupos
Tipo: Array de Lista.
Primeira posição:
grupoId
Id referente ao grupo de clientes.
Tipo: Integer.
cnpj
Lista de CNPJs do grupo de clientes.
Tipo: String.
status
Mensagem de sucesso ou algum problema que teve durante a remoção da associação do cliente.
Tipo: String.
Última posição:
grupoId
Id referente ao grupo de clientes.
Tipo: Integer.
mensagem
Mensagem de confirmação da deleção do grupo
Tipo: String.
falha
Detalhes de erros que ocorreram
Tipo: Objeto.
detalhesDeErros
Erros de processamento durante o fluxo de criação e associação do grupo de clientes.
Tipo: Array de String.
erroAssociacao
Erros capturados durante a validação dos dados recebidos na requisição.
Tipo: Array de Objeto.
grupoId
id do grupo passado na requisição
cnpj
CNPJ com falha na remoção da associação
status
Detalhe do problema
Tipo: String.
Tipo: String.
Em um cenário onde ocorra erros na deleção de alguns grupos, porém os grupos válidos são deletados normalmente, o retorno ainda assim será de sucesso mas com uma particularidade, exibindo o erro e devolvendo o status code como 207.
207 Multi-status
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
404 Not Found
Quando for informado um grupo que não existe:
POST Manipular associação de clientes a grupos de clientes
Última Atualização: 26/11/2024
Este endpoint é responsável por criar ou remover a associação de clientes a grupos de clientes.
Endpoint POST
Sintaxe da Requisição
Para que a requisição do método POST seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da Requisição
Lista de grupos a serem associados.
Tipo: Array de Objeto.
idGrupo*
Id do grupo de clientes.
Tipo: Integer.
cnpj*
CNPJ do cliente a ser associado ao grupo de clientes.
Tipo: String.
acao*
Flag que controla se o CNPJ será associado ou removido do grupo de clientes.
Tipo: Enum("Adicionar" ou "Remover").
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhes da requisição.
Tipo: Objeto.
success
Identificador booleano de sucesso da requisição.
Tipo: Boolean.
message
Mensagem de sucesso ou falha da requisição.
Tipo: String.
data
Detalhes da requisição.
Tipo: Array de Objeto.
sucesso
Grupos criados e associados aos CNPJs fornecedidos.
Tipo: Array de Objeto.
cnpj
CNPJ do cliente.
Tipo: String.
idGrupo
Id referente ao grupo de clientes
Tipo: Integer.
acao
Flag que controla se o CNPJ foi associado ou removido do grupo de clientes.
Tipo: Enum("Adicionar" ou "Remover").
falha
Detalhes de erros que ocorreram
Tipo: Objeto.
detalhesDeErros
Erros de processamento durante o fluxo de criação e associação do grupo de clientes.
Tipo: Array de String.
cnpj
CNPJ do cliente.
Tipo: String.
idGrupo
Id referente ao grupo de clientes
Tipo: Integer.
acao
Flag que controla se o CNPJ será associado ou removido do grupo de clientes.
Tipo: Enum("Adicionar" ou "Remover").
status
Indica se teve algum problema durante a associação, trazendo uma mensagem.
Tipo: String.
camposInvalidos
Erros capturados durante a validação dos dados recebidos na requisição.
Tipo: Array de Objeto.
idGrupo
Id referente ao grupo de clientes
Tipo: Integer.
cnpj
CNPJ do cliente.
Tipo: String.
acao
Flag que controla se o CNPJ será associado ou removido do grupo de clientes.
Tipo: Enum("Adicionar" ou "Remover").
status
Indica se teve algum problema durante a associação, trazendo uma mensagem.
Tipo: String.
Em um cenário onde ocorra erros em algumas associações, porém em outras a associação é tratada normalmente, o retorno ainda assim será de sucesso, mas exibindo o erro da associação e devolvendo o status code como 207.
207 Multi-status
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Falhas no payload, tanto para validação de campos quanto conflito de associação