Skip to main content

Manual de cadastro de Produtos e Cenários (CFM)

Manual contendo as últimas atualizações efetuadas em 14/11/2024

Capítulo I - Introdução

Este documento tem por objetivo orientar o time técnico de desenvolvimento de nossos clientes e...

Capítulo II - Atualizações

Capítulo VII - Desassociação de produtos em grupos de produtos: Inserção do capítulo inteiro, c...

Capítulo III - Autenticação

A autenticação nas API´s mencionadas nesse documento, é feita via bearer token. Consulte a tabe...

Capítulo IV - Acesso

Comunicação: REST/JSONPara acessar a coleção de chamadas Clique Aqui. Swagger Cadastros para g...

Capítulo V - Consulta grupos de produtos

Consultar os grupos de produtos do cliente. Os campos de filtros são enviados como parâmetros da ...

Descrição dos campos de retorno

  Retorno Campo PAI Descrição success / Status do retorno ...

Exemplos de chamada e retorno

  Chamada Retorno {  "success": true,  "message": "Ok",  "record_count": 1,  "data": [    ...

Capítulo VI - Associação de produtos e grupos

Associar produtos em um ou mais grupos de produtos. Esta API também criará o grupo de produtos in...

Conceito

Este recurso é utilizado para limitar a produção de regras para um determinado cenário de forma...

Descrição dos campos de retorno

Campo PAI Descrição success / Status do retorno m...

Exemplos de chamada e retorno

  Chamada {  "products_groups": [    {      "cod_interno": "Produto 02",      "origem_produto":...

Capítulo VII - Desassociação de produtos e grupos

Contrário ao processo de associação, a desassociação de produtos em grupos de produtos retira o v...

Descrição dos campos da chamada

Campo PAI Descrição action - Contém a palavra "desassociar" ...

Descrição dos campos de retorno

Campo PAI Descrição success / Status do retorno mes...

Exemplos de chamada e retorno

Chamada {    "action": "desassociar",    "products_groups": [        {            "cod_interno":...

Capítulo VIII - Consulta de cenários

Consultar os cenários existentes no cadastro de um cliente. Os campos de filtros são enviados com...

Descrição dos campos de retorno

Campo PAI Descrição success / Status do retorno m...

Exemplo de retorno

  {  "success": true,  "message": "ok",  "record_count": 1,  "data": [    {      "id": "150462",...

Capítulo IX - Cadastro de cenários

Cadastrar um ou mais cenários (operações do cliente) em uma mesma requisição. ATENÇÃO: Antes d...

Descrição dos campos de entrada e retorno

  Campo PAI Descrição id cenarios Não enviar esta tag. Este...

Exemplo de chamada e retorno

  Chamada {   "cenarios": [      {         "id_cliente": "71408",         "grupo_cache": "A",  ...

Capítulo X - Exclusão de cenários

Excluir um único cenário por requisição. O ID do cenário é enviado como parâmetro da requisição....

Descrição dos campos de retorno

  Descrição dos campos de retorno Campo PAI Descrição success /...

Exemplos de chamada e retorno

  Chamada Retorno {  "success": true,  "message": "deleted"}

Capítulo XI - Consulta de produtos

Retornar informações dos produtos existentes no cadastro de um cliente. Os campos de filtros são ...

Descrição dos campos de retorno

Campo PAI Descrição id produtos ID do produto (Systax) ...

Exemplo de chamada e retorno

  Chamada Retorno {  "produtos": [    {      "id": "2002272",      "cod_interno": "10026",...

Capítulo XII - Cadastro de produtos

Cadastrar um ou mais produtos por requisição. Obs.1: esta versão permite informar o código CES...

Descritivo dos campos da chamada e retorno

  Chamada Campo PAI Descrição  cod_interno products ID do ...

Exemplos de chamada e retorno

Chamada {  "products": [    {      "cod_interno": "Produto 04",      "origem_produto": 0,     ...

Capítulo XIII - Exclusão de produtos

Excluir produtos existentes no cadastro de um cliente. Obs: não é possível alterar cenários vi...

Tabela de Códigos

  Código de retorno Sucess Message Descrição 200 true ...

Exemplos de chamada e retorno

  Chamada Retorno {    "success": true,    "message": "deleted"}

Capítulo XIV - Associação/ Desassociação de grupos nos cenários

Conforme descrito no capítulo “Associação de produtos/grupos” deste manual, um grupo de produto...

Descrição dos campos da chamada e retorno

  Chamada Campo Descrição acao Opções “associar” e “desassociar” ...

Exemplos de chamada e retorno

  Chamada {   "items": [     {       "acao": "associar",       "id_cenario": 2448871,     ...
Back to top