A API de 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.



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
NCMNumberCondicionalCó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.
CESTNumber       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".
URL do Serviço: POST:http://{url_do_servidor}/api/produto/salvarProduto


{
  "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,  
  "idSubGrupo": "Sucos",  
}
{
   "codigo": 12345,
   "sucesso": true,
   "mensagens": [ ]
}
{
   "codigo": null,
   "sucesso": false,
   "mensagens": [
       "Mensagem de erro de exemplo."
   ]
}