Manual API Revinculações
Manual contendo as últimas atualizações efetuadas em 23/02/2023
- API's de Revinculações
- Métodos disponíveis
- Busca
- Sugestões
- Cenários
- Simular
- Vincular
- Lista de códigos de retorno
API's de Revinculações
Web API para manipulação dos vínculos de produtos dos clientes Systax.
Métodos disponíveis
- Busca – Busca de produtos do cliente.
- Sugestões – Sugestões de vinculação para um produto específico.
- Cenários – Lista dos cenários do cliente.
- Simular – Simulação tributária dos produtos em um determinado cenário.
- Vincular – Promove a alteração da vinculação de um determinado produto.
Busca
Método para a busca dos produtos do cliente.
Parâmetros de Entrada
- tipo_vinculacao – 0= produtos pendentes; 1= vinculação por ean; 2= vinculação por ncm; 3= vinculação manual
- codigo_produto – Texto (120 caracteres)
- origem_produto - Valores de 0 a 8
- descricao – Texto (250 caracteres)
- ncm – Inteiro de 8 posições
- extipi – Inteiro de 3 posições
- ean – Inteiro de 15 posições
- pagina – Inteiro de 5 posições
Exemplo de chamada
{
"auth": {
"user": "usuário_cliente do parceiro",
"pass": "senha"
},
"tipo_vinculacao": 0,
"pagina": 1
}
Parâmetros de retorno
- id_interno – Código interno da Systax, será utilizado em outros métodos.
- tipo_vinculacao – Tipo de vinculação atual.
- codigo_produto – Código do produto informado pelo cliente.
- origem_produto – Origem do material, de 0 a 8.
- descricao – Descrição do produto.
- ncm – NCM do material informada pelo cliente.
- extipi – EX Tipi do material informada pelo cliente.
- ean – EAN do material informado pelo cliente.
Exemplo de retorno
{
"cabecalho": {
"pagina_atual": 1,
"total_de_paginas": 1,
"limite_registros_pagina": 100,
"total": "1"
},
"itens": [
{
"id_interno": "43460123",
"tipo_vinculacao": "1",
"codigo_produto": "4",
"origem_produto": "2",
"descricao": "Colete Inflvel Infantil Bestway",
"ncm": "39269090",
"extipi": "04",
"ean": "069421389000642"
}
]
}
Paginação
O parâmetro de entrada “pagina” informa qual a página da busca se está recuperando. Se a quantidade de registros por página é 100, o que se pode ver através do campo “limite_registros_pagina”, e há 1000 registros no “total”, retornará os primeiros 100 se nada for informado. Caso seja informado 3, retornará à terceira página. Caso seja informado um valor além da quantidade de páginas existente, retornará a última página:
- O valor padrão, quando não informado será 1 (primeira página)
- O valor padrão, quando informado um valor acima da última página, será igual a última página.
Sugestões
Sugestões de produtos da base Systax para o produto selecionado do cliente.
Parâmetros de entrada
- ID Interno - Código interno da Systax.
Exemplo de chamada
{
"auth": {
"user": "usuário_cliente do parceiro",
"pass": "senha"
},
"id_interno": "116793840"
}
Parâmetros de retorno
- id_interno – Código interno da Systax, será utilizado em outros métodos.
- origem_produto – Origem do material, de 0 a 8.
- descricao – Descrição do produto.
- ncm – NCM do material informada pelo cliente.
- extipi – EX Tipi do material informada pelo cliente.
- ean – EAN do material informado pelo cliente.
Exemplo de retorno
{
"auth": {
"user": "usuário_cliente do parceiro",
"pass": "senha"
},
"id_interno": "116793840",
}
"itens": [
{
"id_interno": 7133659,
"origem_produto": 0,
"descricao": "Mouse (Condicionado a venda em conjunto: teclado + Mouse
"ncm": "84716053",
"ex_tipi": "2",
"ean": "8880000561334"
}
]
}
Cenários
Método para listar todos os cenários disponíveis para o cliente.
Parâmetros de entrada
- Usuário - Inserção do Login do usuário a ser utilizado;
- Senha: Senha de acesso relacionada ao usuário utilizado.
Exemplo de chamada
{
"auth": {
"user": "usuário_cliente do parceiro",
"pass": "senha"
}
}
Parâmetros de retorno
- ID Cenário – ID da configuração do cenário.
- Descrição - (apelido) do cenário.
Exemplo de retorno
{
"auth": {
"user": "usuário_cliente do parceiro",
"pass": "senha"
}
}
[
{
"id": "155402",
"apelido": "VENDA-SP-SP_Varejista-CFNC"
},
{
"id": "161070",
"apelido": "VENDA-AC-AC_Varejista-CFNC"
},
{
"id": "161071",
"apelido": "VENDA-SP-SP_Varejista_SN-CFNC"
}
]
}
Paginação
Sem filtro e sem paginação.
Simular
Método que simula a tributação antes de efetivamente alterar a vinculação do produto.
Parâmetros de entrada
- ID Cenário - ID Cenário – ID da configuração do cenário.
- ID Interno - Código interno do produto da Systax.
Exemplo de chamada
{
"auth": {
"user": "usuário_cliente do parceiro",
"pass": "senha"
},
"id_cenario": "550194",
"id_produto_systax": "46481082"
}
Parâmetros de retorno
ICMS
- CFOP
- CST
- Base de cálculo
- Alíquota
- Percentual de redução da base de cálculo
- Vigência de
- Vigência até
- Outras informações (genérico)
- Dispositivo legal
- Informações adicionais
PIS / COFINS
- CST
- Base de cálculo
- Alíquota
- Percentual de redução da base de cálculo
- Vigência de
- Vigência até
- Outras informações (genérico)
- Dispositivo legal
- Informações adicionais
IPI
- CST
- Base de cálculo
- Alíquota
- Percentual de redução da base de cálculo
- Vigência de
- Vigência até
- Outras informações (genérico)
- Dispositivo legal
- Informações adicionais
- cEnq
Exemplo de retorno
{
"auth": {
"user": "usuário_cliente do parceiro",
"pass": "senha"
},
"id_cenario": "550194",
"id_produto_systax": "46481082"
}
{
"icms": {
"cfop": "5405",
"cest": "0299900",
"cst": "60",
"aliquota_cf": "25.0000",
"vigencia_de": "01/07/2018",
"dispositivo_legal": "Arts. 313-C e 313-D do RICMS/SP e Portaria CAT nº 47/2018",
"inf_adicionais": "Arts. 313-C e 313-D do RICMS/SP e Portaria CAT nº 47/2018"
},
"pis": {
"cst": "01",
"bc_composicao": "2",
"aliquota": "1.6500",
"vigencia_de": "01/12/2002",
"dispositivo_legal": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"
},
"cofins": {
"cst": "01",
"bc_composicao": "2",
"aliquota": "7.6000",
"vigencia_de": "01/02/2004",
"dispositivo_legal": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003"
}
}
Paginação
Sem filtro e sem paginação.
Vincular
Permite mudar a vinculação do produto do cliente com o produto da base Systax.
Parâmetros de entrada
- ID_interno_cliente - Código interno do produto do cliente.
- ID_interno_Systax - Código interno do produto da Systax.
Exemplo de chamada
{
"auth": {
"user": "usuário_cliente do parceiro",
"pass": "senha"
},
"id_produto_cliente": "116793840",
"id_produto_systax": "7133659"
}
Parâmetros de retorno
- Status – O produto foi vinculado corretamente ou não.
Exemplo de retorno
{
"auth": {
"user": "usuário_cliente do parceiro",
"pass": "senha"
},
"id_produto_cliente": "116793840",
"id_produto_systax": "7133659"
}
{
"status": "ok"
}
Lista de códigos de retorno
- 001 - Falha na autenticação;
- 002 - Campo obrigatório;
- 003 - Valor obrigatório;
- 004 - Campo deve ser numérico;
- 005 - Nenhum registro localizado.