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

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


CONTEÚDO

  1. Visão Geral
  2. Autenticação
  3. Cadastro de Produto
  4. Dicionário de Dados

01. VISÃO GERAL

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.

02. AUTENTICAÇÃO 

Geração Token

Para realizar qualquer acesso às consultas disponibilizadas é necessário solicitar um Token de autenticação, através da API "Gerar Token". Nessa chamada devem ser informados o usuário, a senha e o número de série do cliente que deseja consultar. O método retornará Token de acesso, com duração de 2 minutos. Este Token será composto de um código aleatório, do tipo string (Exemplo: ZQGL16Q3D43mhSi8nw8s3j2HhZPQ9Ei6), que deverá ser utilizado em uma chamada da API.

...

Caso o Token gerado não seja utilizado em até 2 minutos ele estará automaticamente cancelado. 

Servidor

url_do_servidorchefweb.chef.totvs.com.br/chefwebapi

...

{

   "Token": "69e9dde6-c91c-4c50-af1c-fc2dbe7875ba"

   "DataExpiração": "2017-12-22T10:41:53.4976772-02:00",

   "Sucesso": : true

   "Erro"::  []

}

03. CADASTRO DE PRODUTO

URL do Serviço POST:http://{url_do_servidor}/api/produto/salvarProduto

Request

A requisição deve ser preenchida obedecendo os seguintes critérios:

...

{
   "codigo": 12345,
   "sucesso": true,
   "mensagens": [ ]
}






04. DICIONÁRIO DE DADOS

  • Número de Série: É o número de licença que identifica cada cliente TOTVS Varejo Food Service Retaguarda em nosso ambiente.


HTML
<div class="table-wrap"><table class="wrapped confluenceTable" resolved=""><colgroup><col style="width: 199.0px;"><col style="width: 72.0px;"><col><col></colgroup><tbody><tr><td style="text-align: left;" class="confluenceTd"><p><span style="color: rgb(0,0,0);"><strong>Nome</strong></span></p></td><td style="text-align: left;" class="confluenceTd"><p><span style="color: rgb(0,0,0);"><strong>Tipo</strong></span></p></td><td colspan="1" class="confluenceTd"><strong>Obrigatório</strong></td><td colspan="1" class="confluenceTd"><strong>Descrição</strong></td></tr><tr><td style="text-align: left;" class="confluenceTd">token</td><td style="text-align: left;" class="confluenceTd">String</td><td style="text-align: center;" colspan="1" class="confluenceTd">Sim</td><td colspan="1" class="confluenceTd">Token gerado atrás da API de obtenção - <a href="/display/DGP/Gerar+Token">API Token</a>.</td></tr><tr><td style="text-align: left;" class="confluenceTd">codigoProduto</td><td style="text-align: left;" class="confluenceTd">Number</td><td style="text-align: center;" colspan="1" class="confluenceTd">Sim</td><td colspan="1" class="confluenceTd"><p>Código único do produto. Deve possuir até 14 caracteres.</p><p>Campo utilizado como "chave-primária" do cadastro e não pode ser duplicado. </p><p>Caso enviado com valor 0 e o campo "<strong>gerarCodigoProduto</strong>" enviado com valor <strong><em>true</em></strong><em> </em>será gerado um código para o produto incrementando o valor +1 ao código de produto de maior valor registrado na base.</p></td></tr><tr><td style="text-align: left;" class="confluenceTd">gerarCodigoProduto</td><td style="text-align: left;" class="confluenceTd">Boolean</td><td style="text-align: center;" colspan="1" class="confluenceTd">Sim</td><td colspan="1" class="confluenceTd">Define se deve ser gerado um novo código de produto para o registro enviado. Caso o valor esteja <em><strong>true</strong></em>, será gerado um código para o produto incrementando o valor +1 ao código de produto de maior valor registrado na base.</td></tr><tr><td style="text-align: left;" class="confluenceTd"><p>nomeProduto</p></td><td style="text-align: left;" class="confluenceTd"><p>String</p></td><td style="text-align: center;" colspan="1" class="confluenceTd">Sim</td><td colspan="1" class="confluenceTd">Campo que define o nome do produto que será exibido no PDV. Deve possuir até 100 caracteres.</td></tr><tr><td style="text-align: left;" colspan="1" class="confluenceTd">quantidadeEstoque</td><td style="text-align: left;" colspan="1" class="confluenceTd">Decimal</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Campo para indicar a quantidade disponível em estoque do produto.</td></tr><tr><td colspan="1" class="confluenceTd">quantidadeMinima</td><td colspan="1" class="confluenceTd">Decimal</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Indica a quantidade mínima de estoque do produto.</td></tr><tr><td colspan="1" class="confluenceTd">naoExibirNoCardapio</td><td colspan="1" class="confluenceTd">Boolean</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Campo que define se o campo deve ou não ser exibido no cardápio. Caso esteja preenchido com <em><strong>true</strong></em> o produto não será exibido no cardápio.</td></tr><tr><td colspan="1" class="confluenceTd">precoVenda</td><td colspan="1" class="confluenceTd">Decimal</td><td style="text-align: center;" colspan="1" class="confluenceTd">Sim</td><td colspan="1" class="confluenceTd">Preço padrão de venda do produto. Deve ser maior que zero.</td></tr><tr><td colspan="1" class="confluenceTd">precoCompra</td><td colspan="1" class="confluenceTd">Decimal</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Preço pago na compra do produto.</td></tr><tr><td colspan="1" class="confluenceTd">divididoPor</td><td colspan="1" class="confluenceTd">Decimal</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Caso 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.</td></tr><tr><td colspan="1" class="confluenceTd">pesavel</td><td colspan="1" class="confluenceTd">Boolean</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Indica se o produto é ou não um produto pesável, ou seja, se é vendido por g/kg.</td></tr><tr><td colspan="1" class="confluenceTd">pesoLiquido</td><td colspan="1" class="confluenceTd">Decimal</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Peso liquido do produto.</td></tr><tr><td colspan="1" class="confluenceTd">descricaoProduto</td><td colspan="1" class="confluenceTd">String</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Descrição do produto para exibição no PDV. Deve possuir até 100 caracteres.</td></tr><tr><td colspan="1" class="confluenceTd">margemLucro</td><td colspan="1" class="confluenceTd">Decimal</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Valor percentual da margem de lucro do produto.</td></tr><tr><td colspan="1" class="confluenceTd">permitirVendaFracionada</td><td colspan="1" class="confluenceTd">Boolean</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Define se o produto pode ser vendido em unidades fracionadas, ou apenas em múltiplos da unidade utilizada.</td></tr><tr><td colspan="1" class="confluenceTd">localImpressao</td><td colspan="1" class="confluenceTd">String</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Campo 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".</td></tr><tr><td colspan="1" class="confluenceTd">idNCM</td><td colspan="1" class="confluenceTd">Number</td><td style="text-align: center;" colspan="1" class="confluenceTd">Sim</td><td colspan="1" class="confluenceTd">Id de registro de NCM cadastrado no TOTVS Chef para definir qual o código NCM será utilizado para o produto.</td></tr><tr><td colspan="1" class="confluenceTd">idCEST</td><td colspan="1" class="confluenceTd">Number</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Id de registro de CEST cadastrado no TOTVS Chef para definir qual o código CEST será utilizado para o produto.</td></tr><tr><td colspan="1" class="confluenceTd">idUnidade</td><td colspan="1" class="confluenceTd">Number</td><td style="text-align: center;" colspan="1" class="confluenceTd">Sim</td><td colspan="1" class="confluenceTd">Id de registro de Unidade de Medida cadastrado no TOTVS Chef para definir a unidade de medida que será utilizada na venda do produto.</td></tr><tr><td colspan="1" class="confluenceTd">idUnidadeCompra</td><td colspan="1" class="confluenceTd">Number</td><td style="text-align: center;" colspan="1" class="confluenceTd">Sim</td><td colspan="1" class="confluenceTd">Id de registro de Unidade de Medida cadastrado no TOTVS Chef para definir a unidade de medida utilizada no momento da compra do produto.</td></tr><tr><td colspan="1" class="confluenceTd">idGrupo</td><td colspan="1" class="confluenceTd">Number</td><td style="text-align: center;" colspan="1" class="confluenceTd">Sim</td><td colspan="1" class="confluenceTd">Id de registro de Grupo cadastrado no TOTVS Chef para definir o grupo ao qual o produto faz parte.</td></tr><tr><td colspan="1" class="confluenceTd">idSubGrupo</td><td colspan="1" class="confluenceTd">Number</td><td style="text-align: center;" colspan="1" class="confluenceTd">Sim</td><td colspan="1" class="confluenceTd">Id de registro de Subgrupo cadastrado no TOTVS Chef para definir o subgrupo ao qual o produto faz parte.</td></tr><tr><td colspan="1" class="confluenceTd">serialLoja</td><td colspan="1" class="confluenceTd">String</td><td style="text-align: center;" colspan="1" class="confluenceTd">Não</td><td colspan="1" class="confluenceTd">Campo 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".</td></tr></tbody></table></div>