API - Cadastro de produtos
Objetivo: Cadastrar um único produto por requisição no Cockpit.
Método: POST
API Rest / Json: http://wscockpit.systax.com.br/api/api/carga_produto
Descrição dos campos de chamada:
| Campo | PAI | Descrição | Obrigatório |
| codigo_produto | carga_produto | Código do produto | Sim |
| ncm | carga_produto | Classificação fiscal do produto | Não |
| descricao | carga_produto | Descrição do produto | Não |
| orig | carga_produto | Origem do produto | Não |
|
ex_tipi |
carga_produto | Código EX da TIPI | Não |
|
cean |
carga_produto | Código de barras do produto | Não |
|
med_lista |
carga_produto | Utilizado apenas para medicamentos. Vide tabela abaixo | Não |
|
med_tipo |
carga_produto | Utilizado apenas para medicamentos. Vide tabela abaixo | Não |
|
complemento |
carga_produto | Complemento do produto | Não |
|
finalidade |
carga_produto | Código da finalidade do cenário | Não |
| acao | carga_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 "med_lista":
| Código | Descrição |
| 0 | Positiva |
| 1 | Negativa |
| 2 | Neutro |
Tabela de referência para o campo "med_tipo":
| Código | Descrição |
| R | Referência |
| G | Genérico |
| S | Similar |
| O | Outros |
Tabela de referência para o campo "acao":
| acao | descrição |
| 1 | Cadastrar produto |
| 2 | Desativar produto |
Tabela de referência para os campos "origem" e "finalidade"
Acesse a última versão do documento no link: https://documentacao.systax.com.br/PublicView2/Index/c14f5c52f0b52073cdf05eb75/26445 para obter os códigos de origem de materiais e finalidade.
Exemplos de chamada:
{
"carga_produto": {
"codigo_produto": "codigo",
"ncm": "02034044",
"descricao": "descricao do produto",
"orig": "0",
"acao": "1"
},
"username": "superdemo@systax.com.br",
"senha": "super123"
}
Descrição dos campos de retorno:
| Campo | PAI | Descrição |
| cpr_codi | / | Código interno da Systax |
| origem | / | Valor fixo "Systax" |
| sistema | / | Valor fixo "Cockpit" |
| cod_status | status | Código de retorno |
| msg_status | status | Mensagem 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 |
| 13 | ParametrosInvalidos |
Exemplos de retorno:
{
"cpr_codi": 57929,
"origem": "Systax",
"sistema": "Cockpit",
"status": {
"cod_status": 0,
"msg_status": "Retorno com sucesso. "
}
}
Observação 1: Essa API faz o cadastro de apenas 1 item por requisição. Caso haja a necessidade de cadastrar em lote, veja o tópico "API - Cadastro de produtos em Lote".
Observação 2: O produto demora em média 30 minutos para ser incluído no cadastro da Systax. Após esse tempo, será possível visualizar a carga do produto no Cockpit, porém, na tela de "Consulta de Produtos", o novo produto será visualizado somente após o processamento e entrega de alguma regra tributária associada á ele.