Para quê serve a API ofertas?
A API de ofertas tem como proposito, modernizar o atual método de acesso, disponibilizando ferramentas modernas, escaláveis e de fácil acesso. Esses endpoints possibilitam consultas e atualizações de ofertas no Via Marketplace.
URLs
Nós disponibilizamos um ambiente de homologação para a realizarem todos os testes. Os endpoints a seguir tem como base as seguintes URLs:
Base URL (HLG)https://api-mktplace-hlg.viavarejo.com.br/api/v4
https://api-mktplace.viavarejo.com.br/api/v4
Collection Postman
A collection do Postman já com os endpoints está disponível no link abaixo.
Lembre-se de Inserir o “client_id” e “access_token” gerados na criação da App aqui no portal para que seja possível realizar as chamadas com sucesso.
Caso não saiba como criar uma App, clique aqui e veja como fazer.
Consulta de SKUs cadastrados (Unitária)
Esse serviço fornece uma visão completa do SKU de um determinado lojista. Método: GET
Composição do Header:
- access_token: Chave de acesso da loja
- client_id: Chave de acesso da integradora
- Accept: application/json
- Content-Type: application/json
https://api-mktplace-hlg.viavarejo.com.br/api/v4/api-front-products-v4/jersey/product/{idSkuLojista}
https://api-mktplace.viavarejo.com.br/api/v4/api-front-products-v4/jersey/product/{idSkuLojista}
Lista de retornos possíveis
| Ação | Status code | Mensagem |
|---|---|---|
| idSkuLojista cadastrado para o seller | 200 | - |
| idSkuLojista não cadastrado para o seller | 404 | - |
Response
Quando o idSkuLojista existir no catálogo do seller utilizado no header, o retorno será como no exemplo:
{
"idProduto": 407330509,
"descricao": "Perfume Romance com Aroma Sedutor Mens",
"marca": "KAIAK",
"titulo": "Perfume Romance com Aroma Sedutor Mens",
"sku": {
"idSkuLojista": "541sf6967981",
"idSkuMarketplace": "898801556",
"idSkuSite": "1513441570",
"atributos": [
{
"id": 206509,
"nome": "Selecione",
"valor": "30 ml"
}
],
"dimensao": {
"peso": 0.5,
"altura": 0.5,
"largura": 0.5,
"profundidade": 0.5
},
"urlSites": {
"EX": "http://produto.extra.com.br/898801556",
"PF": "http://produto.pontofrio.com.br/898801556",
"CB": "http://produto.casasbahia.com.br/898801556"
},
"imagens": [
"http://is.n-img.net.br/img-v2/images/skus/d086b181-fcdc-4600-98df-9f097e94797c.jpg"
],
"precos": [
{
"de": 30000,
"por": 30000,
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"de": 30000,
"por": 30000,
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"de": 30000,
"por": 30000,
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"status": [
{
"ativo": "N",
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"ativo": "N",
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"ativo": "N",
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"flagLock": true,
"estoques": [
{
"quantidade": 0,
"tempoDePreparacao": 1,
"reserva": 50,
"centroDeDistribuicao": {
"id": 5
}
}
]
},
"atributos": [],
"categoria": {
"id": "1886",
"nome": "Perfumaria e Cosméticos",
"categoria": {
"id": "1887",
"nome": "Perfumes",
"categoria": {
"id": "1890",
"nome": "Unissex"
}
}
}
}
Clique aqui e veja o endpoint completo de PRD!_
Consulta de SKUs cadastrados (Paginada)
Esse serviço retorna a lista completa (paginada) de SKUs cadastrados para um determinado lojista.
Método: GET
Composição do Header:
- access_token: Chave de acesso da loja
- client_id: Chave de acesso da integradora
- Accept: application/json
- Content-Type: application/json
Parâmetro:
Para realizar a consulta paginada, primeiro precisamos entender o parêmetro padrão abaixo:_**
-
pagina = 1 (número da página desejada)
-
itensPorPagina = 50 (quantidade de SKUs que serão exibidos na página)
-
Query completa: ?pagina=1&itensPorPagina=50
Parâmetros opcionais:
- Consulta por bandeira (site – CB, PF e EX): ?pagina=1&itensPorPagina=50&site=
- Consulta por status (ativo - true/ inativo - false): ?pagina=1&itensPorPagina=50&status=
- Consulta por flagLock (inativado pela Via - true/ false): ?pagina=1&itensPorPagina=50&flagLock=
- Consulta por título de produto: ?pagina=1&itensPorPagina=50&titulo=
- Consulta por marca de produto: ?pagina=1&itensPorPagina=50&marca=
- Consulta por itens de uma categoria específica (código da categoria): ?pagina=1&itensPorPagina=50&categoria=
- Consulta por código de SKU Site: ?pagina=1&itensPorPagina=50&idSkuSite=
https://api-mktplace-hlg.viavarejo.com.br/api/v4/api-front-products-v4/jersey/product/?pagina=1&itensPorPagina=50
https://api-mktplace.viavarejo.com.br/api/v4/api-front-products-v4/jersey/product/?pagina=1&itensPorPagina=50
Lista de retornos possíveis
| Ação | Status code | Mensagem |
|---|---|---|
| Lista de SKUs disponível | 200 | - |
| Lista de SKUs inexistente | 204 | - |
| Parâmetros incorretos | 400 | - |
Response
{
"valido": true,
"conteudo": {
"itens": [
{
"idProduto": 1503358,
"descricao": "Em Quando o sofrimento bater à sua porta, Pe. Fábio de Melo nos proporciona uma reflexão sobre as razões de nosso sofrimento e como transformá-lo em fonte de valores. A partir de vários relatos, ele expõe que o sofrimento humano está repleto de ensinamento; tudo dependerá de nosso ponto de vista e de nossas escolhas. \r\n\r\nO livro mostra ainda que o sofrimento não deve ser um estado definitivo, mas sim um instante de travessia, um caminho para a transformação. “Sofrimento é destino inevitável, porque é fruto do processo que nos torna humanos. O grande desafio é identificar o sofrimento que vale a pena ser sofrido”.",
"marca": "Editora Canção Nova",
"titulo": "Livro - Quando o Sofrimento Bater à Sua Porta",
"sku": {
"gtin": "7899091423231",
"idSkuLojista": "965138-3",
"idSkuMarketplace": "52990",
"idSkuSite": "52990",
"atributos": [],
"dimensao": {
"peso": 0.245,
"altura": 0.02,
"largura": 0.15,
"profundidade": 0.2
},
"urlSites": {
"EX": "http://produto.extra.com.br/52990",
"PF": "http://produto.pontofrio.com.br/52990",
"CB": "http://produto.casasbahia.com.br/52990"
},
"imagens": [
"https://imgs.via.com.br/52990/1xg.jpg"
],
"precos": [
{
"de": 43,
"por": 23,
"site": {
"id": "4",
"sigla": "PF"
}
},
{
"de": 43,
"por": 23,
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"de": 43,
"por": 23,
"site": {
"id": "2",
"sigla": "EX"
}
}
],
"status": [
{
"ativo": "N",
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"ativo": "N",
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"ativo": "N",
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"flagLock": true,
"estoques": [
{
"quantidade": 1,
"tempoDePreparacao": 5,
"reserva": 0,
"centroDeDistribuicao": {
"id": 5
}
}
]
}
},
{
"idProduto": 1503359,
"descricao": "<span style=\"font-weight: bold\">Este livro apresenta mais de 50 ideias que estimulam o sucesso em vendas. </span><br />\r\nUtilizando sua experiência na área e usando ferramentas psicológicas, Chandler ilustra maneiras para que tanto o profissional iniciante quanto o experiente alcancem novas alturas na prosperidade em negócios. Fortes habilidades em vendas têm aplicação universal. Vendas criam civilização, promovem o progresso e formam relacionamentos entre as pessoas. <br />\r\n'Alegria de vender' convida o leitor a comprometer-se conscientemente com a inovação, aventura e com comunicação clara.",
"marca": "Editora Novo Século",
"titulo": "Livro - Alegria de Vender: Idéias Inovadoras Que Levam ao Sucesso em Vendas",
"isbn": "8576790718",
"sku": {
"gtin": "7899091423231",
"idSkuLojista": "sku-ean-obrigtrio",
"idSkuMarketplace": "52991",
"idSkuSite": "52991",
"atributos": [],
"dimensao": {
"peso": 0.245,
"altura": 0.02,
"largura": 0.15,
"profundidade": 0.2
},
"urlSites": {
"EX": "http://produto.extra.com.br/52991",
"PF": "http://produto.pontofrio.com.br/52991",
"CB": "http://produto.casasbahia.com.br/52991"
},
"imagens": [
"https://imgs.via.com.br/52991/1xg.jpg"
],
"precos": [
{
"de": 999,
"por": 999,
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"de": 999,
"por": 999,
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"de": 999,
"por": 999,
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"status": [
{
"ativo": "N",
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"ativo": "N",
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"ativo": "N",
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"flagLock": true,
"estoques": [
{
"quantidade": 1,
"tempoDePreparacao": 5,
"reserva": 0,
"centroDeDistribuicao": {
"id": 5
}
}
]
}
},
{
"idProduto": 1503364,
"descricao": "Este livro nasceu da experiência pedagógica da autora e de sua atuação em salas de aula, palestras em espaços culturais, situação clínica e centros de estudos espiritualistas. Se deseja ligar-se aos espíritos iluminados, precisa enxergar a luz que brilha dentro de si.ritos iluminados, precisa enxergar a luz que brilha dentro de si.</p>\n",
"marca": "Editora Espaço Vida e Consciência",
"titulo": "Livro - Mediunidade e Auto-estima ",
"isbn": "8585872985",
"sku": {
"gtin": "7899091423231",
"idSkuLojista": "321313-3",
"idSkuMarketplace": "53090",
"idSkuSite": "53090",
"atributos": [],
"dimensao": {
"peso": 0.245,
"altura": 0.02,
"largura": 0.15,
"profundidade": 0.2
},
"urlSites": {
"EX": "http://produto.extra.com.br/53090",
"PF": "http://produto.pontofrio.com.br/53090",
"CB": "http://produto.casasbahia.com.br/53090"
},
"imagens": [
"https://imgs.via.com.br/53090/1xg.jpg"
],
"precos": [
{
"de": 87,
"por": 23,
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"de": 87,
"por": 23,
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"de": 87,
"por": 23,
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"status": [
{
"ativo": "N",
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"ativo": "N",
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"ativo": "N",
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"flagLock": true,
"estoques": [
{
"quantidade": 0,
"tempoDePreparacao": 1,
"reserva": 0,
"centroDeDistribuicao": {
"id": 5
}
}
]
}
},
{
"idProduto": 1503382,
"descricao": "Casa-Grande & Senzala, publicada em 1933, mais do que uma redescoberta da nação brasileira, foi uma espécie de fundação do Brasil no plano cultural, como observou Darcy Ribeiro, tal como Cervantes havia feito em relação à Espanha, Camões a Portugal e Tolstoi à Rússia. Valorizando o papel do negro na história brasileira, exaltando a miscigenação racial, desmistificando preconceitos e reconhecendo a originalidade de nossa cultura, tipicamente tropical, o livro caiu como um meteoro nos meios intelectuais. \r\n\r\nA novidade estava tanto no pensamento do autor como na sua forma de se expressar e nos métodos utilizados na montagem da obra. A linguagem de Gilberto Freyre tinha uma irreverência desconhecida nas letras brasileiras, por vezes um tom de gozação, que chegou a provocar protestos de algumas correntes mais conservadoras. Mais interessante ainda foi o material recolhido para mostrar a face autêntica do Brasil: diários esquecidos, receitas de bolos e doces, práticas cotidianas como o cafuné e a retirada de bichos-do-pé, nas quais se revelavam um exacerbado sensualismo, relações sexuais entre marido e mulher, entre sinhô e escravas, entre escravos e sinhás, raptos, o amor à higiene, os muitos banhos tomados a cada dia pelos brasileiros, fatos a que ninguém ligava importância, mas muito mais eloqüentes na revelação do povo brasileiro e do Brasil como nação do que as exaltações convencionais de feitos históricos. \r\n\r\nMais de setenta anos depois de sua publicação, Casa-Grande & Senzala firma-se como um dos livros capitais da cultura brasileira, sem o qual é impossível conhecer o Brasil, ao lado de Os Sertões, de Euclides da Cunha, dos romances da maturidade de Machado de Assis, e mais uma meia dúzia de obras.s depois de sua publicação, Casa-Grande & Senzala firma-se como um dos livros capitais da cultura brasileira, sem o qual é impossível conhecer o Brasil, ao lado de Os Sertões, de Euclides da Cunha, dos romances da maturidade de Machado de Assis, e mais uma meia dúzia de obras.</p>\n",
"marca": "Editora Global",
"titulo": "Livro - Casa Grande e Senzala",
"isbn": "8526008692 ",
"sku": {
"gtin": "7899091423231",
"idSkuLojista": "562905-3",
"idSkuMarketplace": "53390",
"idSkuSite": "53390",
"atributos": [],
"dimensao": {
"peso": 0.245,
"altura": 0.02,
"largura": 0.15,
"profundidade": 0.2
},
"urlSites": {
"EX": "http://produto.extra.com.br/53390",
"PF": "http://produto.pontofrio.com.br/53390",
"CB": "http://produto.casasbahia.com.br/53390"
},
"imagens": [
"https://imgs.via.com.br/53390/1g.jpg"
],
"precos": [
{
"de": 1000,
"por": 1000,
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"de": 1000,
"por": 1000,
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"de": 1000,
"por": 1000,
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"status": [
{
"ativo": "N",
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"ativo": "N",
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"ativo": "N",
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"flagLock": true,
"estoques": [
{
"quantidade": 1,
"tempoDePreparacao": 0,
"reserva": 0,
"centroDeDistribuicao": {
"id": 5
}
}
]
}
},
{
"idProduto": 1503453,
"marca": "Não informado",
"titulo": "Livro – MIL CORES - ANIMAIS - P - IMPALA",
"sku": {
"gtin": "7899091423231",
"idSkuLojista": "Aluminum580",
"idSkuMarketplace": "54592",
"idSkuSite": "54592",
"atributos": [],
"dimensao": {
"peso": 0.245,
"altura": 0.2,
"largura": 0.15,
"profundidade": 0.02
},
"urlSites": {
"EX": "http://produto.extra.com.br/54592",
"PF": "http://produto.pontofrio.com.br/54592",
"CB": "http://produto.casasbahia.com.br/54592"
},
"imagens": [
"http://is.n-img.net.br/img-v2/images/1e2e82bb-aec2-46a6-a253-4fcfcf385f79.jpg"
],
"precos": [
{
"de": 19777,
"por": 18752,
"site": {
"id": "4",
"sigla": "PF"
}
},
{
"de": 19777,
"por": 18752,
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"de": 19777,
"por": 18752,
"site": {
"id": "2",
"sigla": "EX"
}
}
],
"status": [
{
"ativo": "N",
"site": {
"id": "2",
"sigla": "EX"
}
}
],
"flagLock": true,
"estoques": [
{
"quantidade": 1,
"tempoDePreparacao": 0,
"reserva": 0,
"centroDeDistribuicao": {
"id": 5
}
}
]
}
},
{
"idProduto": 1503454,
"descricao": "Uma alternativa cristã ao best-seller O Segredo, este livro revela os segredos de Deus sobre a felicidade, sobre os relacionamentos, sobre a carreira e sobre o nosso objetivo na vida. Estas verdades espirituais já foram testadas e revelam princípios que fazem a vida funcionar. O lançamento de O Segredo levou um número incontável de leitores a ponderar como seus ensinamentos se ajustavam às verdades encontradas nas Escrituras. Sua repercussão também mostrou o profundo anseio espiritual que existe em todos nós – o desejo de que um poder que está acima do humano produza mudanças nas nossas vidas individuais.\r\n\r\nMuitas vezes, até mesmo cristãos que conhecem e defendem as verdades bíblicas não sabem como usá-las. O dr. Henry Cloud mostra aos leitores como desvendar o segredo destas verdades e acionar o poder delas em suas vidas.\r\nHá uma poderosa atração funcionando no universo, mas não se trata de uma relação entre um universo impessoal e nossos pensamentos. O que existe, acima de tudo, é uma atração entre o Criador pessoal do universo e a criação que ele tanto ama",
"marca": "Editora Planeta",
"titulo": "Livro - O Segredo de Deus: Revelando os Tesouros Guardados Para Você",
"isbn": "8576653443 ",
"sku": {
"gtin": "7899091423231",
"idSkuLojista": "Calcium14",
"idSkuMarketplace": "54687",
"idSkuSite": "54687",
"atributos": [],
"dimensao": {
"peso": 0.245,
"altura": 0.02,
"largura": 0.15,
"profundidade": 0.2
},
"urlSites": {
"EX": "http://produto.extra.com.br/54687",
"PF": "http://produto.pontofrio.com.br/54687",
"CB": "http://produto.casasbahia.com.br/54687"
},
"imagens": [
"https://imgs.via.com.br/54687/1g.jpg"
],
"precos": [
{
"de": 19254,
"por": 18317,
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"de": 19254,
"por": 18317,
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"de": 19254,
"por": 18317,
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"status": [
{
"ativo": "N",
"site": {
"id": "2",
"sigla": "EX"
}
}
],
"flagLock": true,
"estoques": [
{
"quantidade": 1,
"tempoDePreparacao": 0,
"reserva": 0,
"centroDeDistribuicao": {
"id": 5
}
}
]
}
},
{
"idProduto": 1503455,
"descricao": "A história de Paulo Coelho, o menino que nasceu morto, flertou com o suicídio, sofreu em manicômios, mergulhou nas drogas, experimentou diversas formas de sexo, encontrou-se com o diabo, foi preso pela ditadura, ajudou a revolucionar o rock brasileiro, redescobriu a fé e se transformou em um dos escritores mais lidos do mundo. \r\n\r\nFernando Morais volta sua verve investigativa para o personagem brasileiro que se converteu em mito - Paulo Coelho - um escritor que alcançou a marca de 100 milhões de livros vendidos e a façanha de ser o autor vivo mais traduzido de todo o planeta.",
"marca": "Editora Planeta",
"titulo": "Livro - O Mago",
"isbn": "8576653605",
"sku": {
"gtin": "7899091423231",
"idSkuLojista": "Thallium544",
"idSkuMarketplace": "54688",
"idSkuSite": "54688",
"atributos": [],
"dimensao": {
"peso": 0.245,
"altura": 0.02,
"largura": 0.15,
"profundidade": 0.2
},
"urlSites": {
"EX": "http://produto.extra.com.br/54688",
"PF": "http://produto.pontofrio.com.br/54688",
"CB": "http://produto.casasbahia.com.br/54688"
},
"imagens": [
"https://imgs.via.com.br/54688/1g.jpg"
],
"precos": [
{
"de": 19732,
"por": 18138,
"site": {
"id": "4",
"sigla": "PF"
}
},
{
"de": 19732,
"por": 18138,
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"de": 19732,
"por": 18138,
"site": {
"id": "2",
"sigla": "EX"
}
}
],
"status": [
{
"ativo": "N",
"site": {
"id": "2",
"sigla": "EX"
}
}
],
"flagLock": true,
"estoques": [
{
"quantidade": 1,
"tempoDePreparacao": 0,
"reserva": 0,
"centroDeDistribuicao": {
"id": 5
}
}
]
}
},
{
"idProduto": 1503456,
"descricao": "Após o sucesso avassalador de Paixão Índia, Javier Moro, pesquisador incansável e grande narrador, romanceia agora a história verídica de uma européia que enfrentou um mundo complicado e perigoso, envolvida nas intrigas de uma família tão rejeitada quanto admirada, e nos leva a uma Índia fascinante e turbulenta, em permanente processo de mudança. Seu romance anterior, Paixão Índia, já cativou um milhão de leitores. Em 1965, Sonia Maino, uma estudante italiana de 19 anos, conhece em Cambridge um jovem indiano chamado Rajiv Ghandi. Ela é filha de uma família humilde de Turim; ele pertence à estirpe mais poderosa da Índia. É o início de uma história de amor que nem mesmo a morte será capaz de quebrar. Por amor, a italiana abandona seu mundo e seu passado para fundir-se com seu novo país, a Índia prodigiosa que adora 20 milhões de divindades, fala oitocentos idiomas e que vota em quinhentos partidos políticos. Sua coragem, honestidade e sua entrega acabarão transformando-a em uma deusa aos olhos de um sexto da hmanidade.",
"marca": "Editora Planeta",
"titulo": "Livro - O Sári Vermelho",
"isbn": "9788576654285",
"sku": {
"gtin": "7899091423231",
"idSkuLojista": "Darmstadtium71",
"idSkuMarketplace": "54689",
"idSkuSite": "54689",
"atributos": [],
"dimensao": {
"peso": 0.245,
"altura": 0.02,
"largura": 0.15,
"profundidade": 0.2
},
"urlSites": {
"EX": "http://produto.extra.com.br/54689",
"PF": "http://produto.pontofrio.com.br/54689",
"CB": "http://produto.casasbahia.com.br/54689"
},
"imagens": [
"https://imgs.via.com.br/54689/1g.jpg"
],
"precos": [
{
"de": 19913,
"por": 18224,
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"de": 19913,
"por": 18224,
"site": {
"id": "4",
"sigla": "PF"
}
},
{
"de": 19913,
"por": 18224,
"site": {
"id": "3",
"sigla": "CB"
}
}
],
"status": [
{
"ativo": "N",
"site": {
"id": "2",
"sigla": "EX"
}
}
],
"flagLock": true,
"estoques": [
{
"quantidade": 1,
"tempoDePreparacao": 0,
"reserva": 0,
"centroDeDistribuicao": {
"id": 5
}
}
]
}
},
{
"idProduto": 1503459,
"descricao": "Com a linguagem simples de uma menina, em O sonho de Rubina a pequena atriz Rubina Ali conta a sua trajetória meteórica da pobreza na Índia, onde mora, ao status de estrela internacional. Ao participar do filme Quem quer ser um milionário?, de Danny Boyle, vencedor do Oscar 2009, Rubina viu sua vida se transformar. A jovem atriz narra detalhes dos bastidores, como foi participar das filmagens e o dia a dia no set. Lamenta ter voltado, depois da correria das gravações, para sua favela em Bombaim, mas se prepara para seu novo filme, e dessa vez deve trabalhar ao lado de Anthony Hopkins.",
"marca": "Editora Planeta",
"titulo": "Livro - O Sonho de Rubina",
"isbn": "9788576654902 ",
"sku": {
"gtin": "7899091423231",
"idSkuLojista": "3",
"idSkuMarketplace": "54692",
"idSkuSite": "54692",
"atributos": [],
"dimensao": {
"peso": 0.245,
"altura": 0.02,
"largura": 0.15,
"profundidade": 0.2
},
"urlSites": {
"EX": "http://produto.extra.com.br/54692",
"PF": "http://produto.pontofrio.com.br/54692",
"CB": "http://produto.casasbahia.com.br/54692"
},
"imagens": [
"https://imgs.via.com.br/54692/1g.jpg"
],
"precos": [
{
"de": 8000,
"por": 99999,
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"de": 2100,
"por": 1999,
"site": {
"id": "4",
"sigla": "PF"
}
},
{
"de": 2100,
"por": 1999,
"site": {
"id": "2",
"sigla": "EX"
}
}
],
"status": [
{
"ativo": "N",
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"ativo": "N",
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"ativo": "N",
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"flagLock": true,
"estoques": [
{
"quantidade": 2,
"tempoDePreparacao": 0,
"reserva": 0,
"centroDeDistribuicao": {
"id": 5
}
}
]
}
},
{
"idProduto": 1503467,
"descricao": "Esse jogo de potes, da Incasa, é utilizado para uso doméstico, serve para guardar mantimentos.\r\n\r\nDeixe sua cozinha ainda mais organizada.",
"marca": "Não Informado",
"titulo": "Conjunto de Potes Incasa BI0004D c/ 3 Peças - Preto e Branco",
"sku": {
"gtin": "7899091423231",
"idSkuLojista": "Rhenium628",
"idSkuMarketplace": "54892",
"idSkuSite": "54892",
"atributos": [],
"dimensao": {
"peso": 0.3,
"altura": 0.14,
"largura": 0.11,
"profundidade": 0.11
},
"urlSites": {
"EX": "http://produto.extra.com.br/54892",
"PF": "http://produto.pontofrio.com.br/54892",
"CB": "http://produto.casasbahia.com.br/54892"
},
"imagens": [
"https://imgs.via.com.br/54892/1xg.jpg"
],
"precos": [
{
"de": 19317,
"por": 18522,
"site": {
"id": "2",
"sigla": "EX"
}
},
{
"de": 19317,
"por": 18522,
"site": {
"id": "3",
"sigla": "CB"
}
},
{
"de": 19317,
"por": 18522,
"site": {
"id": "4",
"sigla": "PF"
}
}
],
"status": [
{
"ativo": "N",
"site": {
"id": "2",
"sigla": "EX"
}
}
],
"flagLock": true,
"estoques": [
{
"quantidade": 1,
"tempoDePreparacao": 0,
"reserva": 0,
"centroDeDistribuicao": {
"id": 5
}
}
]
}
}
],
"paginacao": {
"temProxima": true,
"pagina": 1,
"totalDePaginas": 7461,
"totalDeItensNaPagina": 10,
"totalDeItens": 74606
}
},
"codigo": "200",
"mensagem": "OK",
"timestamp": "2023-01-12T14:18:24.777+0000"
}
Caso não passe nenhum parâmetro na URL, por default, a consulta retornará a página 1 e o total de SKUs por página (50)
O response traz informaClique aqui e veja o endpoint completo!
Alteração de preço
Esse serviço realiza a atualização de preço de um determinado sku para um determinado lojista.
Método: PUT
Composição do Header:
- access_token: Chave de acesso da loja
- client_id: Chave de acesso da integradora
- Accept: application/json
- Content-Type: application/json
https://api-mktplace-hlg.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer/price
https://api-mktplace.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer/price
Body da chamada (Preço único)
{
"idSkuLojista": "541sf6967981",
"preco": {
"padrao": 99.99,
"oferta": 79.99
}
}
Regras de negócio
- padrao = Preço DE
- oferta = Preço POR
- Formato dos campos "padrao e oferta": Double (apenas número e separador decimal “ponto”);
- Sempre informar valor com 2 casas decimais. Ex: 100.00;
- Campo oferta: Não é permitido informar valor, no qual a diferença em comparação ao preço POR atual, seja maior do que 50%;
- Valor permitido: Máximo: “99999.00” e mínimo: “0.01”;
- Não pode conter espaço.
Lista de retornos possíveis
| Ação | Status code | Mensagem |
|---|---|---|
| Body correto | 200 | Preço alterado com sucesso. |
| Body com SKU não cadastrado | 400 | Não foi encontrado idSku correspondente ao idSkuLojista: [idSkuLojista] e idLojista: [idSeller] |
| Body incorreto (sem SKU) | 400 | IdSkuLojista não informado |
| Body incorreto (sem preços DE ou POR) | 400 | - |
| Body com preço excedendo a trava de 50 | 400 | Preço Oferta possui variação maior que 50% para bandeira EXTRA |
Response
Avaliamos o sucesso pelo HTTP Status Code que deverá ser : 200 - OK
{
"idSkuLojista": "541sf6967981",
"precos": [
{
"de": 99.99,
"por": 79.99,
"site": 2
},
{
"de": 99.99,
"por": 79.99,
"site": 3
},
{
"de": 99.99,
"por": 79.99,
"site": 4
}
]
}
Regras de negócio
- Formato do campo "idSkuLojista": String;
- Formato dos campos "de" e "por": Double (apenas número e separador decimal “ponto”);
- Formato do campo "site": Integer;
- Campo "por": Não é permitido informar valor, no qual a diferença em comparação ao preço POR atual, seja maior do que 50%;
- Padrão dos campos: Double (apenas número e separador decimal “ponto”);
- Campo "site": Pode ser informado código que representa cada bandeira ou sigla (Código: 3 = Casas Bahia, 4 = Ponto Frio e 2= Extra | Sigla: CB, PF e EX);
- É permitido passar o body por site ou para os 3 simultaneamente;
- É permitido passar valores iguais ou diferentes para cada site;
- Sempre informar valor com 2 casas decimais. Ex: 100.00;
- Valor permitido: máximo: “99999.00” e mínimo: “0.01”;
- Não pode conter espaço.
Lista de retornos possíveis
| Ação | Status code | Mensagem |
|---|---|---|
| Body correto | 200 | Preços alterados com sucesso. |
| Body com SKU não cadastrado | 204 | - |
| Body incorreto (sem SKU) | 400 | IdSkuLojista não informado |
| Body incorreto (sem preços DE ou POR) | 400 | Preço Padrão/ Oferta não informado |
| Body com preço excedendo a trava de 50 | 400 | Preço Oferta possui variação maior que 50% para bandeira EXTRA |
Response
Avaliamos o sucesso pelo HTTP Status Code que deverá ser 200 - OK
{
"mensagem": "Precos alterados com sucesso",
"httpStatus": "OK",
"violacoes": []
}
Clique aqui e veja o endpoint completo de PRD!_
Alteração de estoque
Esse serviço realiza a atualização de estoque de um determinado sku para um determinado lojista.
Método: PUT
Composição do Header:
- access_token: Chave de acesso da loja
- client_id: Chave de acesso da integradora
- Accept: application/json
- Content-Type: application/json
https://api-mktplace-hlg.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer/stock
https://api-mktplace.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer/stock
{
"idSkuLojista": "541sf6967981",
"estoque": {
"quantidade": 0,
"tempoDePreparacao": 0
}
}
Regras de negócio
- Campo "quantidade" = Quantidade de peças que será disponibilizada no front;
- Campo "tempoDePreparacao" = Crossdocking, ou seja, tempo de produção do produto (Este tempo é utilizado em cálculo de frete Envvias e tabela cadastrada no Via);
- Formato do campo "idSkuLojista": String;
- Formato dos campos "quantidade" e "tempoDePreparacao": Integer;
- É permitido passar apenas o campo “quantidade”;
- Não é permitido passar apenas o campo “tempoDePreparacao”;
- Quantidade máxima de estoque: “9999999” (7 dígitos). Para qualquer departamento/categoria (com exceção do departamento de "Móveis"), independentemente do tempo de preparo enviado, nós vamos considerar que é = 0;
- Tempo máximo de preparação: “200”.
ATENÇÃO
Nesta versão não realizamos subtração de reserva da quantidade enviada, então a quantidade passada no PUT /offer/stock, será a mesma quantidade disponibilizada no FRONT/ PAS.
Lista de retornos possíveis
| Ação | Status code | Mensagem |
|---|---|---|
| Body correto | 200 | Estoque alterado com sucesso. |
| Body com SKU não cadastrado | 400 | Nenhuma informação de estoque encontrada para idLojista e idSkuLojista passados. |
| Body incorreto (sem SKU) | 400 | IdSkuLojista não informado |
| Body incorreto (sem campo “quantidade”) | 400 | - |
Response
Avaliamos o sucesso pelo HTTP Status Code que deverá ser : 200 - OK
{
"mensagem": "Estoque alterado com sucesso.",
"httpStatus": "OK",
"violacoes": [],
"estoque": {
"quantidade": "0",
"tempoDePreparacao": "0"
}
}
Clique aqui e veja o endpoint completo!
Alteração de status
Esse serviço realiza a atualização de status de um determinado sku para um determinado lojista.
Método: PUT
Composição do Header:
- access_token: Chave de acesso da loja
- client_id: Chave de acesso da integradora
- Accept: application/json
- Content-Type: application/json
https://api-mktplace-hlg.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer/status
https://api-mktplace.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer/status
{
"idSkuLojista": "541sf6967981",
"status": [
{
"idSite": 2,
"status": "N"
},
{
"idSite": 3,
"status": "Y"
},
{
"idSite": 4,
"status": "Y"
}
]
}
Regras de negócio
- Campo "idSite" = Deve ser informado o código que representa cada bandeira 3 = Casas Bahia, 4 = Ponto Frio e 2= Extra (Não é permitido passar sigla);
- Campo "status" = Deve ser informado "N para Inativar item ou Y para Ativar item;
- Formato do campo "idSite": number;
- Formato do campo "status": string;
- É permitido passar status diferente para cada site (bandeira);
- É permitido passar o body por site ou para os 3 simultaneamente;
Lista de retornos possíveis
| Ação | Status code | Mensagem |
|---|---|---|
| Body correto | 200 | "Status alterado com sucesso." |
| Body com SKU não cadastrado | 400 | Nenhuma informação de estoque encontrada para idLojista e idSkuLojista passados. |
| Body com SKU inativado pelo Via | 400 | O Sku informado foi inativado pela Via. |
| Body incorreto (sem SKU) | 400 | IdSkuLojista não informado. |
| Body incorreto (sem campos “idSite | 400 | IdSite não informado. informado. |
| Body incorreto (sem campo “status” | 400 | Status não informado. |
Response
Avaliamos o sucesso pelo HTTP Status Code que deverá ser : 200 - OK
{
"mensagem": "Status alterado com sucesso.",
"httpStatus": "OK",
"violacoes": [],
"statusAlterados": [
{
"idSite": "2",
"status": "N"
},
{
"idSite": "3",
"status": "Y"
},
{
"idSite": "4",
"status": "Y"
}
],
"statusNaoAlterados": []
}
Clique aqui e veja o endpoint completo!_
Exclusão de produtos
É possível realizar a exclusão de produtos já cadastrados, mas antes de realizá-la, é necessário consultar os motivos disponiveis através do GET /delete/reasons, pois deverão ser utilizados como parâmetro no DELETE /offer Após utilizar o serviço de DELETE, deve-se acompanhar o status da solicitação através do GET /delete/statusVeja abaixo o detalhes de todos os endpoints disponíveis.
Consulta de motivos para exclusão
Esse serviço retorna os motivos disponíveis para solicitar exclusão através do DELETE /offer.
Método: PUT
Composição do Header:
- access_token: Chave de acesso da loja
- client_id: Chave de acesso da integradora
- Accept: application/json
- Content-Type: application/json
https://api-mktplace-hlg.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer/delete/reasons
https://api-mktplace.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer/delete/reasons
Lista de retornos possíveis
| Ação | Status code | Mensagem |
|---|---|---|
| URL correta | 200 | - |
Response
Avaliamos o sucesso pelo HTTP Status Code que deverá ser : 200 - OK
{
"valido": true,
"conteudo": [
{
"motivo": "Edição de produto"
},
{
"motivo": "Erro de integração"
},
{
"motivo": "Troca de integradora"
}
]
}
Clique aqui e veja o endpoint completo!
Consulta de status da solicitação de exclusão
Esse serviço retorna todas as solicitações de exclusão e seus respectivos status de validação realizadas através do DELETE /offer para o seller apontado no header (independentemente de quem as solicitou).
Método: GET
Composição do Header:
- access_token: Chave de acesso da loja
- client_id: Chave de acesso da integradora
- Accept: application/json
- Content-Type: application/json
Parâmetro:
Há algumas formas de consulta, então primeiro precisamos entender os parêmetros possíveis:
-
pagina = 1 (número da página desejada)
-
itensPorPagina = 50 (quantidade de SKUs que serão exibidos na página)
-
Query completa: ?pagina=1&itensPorPagina=50
Parâmetros opcionais:
- Consulta por SKU lojista: ?idSkuLojista=
- Consulta po página: ?pagina=1&itensPorPagina=50
- Consulta por ranged de data: ?pagina=1&itensPorPagina=50&dataInicial=[date-time]&dataFinal=[date-time]
https://api-mktplace-hlg.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer/delete/status
https://api-mktplace.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer/delete/status
Regras de negócio
- Retornamos o histórico de exclusão somente dos últimos 90 dias;
Lista de retornos possíveis
| Ação | Status code | Mensagem |
|---|---|---|
| URL correta | 200 | - |
| SKU sem solicitação de exclusão | 204 | - |
| Parâmetro incorreto | 400 | - |
Response
Avaliamos o sucesso pelo HTTP Status Code que deverá ser : 200 - OK
{
"valido": true,
"conteudo": {
"paginacao": {
"totalDePaginas": 7,
"totalDeElementos": 63,
"temProxima": true,
"primeiraPagina": true,
"ultimaPagina": false,
"numero": 0,
"tamanho": 10
},
"dados": [
{
"motivo": "Troca de integradora",
"idSkuLojista": "willychinelo",
"status": "EXCLUIDO",
"dataEnvioMensagem": "2022-10-11T00:10:00.891",
"dataConsumoMensagem": "2022-10-11T00:10:01.736"
},
{
"motivo": "Troca de integradora",
"idSkuLojista": "Qa0904212sku404",
"status": "EXCLUIDO",
"dataEnvioMensagem": "2022-10-11T00:16:17.724",
"dataConsumoMensagem": "2022-10-11T00:16:18.175"
},
{
"motivo": "Erro de integração",
"idSkuLojista": "20945531",
"status": "EXCLUIDO",
"dataEnvioMensagem": "2022-10-11T00:16:43.112",
"dataConsumoMensagem": "2022-10-11T00:16:44"
},
{
"motivo": "Erro de integração",
"idSkuLojista": "20945531",
"status": "NAO_EXCLUIDO",
"mensagemErro": "Não foi encontrado nenhum registro para o idLojista: 3 e idSkuLojista: 20945531",
"dataEnvioMensagem": "2022-10-11T00:17:38.581",
"dataConsumoMensagem": "2022-10-11T00:17:37.862"
},
{
"motivo": "Erro de integração",
"idSkuLojista": "20945531",
"status": "NAO_EXCLUIDO",
"mensagemErro": "Não foi encontrado nenhum registro para o idLojista: 3 e idSkuLojista: 20945531",
"dataEnvioMensagem": "2022-10-11T00:17:44.299",
"dataConsumoMensagem": "2022-10-11T00:17:44.352"
},
{
"motivo": "Erro de integração",
"idSkuLojista": "20945531",
"status": "NAO_EXCLUIDO",
"mensagemErro": "Não foi encontrado nenhum registro para o idLojista: 3 e idSkuLojista: 20945531",
"dataEnvioMensagem": "2022-10-11T00:18:36.171",
"dataConsumoMensagem": "2022-10-11T00:18:35.490"
},
{
"motivo": "Troca de integradora",
"idSkuLojista": "20945531",
"status": "NAO_EXCLUIDO",
"mensagemErro": "Não foi encontrado nenhum registro para o idLojista: 3 e idSkuLojista: 20945531",
"dataEnvioMensagem": "2022-10-11T00:19:06.368",
"dataConsumoMensagem": "2022-10-11T00:19:06.412"
},
{
"motivo": "Troca de integradora",
"idSkuLojista": "20945531",
"status": "NAO_EXCLUIDO",
"mensagemErro": "Não foi encontrado nenhum registro para o idLojista: 3 e idSkuLojista: 20945531",
"dataEnvioMensagem": "2022-10-11T00:19:07.871",
"dataConsumoMensagem": "2022-10-11T00:19:08.631"
},
{
"motivo": "Erro de integração",
"idSkuLojista": "Qa0904212sku146",
"status": "EXCLUIDO",
"dataEnvioMensagem": "2022-10-11T00:25:27.359",
"dataConsumoMensagem": "2022-10-11T00:25:28.418"
},
{
"motivo": "Troca de integradora",
"idSkuLojista": "Qa0904212sku404",
"status": "NAO_EXCLUIDO",
"mensagemErro": "Não foi encontrado nenhum registro para o idLojista: 3 e idSkuLojista: Qa0904212sku404",
"dataEnvioMensagem": "2022-10-12T23:38:49.181",
"dataConsumoMensagem": "2022-10-12T23:38:49.788"
}
]
},
"codigo": "200 OK",
"status": "OK",
"timestamp": "2023-01-19T19:42:37.176+0000"
}
Clique aqui e veja o endpoint completo!
Solicitar exclusão de produto
Este serviço realiza a solicitação de exclusão de determinado(s) SKU(s) que pode ou não ser aceita. Lembrando que:
-
É necessário verificar os motivos de exclusão disponíveis através do GET /delete/reasons.
-
Após solicitação de exclusão, é necessário acompanhar o status através do GET /delete/status.
Método: GET
Método: DELETE
Composição do Header:
- access_token: Chave de acesso da loja
- client_id: Chave de acesso da integradora
- Accept: application/json
- Content-Type: application/json
Parâmetros:
Para realizar a solicitação de exclusão, há dois parâmetros obrigatórios, que são:
- motivo = (Deve ser consultado através do GET /reasons)
- idSkuLojista = (Código do SKU lojista que deverá ser excluído. Aqui pode ser informado até 100 SKUs separados por vírgula. Ex: SKU123,SKU456,SKU789)
https://api-mktplace-hlg.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer
https://api-mktplace.viavarejo.com.br/api/v4/api-front-offer-v4/jersey/offer
Regras de negócio
- Limite de 100 SKUs por chamada;
- Todos os SKUs devem ser separados por vírgula. Ex: ?motivo=Edição de produto&idSkuLojista=SKU1,SKU2,SKU3;
- O tempo para replicar a exclusão varia de acordo com a quantidade de SKUs solicitados;
- Não é possível excluir SKUs com pedido em andamento (caso haja SKUs com pedidos pendentes na lista, a exclusão NÃO será realizada)_;
- Acompanhe o processamento através do GET /delete/status.
Lista de retornos possíveis
| Ação | Status code | Mensagem |
|---|---|---|
| Solicitação enviada com sucesso | 200 | - |
| SKU inválido ou inexistente | 400 | idSkuLojista não pode ser vazio ou nulo. |
Response
Avaliamos o sucesso pelo HTTP Status Code que deverá ser : 200 - OK
Clique aqui e veja o endpoint completo!
Edição de Produtos (Peso e Dimensões)
Lançamos em nossa API de gestão de ofertas um novo serviço que possibilita à loja realizar edições nas informações de peso e dimensões de produtos que NÃO estão vinculados a ofertas de terceiros (match). Essa funcionalidade permite a edição exclusivamente para produtos que pertencem ao catálogo exclusivo da loja, proporcionando maior flexibilidade e controle sobre as informações de produtos.
Funcionalidades disponíveis:
- Edição unitária de produtos;
- Edição massiva de produtos.
https://api-mktplace-hlg.viavarejo.com.br/api/v4
https://api-mktplace.viavarejo.com.br/api/v4
Edição unitária
Método: PUT
Composição do Header:
- access_token: Chave de acesso da loja
- client_id: Chave de acesso da integradora
- Accept: application/json
- Content-Type: application/json
/api/v4/api-front-products-v4/jersey/product/atualizacao/dimensoes/{{skuLojista}}
Requisição
{
"altura": "1.1",
"largura": "1.1",
"profundidade": "1.1",
"peso": "1.1"
}
Resposta
| Descrição | Status_code |
|---|---|
| Produto editado com sucesso | 200 |
{
"valido": true,
"motivos": null,
"conteudo": {
"peso": 1.1,
"altura": 1.1,
"largura": 1.1,
"profundidade": 1.1
},
"codigo": "200 OK",
"mensagem": null,
"motivosTecnicos": null,
"status": "OK",
"timestamp": "2024-01-15T17:15:56.151357191Z",
"arquivo": null
}
Edição massiva
Método: PUT
Composição do Header:
- access_token: Chave de acesso da loja
- client_id: Chave de acesso da integradora
- Accept: application/json
- Content-Type: application/json
/api/v4/api-front-products-v4/jersey/product/atualizacao/dimensoes/massivo
Requisição
[
{
"idSkuLojista": "-1753845512",
"dimension": {
"altura": "1.2",
"largura": "1.1",
"profundidade": "1.1",
"peso": "1.1"
}
}
]
Resposta
| Descrição | Status_code |
|---|---|
| Produto editado com sucesso | 200 |
{
"valido": true,
"motivos": null,
"conteudo": [
{
"idSkuLojista": "-1753845512",
"processado": true
}
],
"codigo": null,
"mensagem": null,
"motivosTecnicos": null,
"status": null,
"timestamp": null,
"arquivo": null
}
Para a edição massiva é preciso levar em consideração que existe um limite de 28 requisições com 20 SKU's por segundo.
