GET – PRODUTOS
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:
- Deverá ser passado o Bearer Token de autenticação
pontoDeSincronizacao:
- O ponto de sincronização é utilizado para controlar as atualizações que ocorrem no sistema desde a última consulta realizada, ou seja, se o produto teve uma alteração será alterado automaticamente o ponto de sincronização.
- Se você quiser todos os produtos, deverá ser enviado o ponto de sincronização igual 0.
- Agora, se você quiser uma listagem de produtos que tiverem atualização, você deve enviar o número do ponto de sincronização retornado na última consulta realizada. Com isso, a integração retornará somente os produtos que tiverem atualização.
Parâmetros retornados na chamada:
altura:
- A altura é utilizada para a embalagem no frete da mercadoria.
- Tipo do campo: decimal (5,3).
- Valor máximo: 99999.999 // Valor mínimo: 0.000.
ativo:
- A situação do produto no Hiper.
- Tipo do campo: boolean.
- Se for true, o produto está ativo.
- Se for false, o produto está inativo.
categoria:
- O nome da categoria que pertence o produto cadastrado no Hiper.
- Tipo do campo: string com o tamanho máximo de 40 caracteres.
codigo:
- O código interno do produto disponível no Hiper.
- Exemplo: 3001, 3002, 3003, entre outros.
- Tipo do campo: inteiro.
- Valor máximo: 99999999999999
codigoDeBarras:
- O código de barras do produto.
- Exemplo: 7812381318321, 7812381311234, entre outros.
- Tipo de campo: string com o tamanho máximo de 36 caracteres.
comprimento:
- O comprimento é utilizado para a embalagem no frete da mercadoria.
- Tipo do campo: decimal (5,3).
- Valor máximo: 99999.999 // Valor mínimo: 0.000.
cor (Solução transferida para o atributo “variacao” – Em breve, será removido – NÃO UTILIZAR!):
descricao:
- A descrição detalhada cadastrado no Hiper.
- Tipo do campo: string com o tamanho máximo de 700 caracteres.
grade:
- Indicação do produto com grade.
- Se possui grade, será indicado como “true”.
- Mesmo sendo o produto primário ou o produto filho.
- Se não possui grade, será indicado como “false”.
- Se possui grade, será indicado como “true”.
- Tipo do campo: booleano.
id:
- O identificador único do produto cadastrado no Hiper.
- Tipo do campo: uniqueidentifier com 36 caracteres.
imagem:
- A imagem será exibida através de um link ao diretório da nossa estrutura de dados.
- Tipo do campo: string com o tamanho máximo de 300 caracteres.
imagensAdicionais:
- As imagens adicionais serão exibidas através de links ao diretório da nossa estrutura de dados.
- As imagens adicionais são as imagens diferentes da principal do cadastro de produto, a imagem principal do produto está disponível no campo imagem.
- Tipo do campo: string com o tamanho máximo de 300 caracteres.
largura:
- A largura é utilizada para a embalagem no frete da mercadoria.
- Tipo do campo: decimal (5,3).
- Valor máximo: 99999.999 // Valor mínimo: 0.000.
marca:
- O nome da marca que pertence o produto cadastrado no Hiper.
- Tipo do campo: string com o tamanho máximo de 60 caracteres.
ncm:
- O NCM que pertence o produto cadastrado no Hiper.
- Tipo do campo: string com o tamanho máximo de 10 caracteres.
- Formato: 0000.00.00
nome:
- O nome do produto ou grade cadastrado(a) no Hiper.
- Tipo do campo: string com o tamanho máximo de 60 caracteres.
peso:
- O peso do produto é utilizado para a embalagem no frete da mercadoria.
- Tipo do campo: decimal (15,3).
- Peso máximo: 999.999.999.999.999.999 // Peso mínimo: 0.000.
preco:
- O preço de venda do produto cadastrado no Hiper.
- O preço de venda do produto é exibido de acordo com a tabela de preço informada nas configurações da loja virtual.
- Se o usuário não definir uma informação padrão, será exibido o preço definido no cadastro do produto.
- Se o usuário definir uma informação padrão, será exibido o preço definido na tabela de preço do produto.
- Preço máximo: 999.999.999.999.999.99 // Preço mínimo: 0.01.
produtoPrimarioId:
- O identificador da grade do produto cadastrado no Hiper.
- Se o produtoPrimarioId for vazia, o produto não possui grade.
- Se o produtoPrimarioId possui uma informação, o produto possui grade.
- Tipo do campo: uniqueidentifier com 36 caracteres.
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:
- A sigla da unidade de medida do produto.
- Unidades padrões: “UN”, “KG”, “MT”, entre outras.
- Tipo do campo: string com o tamanho máximo de 3 caracteres.
variacao:
- O identificador, o tipo e a grade dos produtos.
- id: O identificador do produto filho.
- tipoVariacaoA: O nome do tipo da variação do produto.
- Exemplo: “Cores”, “Tamanhos”, “Grãos”, entre outros.
- nomeVariacaoA: O nome da variação do produto.
- Exemplo: Azul, Amarelo, G, GG, entre outros.
- tipoVariacaoB: O nome do tipo da variação do produto.
- Exemplo: “Cores”, “Tamanhos”, “Grãos”, entre outros.
- nomeVariacaoB: O nome da variação do produto.
- Exemplo: Azul, Amarelo, G, GG, entre outros.
- Se o produto possui grade e for produto principal, ou seja, o produto pai, serão exibidos: id, tipo e o nome do variação do produto filho.
- Se o produto possui grade e for produto variação, ou seja, o produto filho, o campo “variacao” ficará vazio, pois o mesmo é a variação.
- Tipo do campo: string com o tamanho máximo de 80 caracteres.
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
}