Integração via API personalizada de sua loja virtual

Hands of programmer writing code on laptop

A API personalizada do Hiper, permite com que qualquer plataforma de e-commerce ou loja virtual realize a integração com o Hiper Gestão. Para realizar a integração é necessário ter um conhecimento em desenvolvimento de sistemas e utilizar as credenciais disponíveis nas configurações da loja virtual dentro do próprio Hiper.

Novos campos e chamadas disponíveis

Nos últimos meses, a API personalizada do Hiper teve diversas atualizações e recebeu incrementos necessários para entregar mais informações aos e-commerces integrados com o Hiper. 

 

API de Produtos [GET]

Na API de produtos, são retornados todos os produtos que estão marcados no cadastro de produto do Hiper com a opção “Enviar produto para a loja virutal”. 

Nessa API, foram adicionados os seguintes campos:

  • codigo
    • No campo “codigo” é exibido o código interno do Hiper (ex.: 3001, 3002, 3003).
  • codigoDeBarras
    • No campo “codigoDeBarras” é exibido o código de barras do produto mais recente, nesse campo não será retornado mais de um código de barras, apenas o código de barras mais recente do produto.
    • Se o produto não tiver nenhum código de barras, o campo “codigoDeBarras” será retornado como vazio (“null”).
  • descricao
    • No campo “descricao” é exibida a descrição do produto lançado no Hiper, a descrição possui o limite de 700 caracteres.
  • grade
    • No campo “grade” é informado se o produto pertence ou não a uma grade. Se o produto tiver grade, sendo a grade pai ou a grade filha, será exibido como “true” (verdadeiro). Se o produto não possui grade, será exibido como “false” (falso).
  • imagensAdicionais
    • No campo “imagensAdicionais” serão exibidas as imagens secundárias do produto, a imagem principal do produto, está disponíevel no campo “imagem”. Seguindo o padrão do Hiper, a API suporta até 5 imagens (uma principal + quatro adicionais).
  • ncm
    • No campo “ncm”  será retornado o NCM do cadastro do produto com o seguinte padrão “0000.00.00”.
  • variacao
    • No objeto “variacao” serão retornadas as grades do produto pai, com as seguintes informações do produto filho: o ID do produto filho, o nome da variação da grade e o tipo de variação da grade.

 

Na API de produtos, não devem ser mais utilizados os campos:

  • tamanho
    • O campo “tamanho” foi migrado para o objeto “variacao”.
  • cor
    • O campo “cor” foi migrado para o objeto “variacao”.
  • quantidadeEmEstoque
    • O campo “quantidadeMinimaEmEstoque” foi migrado para a API de Estoque.
  • quantidadeMinimaEmEstoque
    • O campo “quantidadeMinimaEmEstoque” foi migrado para a API de Estoque.

 

API de Estoque [GET]

Na API de estoque, é retornado o estoque individual do produto, o saldo do estoque é o local do estoque que foi definido nas configurações padrões da loja virtual no Hiper. Para que seja retornado o saldo em estoque do produto, deverá ser enviada na requisição o ID do produto.

Nessa API, foram adicionados os seguintes campos:

  • pontoDeSincronizacao
    • No campo “pontoDeSincronizacao” é retornado o número último ponto de sincronização. Ao realizar uma nova requisição, deverá ser enviado o último ponto de sincronização e assim sucessivamente.
      • A cada atualização de estoque do produto, o ponto de sincronização recebe um incremento, isso representa que o saldo do produto foi atualizado.
  • produtoId
    • No campo “produtoId” o identificador interno do Hiper.
  • quantidadeEmEstoque
    • No campo “quantidadeEmEstoque” é retornada a quantidade de estoque do produto, sem descontar a reserva de estoque.
  • quantidadeMinimaEmEstoque
    • No campo “quantidadeMinimaEmEstoque” é retornada a quantidade mínima em estoque do produto, essa informação é definida no cadastro de produto do Hiper.,

API de Pedido de venda [POST]

Na API de pedido de venda, deve ser enviado a venda realizada no e-commerce para o Hiper. No Hiper, a venda estará disponível na listagem de pedidos de venda.

Nessa API, foram adicionados os seguintes campos:

  • precoUnitarioBruto
    • O valor unitário bruto do item do pedido de venda, sem descontos ou acréscimos.
  • precoUnitarioLiquido
    • O valor unitário líquido do item do pedido de venda, o valor que foi realizada a venda do item.
  • numeroPedidoDeVenda
    • O número do pedido de venda no e-commerce, o número pode ser utilizado como busca no Hiper, porém não será o número do pedido no Hiper. No Hiper, será mantido a numeração padrão: “LV + número do pedido”.
  • observacaoDoPedidoDeVenda
    • A observação do pedido de venda no e-commerce.

API de eventos de Pedido de venda [GET]

Na consulta de eventos do pedido de venda são retornadas as informações de faturamento, número do pedido de venda no Hiper, entre outras informações.

Nessa API, foram adicionados os seguintes campos:

  • chaveDocumentoFiscal
    • O número do documento fiscal, utilizado para a NF-e (nota fiscal eletrônica).
  • tipoDocumentoFiscal
    • O tipo do documento fiscal, como por exemplo a NF-e, NFC-e, NF ou NFVC.
  • urlArquivoXml
    • O arquivo XML da NF-e, através desse arquivo é possível realizar o download do XML.

 

A documentação completa da integração via API com o Hiper está disponível neste artigo.