Política de privacidade
25/05/2023
Acompanhe os passos necessários para a integração através de API entre o seu serviço de e-commerce e a loja virtual do Hiper.
Importante: Para que a integração com e-commerce via API seja completa, é necessário contar com o apoio de uma empresa que desenvolva a comunicação entre o serviço de e-commerce e o Hiper, com base na documentação abaixo.
25/05/2023
25/02/2021
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.
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.
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:
Na API de produtos, não devem ser mais utilizados os campos:
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:
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:
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:
A documentação completa da integração via API com o Hiper está disponível neste artigo.
22/04/2020
O token de autenticação é utilizado para que possamos garantir a segurança da sua conexão ao nosso banco de dados. Para a geração do token, você deve acessar o seguinte endereço:
Observação: A chave de segurança é gerada automaticamente após a contratação do aplicativo “Loja virtual”. Para consultar sua chave, acesse o menu “Vendas” >> “Loja virtual”.
Parâmetros a serem passados na chamada:
chaveDeSeguranca:
Parâmetros retornados na chamada:
chaveDeSeguranca:
token:
Exemplo de resposta:
{
“chaveDeSeguranca”:
“31ccdc335b8a6825e28e032a4906fe5dd446ec9e99878012d66b8c77e066f0b9”,
“token”:
“eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiIyM2EzOTliOC1hM2JhLTRjMDEtYjllMi1kZWVjMzUyM2FiNTciLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9oYXNoIjoiMzFjY2RjMzM1YjhhNjgyNWUyOGUwMzJhNDkwNmZlNWRkNDQ2ZWM5ZTk5ODc4MDEyZDY2YjhjNzdlMDY2ZjBiOSIsIm5iZiI6MTU4NTYxNDYyNiwiZXhwIjoxNTg1NjM2MjI2LCJpYXQiOjE1ODU2MTQ2MjZ9.EVHIZbLHSC6tC7VM0OqnvY_95tfsFoHOBdRCcNTNbsE”,
“errors”: [],
“message”: null
}
22/04/2020
A consulta de produto deve ser utilizada para a importação dos produtos em sua loja virtual.
Para o consumo da chamada, você deve utilizar o seguinte endereço:
Parâmetros a serem passados na chamada:
Authorization:
pontoDeSincronizacao:
Parâmetros retornados na chamada:
altura:
ativo:
categoria:
codigo:
codigoDeBarras:
comprimento:
cor (Solução transferida para o atributo “variacao” – Em breve, será removido – NÃO UTILIZAR!):
descricao:
grade:
id:
imagem:
imagensAdicionais:
largura:
marca:
ncm:
nome:
peso:
preco:
produtoPrimarioId:
quantidadeEmEstoque (Solução transferida para o objeto de estoque – Em breve, será removido – NÃO UTILIZAR!):
quantidadeMinimaEmEstoque (Solução transferida para o objeto de estoque – – Em breve, será removido – NÃO UTILIZAR!):
tamanho (Solução transferida para o atributo “variacao” – Em breve, será removido – NÃO UTILIZAR!):
unidade:
variacao:
Exemplo de resposta do produto sem grade:
{
“pontoDeSincronizacao”: 1,
“produtos”: [
{
“altura”: 0,
“ativo”: true,
“codigo”: 3001,
“codigoDeBarras”: “7898935968974”,
“categoria”: “VESTUÁRIO”,
“comprimento”: 0,
“grade”: “true”,
“id”: “34852cf6-f222-4d61-86d1-045a1aee66f4”,
“imagem”: null,
“imagensAdicionais”: [],
“largura”: 0,
“marca”: “CHICCO“,
“ncm”: “0101.29.00”,
“nome”: “CAMISETA HEROIS – M – Marrom”,
“peso”: 0.000,
“preco”: 39.99,
“produtoPrimarioId”: “00000000-0000-0000-0000-000000000000”,
“unidade”: “PC”,
“variacao”: []
},
],
“errors”: [],
“message”: null
}
Exemplo de resposta do produto com grade:
{
“pontoDeSincronizacao”: 1,
“produtos”: [
{
“altura”: 0.000,
“ativo”: true,
“categoria”: “ANEL”,
“comprimento”: 0.000,
“codigo”: 3100,
“codigoDeBarras”: “7898935964039”,
“descricao”: null,
“grade”: true,
“id”: “1cd76fcb-f4c2-406b-8da9-082c0311da19”,
“imagem”: null,
“imagensAdicionais”: [
{
“imagem”: “https://hiper-gestao.s3.amazonaws.com/30becddf-be6c-4c52-9492-587da40235e4/imagem-de-produto/244d5a3f-b899-4bc3-bcf7-770a60771355/original.jpeg”
},
{
“imagem”: “https://hiper-gestao.s3.amazonaws.com/30becddf-be6c-4c52-9492-587da40235e4/imagem-de-produto/f82365fb-50a0-4bf8-a29f-8bb53f9424cd/original.jpeg”
},
{
“imagem”: “https://hiper-gestao.s3.amazonaws.com/30becddf-be6c-4c52-9492-587da40235e4/imagem-de-produto/f92ff7a9-9d43-4722-b465-be4b2904fddf/original.jpeg”
},
{
“imagem”: “https://hiper-gestao.s3.amazonaws.com/30becddf-be6c-4c52-9492-587da40235e4/imagem-de-produto/14d1f2ee-e1da-48d8-8a4d-faa98c4eb77d/original.jpeg”
}
],
“largura”: 0.000,
“marca”: null,
“ncm”: “0101.29.00”,
“nome”: “Anel com ondas cravejadas – Semijoia”,
“peso”: 0.000,
“preco”: 49.90,
“produtoPrimarioId”: “00000000-0000-0000-0000-000000000000”,
“unidade”: “UN”,
“variacao”: [
{
“id”: “e4987f9a-dddb-4207-9c91-0f2508a737ae”,
“tipoVariacaoA”: “Cores”,
“nomeVariacaoA”: “Dourado”,
“tipoVariacaoB”: “Tamanhos”,
“nomeVariacaoB”: “13”
},
]
},
],
“errors”: [],
“message”: null
},
{
“altura”: 0.000,
“ativo”: true,
“categoria”: “ANEL”,
“codigo”: 3100,
“codigoDeBarras”: null,
“comprimento”: 0.000,
“descricao”: null,
“grade”: true,
“id”: “e4987f9a-dddb-4207-9c91-0f2508a737ae”,
“imagem”: null,
“imagensAdicionais”: [],
“largura”: 0.000,
“marca”: null,
“ncm”: “0101.29.00”,
“nome”: “Anel com ondas cravejadas – Semijoia”,
“peso”: 0.000,
“preco”: 49.90,
“produtoPrimarioId”: “1cd76fcb-f4c2-406b-8da9-082c0311da19”,
“unidade”: “UN”,
“variacao”: [],
“errors”: [],
“message”: null
}
21/07/2020
A consulta do estoque do produto deve ser utilizada para a importação do saldo em estoque da sua loja virtual.
Para o consumo da chamada, você deve utilizar o seguinte endereço:
Parâmetros a serem passados na chamada:
Authorization:
pontoDeSincronizacao:
produtoId:
Parâmetros retornados na chamada:
Exemplo de resposta do estoque:
22/04/2020
O pedido de venda realizado em sua loja virtual deverão ser enviados através dessa chamada. Com isso, o pedido de venda da sua loja virtual será cadastrado automaticamente para dentro do Hiper.
Para o consumo da chamada, você deve utilizar o seguinte endereço:
Parâmetros a serem passados na chamada:
Authorization:
Parâmetros a serem enviados na chamada:
cliente // documento:
cliente // email:
cliente // inscricaoEstadual:
cliente // nomeDoCliente:
cliente // nomeFantasia:
enderecoDeCobranca // bairro:
enderecoDeCobranca // cep:
enderecoDeCobranca // codigoIbge:
enderecoDeCobranca // complemento:
enderecoDeCobranca // logradouro:
enderecoDeCobranca // numero:
enderecoDeEntrega // bairro:
enderecoDeEntrega // cep:
enderecoDeEntrega // codigoIbge:
enderecoDeEntrega // complemento:
enderecoDeEntrega // logradouro:
enderecoDeEntrega // numero:
itens // produtoId:
itens // quantidade:
itens // precoUnitarioBruto:
itens // precoUnitarioLiquido:
meiosDePagamento // idMeioDePagamento:
meiosDePagamento // parcelas:
meiosDePagamento // valor:
numeroPedidoDeVenda:
observacaoDoPedidoDeVenda:
valorDoFrete:
Marketplace// CNPJ:
Marketplace// Nome:
Exemplo de requisição:
{
“cliente”:
{
“documento”: “19561920000”,
“email”: “clientedoecommerce@hotmail.com.br”,
“inscricaoEstadual”: “”,
“nomeDoCliente”: “Cliente do E-commerce”,
“nomeFantasia”: “”
},
“enderecoDeCobranca”:
{
“bairro”: “Centro”,
“cep”: “88351001”,
“codigoIbge”: 4202909,
“complemento”: “”,
“logradouro”: “Rua Principal”,
“numero”: “01”
},
“enderecoDeEntrega”:
{
“bairro”: “Centro”,
“cep”: “88351001”,
“codigoIbge”: 4202909,
“complemento”: “Sala 2”,
“logradouro”: “Rua Principal”,
“numero”: “22”
},
“itens”:
[
{
“produtoId”: “34852cf6-f222-4d61-86d1-045a1aee66f4”,
“quantidade”: 1,
“precoUnitarioBruto”: 99.99,
“precoUnitarioLiquido”: 99.99
}
],
“meiosDePagamento”:
[
{
“idMeioDePagamento”: 1,
“parcelas”: 1,
“valor” : 99.99
}
]
“numeroPedidoDeVenda”:””,
“observacaoDoPedidoDeVenda”:””,
“valorDoFrete”: 0
“Marketplace”: {
“Cnpj”:”12605982000124″,
“Nome”:”Hiper”
}
}
Exemplo de resposta:
{
“id”: “158b044b-d887-4e47-b08c-e2b353b1c1d5”,
“errors”: [ ],
“message”: “Pedido recebido e em processamento.”
}
22/04/2020
Através da consulta de pedido do venda pode ser acompanhado o histórico de eventos do pedido de venda e informações como a situação do pedido de venda, o código de rastreio e o número do documento fiscal.
Para o consumo da chamada, você deve utilizar o seguinte endereço:
Parâmetros a serem passados na chamada:
Authorization:
id:
Parâmetros retornados na chamada:
cancelado:
chaveDocumentoFiscal:
codigoDaSituacaoDeProcessamento:
codigoDoPedidoDeVenda:
data:
eventos // chaveDocumentoFiscal:
eventos // codigoDoTipoDeEvento:
eventos // data:
eventos // observacao:
eventos // tipoDocumentoFiscal:
eventos // urlArquivoXml:
pedidoDeVendaId:
Exemplo de resposta:
{
“cancelado”: true,
“codigoDaSituacaoDeProcessamento”: 2,
“codigoDoPedidoDeVenda”: null,
“data”: “27/03/2020 17:13:05”,
“eventos”: [
{
“chaveDocumentoFiscal”: “42201212605982000124552880000025701319587551”,
“codigoDoTipoDeEvento”: 3,
“data”: “17/12/2020 13:20:48”,
“observacao”: “Número da Nota Fiscal: 2570 – Série: 288”,
“tipoDocumentoFiscal”: “NFE”,
“urlArquivoXml”: “https://hiper-gestao.s3.amazonaws.com/30becddf-be6c-4c52-9492-587da40235e4/Xmls/2020_12/12605982000124/Emitidos/Saidas/Nfe/Autorizadas/42201212605982000124552880000025701319587551-Nfe.xml”
}
],
“pedidoDeVendaId”: “43a42deb-789f-4f67-a329-8172c1b0f611”,
“errors”: [ ],
“message”: null
}
22/04/2020
A criação do pedido de venda reserva automaticamente o estoque da sua loja. Para manter seu estoque atualizado, é importante que os pedidos que foram canceladas em sua loja virtual seja cancelado no Hiper também.
Para o consumo da chamada, você deve utilizar o seguinte endereço:
Parâmetros a serem passados na chamada:
Authorization:
id:
Exemplo de resposta:
{
“errors”: [],
“message”: “Cancelamento recebido e em processamento.”
}
06/08/2021