Glider

Documentação - API Portal CFM - Produtos e Cenários

Cadastro de produtos V2

Objetivo: Cadastrar um ou mais produtos por requisição.

Obs.1: esta versão permite informar o código CEST do produto para que a Systax o considere no tratamento e geração do retorno tributário.

Obs.2: esta API acata automaticamente a CEST informada. Porém, se o cadastrante entende que o produto não tem CEST e quer que a Systax retorne a regra tributária considerando isso, será necessário alinhar previamente com o Time Systax para que façamos a configuração necessária para este cliente e incluamos no seu fluxo de atendimento o tratamento manual para estes itens. Após as devidas tratativas, para estes casos, as chamadas devem conter "true" no campo "use_cest" e o campo "cest" deverá ser enviado vazio.

Endpoint: https://app.systax.com.br/v2/cfm/products/multi

Descrição dos campos de entrada:

Campo	PAI	Descrição
cod_interno	products	ID do produto (código interno do Cliente)
origem_produto	products	Origem do produto
descricao	products	Descrição do produto
complemento	products	Complemento do produto
ean	products	EAN do produto
ncm_original	products	NCM do produto
ex_tipi_original	products	Ex TIPI do produto
use_cest	products	Indica se a Systax deve respeitar o código CEST indicado na chamada como parâmetro de tratamento e retorno tributário. Assim, temos 3 possibilidades: 1) Se preenchido com "true" e informado EAN na chamada, a Systax comparará o CEST da chamada com o que será entregue pela Systax, a partir do tratamento por EAN + origem do material. Sendo a CEST compatível, o sistema seguirá com o fluxo padrão, ou seja, cadastro do item novo e geração de regras para ele dentro dos cenários devidos. Caso seja incompatível, o retorno evidenciará a incompatibilidade, apresentando a CEST que a Systax entende correta e o produto não será cadastrado. 2) Se preenchido com "true" e informada apenas NCM (sem EAN) na chamada, a Systax validará se essa CEST é possível para a NCM da chamada. Sendo a CEST compatível, o sistema seguirá com o fluxo padrão, ou seja, cadastro do item novo e geração de regras para ele dentro dos cenários devidos. Caso seja incompatível, o retorno evidenciará a incompatibilidade e o produto não será cadastrado. 3) Se preenchido com "false" ou se não informada a tag, o produto será inserido sem essa informação e o tratamento seguirá como padrão, por EAN ou NCM.
cest	products	CEST do produto (somente é necessário se "use_cest" = "true")

Tabela de referência para o campo "origem_produto":

Para obter a tabela completa do campo acima, acesse o link: https://documentacao.systax.com.br/PublicView2/Index/c14f5c52f0b52073cdf05eb75/26445/29834/30945

Descrição dos campos de retorno:

Campo	PAI	Descrição
status	/	Status do retorno
itens	/	Quantidade de itens na chamada
itens_ok	/	Quantidade de itens inseridos
position	insert_ids	Posição do item na chamada
cod_interno	insert_ids	ID do produto (Cliente)
origem_produto	insert_ids	Origem do produto
id	insert_ids	ID do produto (Systax)

Tabela de referência para os campos "success" e "message":

Código de retorno	success	message
200	true	ok
400	false	An error while decoding token
400	false	Provided token is expired.
401	false	Token not provided

Tabela de referência para os retornos via CEST:

Success	Message	Descrição
true	RETORNO COM SUCESSO	A CEST é válida para a NCM informada e foi possível o tratamento do item com sucesso.
false	CEST INCOMPATIVEL	Pode estar acompanhado das "message_cest" abaixo, para esclarecimento do motivo de incompatibilidade. "message_cest": "o produto não possui CEST" "message_cest": "lista CEST válida(s): XXXXX" "message_cest": "NCM encontrada: XXXXX"
false	CEST NÃO LOCALIZADA	Não encontrou nenhuma CEST
false	NAO FOI POSSIVEL CADASTRAR	Para casos de chamada com use_cest=true e CEST=vazio e não existe produto compatível pre-existente na Systax. Este caso, provavelmente precisará de atuação de um consultor Systax e estará acompanhado de uma das "message_cest" abaixo: "message_cest": EAN possui CEST "message_cest": NCM possui CEST "message_cest": não existe produto na base Systax sem CEST para vincular "msg": "item sem configuracao" Esta mensagem será exibida quando o produto Systax de referência precisa de tratamento manual de um consultor Systax.

Exemplos de chamada:

{
"products": [
{
"cod_interno": "Produto 04",
"origem_produto": 0,
"descricao": "Produto 04",
"complemento": "",
"ean": "",
"ncm_original": "",
"ex_tipi_original": "",

"use_cest": "true",

"cest": "2001200"
},
{
"cod_interno": "Produto 05",
"origem_produto": 0,
"descricao": "Produto 05",
"complemento": "",
"ean": "",
"ncm_original": "",
"ex_tipi_original": ""

},
{
"cod_interno": "Produto 06",
"origem_produto": 0,
"descricao": "Produto 06",
"complemento": "",
"ean": "",
"ncm_original": "",
"ex_tipi_original": "",

"use_cest": "true",

"cest": ""

}
]
}

Exemplos de retorno:

{
"status": "Ok",
"itens": 3,
"itens_ok": 3,
"insert_ids": [
{
"position": 0,
"cod_interno": "Produto 04",
"origem_produto": 0,
"id": "11793766"
},
{
"position": 1,
"cod_interno": "Produto 05",
"origem_produto": 0,
"id": "11793767"
},

{
"position": 2,
"cod_interno": "Produto 06",
"origem_produto": 0,
"id": "11793768"

"message_cest": "validacao_ok"
}
],
"itens_error": 0,
"errors": [],
"success": true,
"message": "ok"
}