API - Associação de grupos/produtos
Objetivos: Associar um produto a um grupo de produtos, e também, pode ser utilizada para a criação de cenários.
Comandos: uma chamada pode resultar em até 4 ações sistêmicas:
1) Associar o produto a grupo de produtos.
2) Se o grupo não existir a API cria o grupo.
3) Se o nome do grupo estiver no formato ufOrigem - ufDestino - naturezaOp - perfilOrigem - perfilDestino - Finalidade (que identifica um cenário) a API irá associar o grupo no cenário.
Exemplo: SP-SP-120-1-140-175. Obtenha os principais códigos e exemplos acessando o link: https://documentacao.systax.com.br/PublicView2/Index/eb760fdab1ce135efabebecc1/25201/25954/25966
Importante: O parâmetro "Finalidade" é obrigatório para cenários de entrada e não deve ser informado para cenários de saída.
4) Se o cenário não existir com os parâmetros do item 3, a API irá criar o cenário.
Grupo de Produtos - Conceito
Este recurso é utilizado para limitar a produção de regras para um determinado cenário de forma que a Systax gere para o cliente apenas as regras que, de fato, ele utilizará, evitando o esforço e o custo do recebimento de dados desnecessários.
Em regra, nem todos os produtos do cliente são movimentados em todas as operações (geralmente isso ocorre nas compras), assim esse recurso permite a relação “N-N” entre produtos e cenários. Vejamos o exemplo abaixo de um cliente com 1.000 produtos cadastrados:
Internamente, o sistema terá a lista de produtos que compõem cada grupo (ex.: Comprados do AM: produtos “E” e “F”) e, sempre que um cenário estiver com um grupo associado (ex.: o Grupo de Produtos “Comprados do AM” estará associado ao cenário “Compra AM-SP”), somente serão geradas regras para os produtos movimentados nesta operação (ex.: para o cenário “Compra AM-SP” serão geradas regras apenas para os produtos “E” e “F”).
Método: POST
API Rest / JSON: http://wscockpit.systax.com.br/api/api/carga_grupo_produto
Descrição dos campos de chamada:
| Campo | PAI | Descrição | Obrigatório |
| codigo_produto | carga_grupo_produto | Código do produto | Sim |
| origem_produto | carga_grupo_produto | Origem do produto | Não |
| grupo | carga_grupo_produto | Código do grupo de produtos | Não |
| acao | carga_grupo_produto | Ação (cadastrar ou desativar) | Não |
| username | / | Usuário do Cockpit | Não |
| senha | / | Senha do usuário | Não |
Tabela de referência para o campo "origem_produto":
Acesse o link : https://documentacao.systax.com.br/PublicView2/Index/c14f5c52f0b52073cdf05eb75/26445 para obter a tabela de origem de materias.
Tabela de referência para o campo "acao":
| acao | descrição |
| 1 | Cadastrar produto |
| 2 | Desativar produto |
Exemplos de chamada:
{
"carga_grupo_produto": {
"codigo_produto": "codigo",
"origem_produto": 0,
"grupo": "nome do grupo",
"acao": 1
},
"username": "superdemo@systax.com.br",
"senha": "super123"
}
Descrição dos campos de retorno:
| Campo | PAI | Descrição |
| origem | / | Valor fixo "Systax" |
| sistema | / | Valor fixo "Cockpit" |
| cod_status | status | Código de retorno |
| msg_status | status | Código de retorno |
Tabela de referência para os campos "cod_status" e "msg_status"
| cod_status | msg_status |
| 0 | Sucesso |
| 1 | LoginSenhaInvalido |
| 8 | UsuarioSemCliente |
| 9 | ClienteSemConnectionString |
| 10 | FalhaNaAplicacao |
Exemplos de retorno:
{
"origem": "Systax",
"sistema": "Cockpit",
"status": {
"cod_status": 0,
"msg_status": "Retorno com sucesso. "
}
}