Páginas filhas
  • API - Cadastro de Produtos - Versão 2

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
iconfalse

A API de Produto Produto do ChefWeb tem a função de possibilitar o cadastro e/ou atualização dos dados mínimos necessários para cadastrar Produtos no TOTVS Chef.

...

Informações
titleCampos de Envio de Produto

Nome

Tipo

ObrigatórioDescrição
tokenStringSimToken gerado atrás da API de obtenção - API Token.
codigoProdutoNumberSim

Código único do produto. Deve possuir até 14 caracteres.

Campo utilizado como "chave-primária" do cadastro e não pode ser duplicado. 

Caso enviado com valor 0 e o campo "gerarCodigoProduto" enviado com valor true será gerado um código para o produto incrementando o valor +1 ao código de produto de maior valor registrado na base.

gerarCodigoProdutoBooleanSimDefine se deve ser gerado um novo código de produto para o registro enviado. Caso o valor esteja true, será gerado um código para o produto incrementando o valor +1 ao código de produto de maior valor registrado na base.

nomeProduto

String

SimCampo que define o nome do produto que será exibido no PDV. Deve possuir até 100 caracteres.
quantidadeEstoqueDecimalNãoCampo para indicar a quantidade disponível em estoque do produto.
quantidadeMinimaDecimalNãoIndica a quantidade mínima de estoque do produto.
naoExibirNoCardapioBooleanNãoCampo que define se o campo deve ou não ser exibido no cardápio. Caso esteja preenchido com true o produto não será exibido no cardápio.
precoVendaDecimalSimPreço padrão de venda do produto. Deve ser maior que zero.
precoCompraDecimalNãoPreço pago na compra do produto.
divididoPorDecimalNãoCaso a unidade de entrada seja diferente da de saída, define por qual fator a unidade de entrada deve ser dividida no momento da venda. Ex: Unidade de entrada: CX; Unidade de saída: UN; DivididoPor: 12; Cada CX será equivalerá a 12 UN.
pesavelBooleanNãoIndica se o produto é ou não um produto pesável, ou seja, se é vendido por g/kg.
pesoLiquidoDecimalNãoPeso liquido do produto.
descricaoProdutoStringNãoDescrição do produto para exibição no PDV. Deve possuir até 100 caracteres.
margemLucroDecimalNãoValor percentual da margem de lucro do produto.
permitirVendaFracionadaBooleanNãoDefine se o produto pode ser vendido em unidades fracionadas, ou apenas em múltiplos da unidade utilizada.
localImpressaoStringNãoCampo para especificar se deve ser impresso o cupom em impressora não fiscal em outro local de impressão cadastrado no TOTVS Chef. Caso não seja preenchido, por padrão receberá o valor "NENHUM".

idNCM

NumberCondicionalId de registro de NCM cadastrado no TOTVS Chef para definir qual o código NCM será utilizado para o produto. O ID NCM é obrigatório caso a tag <NCM> não seja informada
NCMNumberStringCondicionalCódigo do NCM utilizado para classificação fiscal do produto. O NCM é obrigatório caso a tag <IDNCM> não seja informada
idCESTNumberNãoId de registro de CEST cadastrado no TOTVS Chef para definir qual o código CEST será utilizado para o produto.
CESTNumberString       NãoCódigo do CEST utilizado para classificação da substituição tributária do produto. 
idUnidadeNumberSimId de registro de CEST cadastrado no TOTVS Chef para definir qual o código CEST será utilizado para o produto.
idUnidadeCompraNumberSimId de registro de Unidade de Medida cadastrado no TOTVS Chef para definir a unidade de medida utilizada no momento da compra do produto.
idGrupoNumberCondicionalId de registro de Grupo cadastrado no TOTVS Chef para definir o grupo ao qual o produto faz parte. O idGrupo é obrigatório caso a tag <Grupo> não seja informada
GrupoStringCondicionalNome do Grupo ao qual o produto será vinculado. O Grupo é obrigatório caso a tag <idGrupo> não seja informada
idSubGrupoNumberCondicionalId de registro de SubGrupo cadastrado no TOTVS Chef para definir o grupo ao qual o produto faz parte. O idSubGrupo é obrigatório caso a tag <SubGrupo> não seja informada
SubGrupoStringCondicionalNome do SubGrupo ao qual o produto será vinculado. O SubGrupo é obrigatório caso a tag <idSubGrupo> não seja informada
serialLojaStringNãoCampo que determina para qual loja/gerenciador de franquia a informação será direcionada. Caso não seja preenchido, a informação será armazenada na loja "central".
TributoStringSim

Indicador da forma de tributação do ICMS nas vendas do produto

T - Indica que as vendas desse produto serão tributadas pelo ICMS

I - Indica que as vendas desse produto serão isentas de ICMS

F - Indica que as vendas desse produto foram tributadas por substituição tributária de ICMS

N - Indica que as vendas desse produto serão não tributadas pelo ICMS

IATStringSim

Indicador de Arrendamento ou truncamento nas vendas realizadas no PDV. 

T - Indica que as operações com esse item terão os valores truncados no PDV

A - Indica que as operações com esse item terão os valores arredondados no PDV

IPPTStringSim

Indicador de Produção Própria ou de terceiros do produto. 

T - Indica que o produto foi produzido por terceiros, ou seja, foi comprado ou recebido para venda.

P - Indica que o produto foi produzido no estabelecimento onde será realizada a venda.

CFOPStringSimCFOP que será utilizado nas vendas desse produto realizadas pelo PDV
tpItemStringSim

Tipo do produto que será cadastrado

00 – MERCADORIA PARA REVENDA

01 – MATÉRIA-PRIMA

02 – EMBALAGEM

03 – PRODUTO EM PROCESSO

04 – PRODUTO ACABADO

05 – SUBPRODUTO

06 – PRODUTO INTERMEDIÁRIO

07 – MATERIAL DE USO E CONSUMO

08 – ATIVO IMOBILIZADO

09 – SERVIÇOS

10 – OUTROS INSUMOS

99 – OUTROS

CSTStringCondicional

Código da Situação Tributária de ICMS. Deverá ser informado de acordo com a tabela disponibilizada pelo fisco, quando a loja for contribuinte do regime normal.

000 – Tributada integralmente
010 – Tributada e com cobrança do ICMS por substituição tributária
020 – Com redução de base de cálculo
030 – Isenta ou não tributada e com cobrança do ICMS por substituição tributária
040 – Isenta
041 – Não tributada
050 – Suspensão
051 – Diferimento
060 – ICMS cobrado anteriormente por substituição tributária
070 – Com redução de base de cálculo e cobrança do ICMS por substituição tributária
090 – Outras
100 – Importação Direta - Tributada Integralmente
110 – Importação Direta - Tributada e com cobrança do ICMS por ST
120 – Importação Direta - Tom de redução de base de cálculo
130 – Importação Direta - ISENTA OU NAO TRIBUTADA E COM COBRANÇA DO ICMS POR ST
140 – Importação Direta - ISENTA
141 – Importação Direta - NAO TRIBUTADA
150 – Importação Direta - COM SUSPENSAO
151 – Importação Direta - COM DIFERIMENTO
170 – Importação Direta - COM REDUCAO DE BASE DE CALCULO E COBRANCA DO ICMS POR ST
190 – Importação Direta - OUTRAS
200 – Adquirida Merc. Interno - Tributada Integralmente


O CST é obrigatório caso a tag <CSOSN> não seja informada

CSOSNStringCondicional

Código da CSOSN do ICMS, Deverá ser informado de acordo com a tabela disponibilizada pelo fisco, quando a loja for contribuinte do regime Simples Nacional.

101    Tributada pelo Simples Nacional com permissão de crédito
102    Tributada pelo Simples Nacional sem permissão de crédito
103    Isenção do ICMS no Simples Nacional para faixa de receita bruta
300    Imune
400    Não tributada pelo Simples Nacional
500    ICMS cobrado anteriormente por substituição tributária (substituído) ou por antecipação
900    Outros

O  CSOSN é obrigatório caso a tag <cstICMS> não seja informada

aliqICMSNumberSimAliquota que será utilizada para cálculo de ICMS nas operações de Venda
redICMSNumberNãoPercentual de redução que será utilizado para cálculo da base do ICMS nas operações de Venda
aliqFCPNumberSimAliquota que será utilizada para cálculo do FCP (FECP) nas operações de Venda
MVANumberNãoMargem de Valor agregado que será utilizada para cálculo da base de ICMS ST nas operações de Venda
redICMSSTNumberNãoPercentual de redução que será utilizado para cálculo da base do ICMS ST nas operações de Venda
aliqICMSSTNumberSimAliquota que será utilizada para cálculo de ICMS ST nas operações de Venda
aliqFCPSTNumberSimAliquota que será utilizada para cálculo do FCP (FECP) ST nas operações de Venda
modBCICMSSTNumberSim

Modelo da Base de Cálculo do ICMS ST nas operações de Venda

0 - Preço Tabelado ou Máximo Sugerido

1 - Lista Negativa (Valor)

2 - Lista Positiva (Valor)

3 - Lista Neutra (Valor)

4 - Margem Valor Agregado (%)

5 - Pauta (Valor)

cBenefStringNãoCódigo de Benefício Fiscal, utilizado para indicar qual incentivo fiscal utilizado na operação. Deverá ser cadastrado de acordo com a tabela disponibilizada pelo fisco estadual.
cstPISStringNão

Código da Situação Tributária de PIS. Deverá ser informado de acordo com a tabela disponibilizada pelo fisco.

01    Operação Tributável com Alíquota Básica
02    Operação Tributável com Alíquota Diferenciada
03    Operação Tributável com Alíquota por Unidade de Medida de Produto
04    Operação Tributável Monofásica – Revenda a Alíquota Zero
05    Operação Tributável por Substituição Tributária
06    Operação Tributável a Alíquota Zero
07    Operação Isenta da Contribuição
08    Operação sem Incidência da Contribuição
09    Operação com Suspensão da Contribuição
49    Outras Operações de Saída
99  Outras Operações

tpCalculoPISNumberNão

Tipo de cálculo do PIS nas operações de Venda

0 - Percentual

1 - Valor

aliqPISNumberNãoAliquota, em percentual ou valor, que será utilizada para cálculo de PIS nas operações de Venda
cstCofinsStringNão

Código da Situação Tributária de Cofins. Deverá ser informado de acordo com a tabela disponibilizada pelo fisco.

01    Operação Tributável com Alíquota Básica
02    Operação Tributável com Alíquota Diferenciada
03    Operação Tributável com Alíquota por Unidade de Medida de Produto
04    Operação Tributável Monofásica – Revenda a Alíquota Zero
05    Operação Tributável por Substituição Tributária
06    Operação Tributável a Alíquota Zero
07    Operação Isenta da Contribuição
08    Operação sem Incidência da Contribuição
09    Operação com Suspensão da Contribuição
49    Outras Operações de Saída
99  Outras Operações

tpCalculoCofinsNumberNão

Tipo de cálculo do Cofins nas operações de Venda

0 - Percentual

1 - Valor

aliqCofinsNumberNãoAliquota, em percentual ou valor, que será utilizada para cálculo de Cofins nas operações de Venda
cstIPIStringNão

Código da Situação Tributária de IPI. Deverá ser informado de acordo com a tabela disponibilizada pelo fisco.

50    Saída Tributada
51    Saída Tributável com Alíquota Zero
52    Saída Isenta
53    Saída Não-Tributada
54    Saída Imune
55    Saída com Suspensão
99    Outras Saídas

aliqIPINumberNãoAliquota que será utilizada para cálculo de IPI nas operações de Venda
codEnqIPIStringNão

Código de enquadramento de IPI.

Informações
iconfalse
titleExemplo de Chamada
URL do Serviço: POST:http://{url_do_servidor}/api/produto/salvarProduto


Bloco de código
titleRequest
{
  "serialLoja": "1234567",
  "token": "String",
  "codigoProduto": 123,
  "gerarCodigoProduto": false,
  "nomeProduto": "String",
  "quantidadeEstoque": 0.0,
  "quantidadeMinima": 0.0,
  "naoExibirNoCardapio": false,
  "precoVenda": 0.0,
  "precoCompra": 0.0,
  "divididoPor": 1.0,
  "pesavel": false,
  "pesoLiquido": 0.0,
  "descricaoProduto": "String",
  "margemLucro": 0.0,
  "permitirVendaFracionada": false,
  "localImpressao": "String",
  "idNCM": 1,
  "NCM": 12345678,    
  "idCEST": 1,   
  "CEST": 1234567, 
  "idUnidade": 1,
  "idUnidadeCompra": 1,
  "idGrupo": 1,   
  "Grupo": "Bebidas", 
  "idSubGrupo": 1,  
  "idSubGrupoSubGrupo": "Sucos",  
  "origem":1,
  "Tributo":"T",
  "IAT": "A",
  "IPPT": "T",
  "CFOP": "5102",
  "tpItem": "00",
  "cstICMS": "00",
  "CSOSN": "",
  "aliqICMS": 18.00,
  "redICMS": 0.00,
  "aliqFCP": 0.00,
  "MVA": 0.00,
  "redICMSST": 0.00,
  "aliqICMSST": 0.00,
  "aliqFCPST": 0.00,
  "modBCICMSST": "",
  "cBenef": "",
  "cstPIS": "01",
  "tpCalculoPIS": 0,
  "aliqPIS": 3.65,
  "cstCofins": "01",
  "tpCalculoCofins": 0,
  "aliqCofins": 7.60,
  "cstIPI": "",modBCICMSST   "aliqIPI": 0.00,
  "codEnqIPI":""
}
Bloco de código
titleResponse Sucesso
{
   "codigo": 12345,
   "sucesso": true,
   "mensagens": [ ]
}
Bloco de código
titleResponse Erro
{
   "codigo": null,
   "sucesso": false,
   "mensagens": [
       "Mensagem de erro de exemplo."
   ]
}

...