Nesta guia é apresentada a consulta da URL de produtos específicos e de todos os produtos conectados
Uma vez ativo e conectado ao marketplace, é possível consultar via API a URL para o anúncio gerado para aquele SKU, assim como também é possível listar as URLs de todos os produtos da conta que foram conectados ao marketplace sem pendências e encontram-se ativos para venda.
GET - Consultando a URL de um produto
Para realizar a consulta da URL de um SKU deve-se utilizar o método GET, preenchendo os devidos headers, no endpoint abaixo:
https://api.skyhub.com.br/urls/products/{SKU}
Request headers:
Key
Value
X-User-Email
email_de_usuario
X-Api-Key
token_de_integracao de sua conta SkyHub
X-Accountmanager-Key
token_account único de cada Plataforma/ERP
Accept
application/json
Content-Type
application/json
Example request:
curl --location -g --request GET 'https://api.skyhub.com.br/urls/products/{SKU}' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Para realizar a consulta de todas as URLs da conta basta encaminhar via API uma requisição contendo o método GET no endpoint visto a seguir, utilizando os headers informados acima:
https://api.skyhub.com.br/urls/products
Example request:
curl --location --request GET 'https://api.skyhub.com.br/urls/products' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response esperado:
200 - Success [OK]: Haverá um response body listando os SKUs e suas respectivas URLs:
Na consulta geral serão apresentados os 100 primeiros produtos da lista; caso a conta possua mais itens anunciados, será necessário realizar a paginação através do scroll_id.
Como paginar a consulta da URL
Caso a conta tenha mais que 100 produtos, será necessário fazer a paginação através do scroll_id, que deve ser inserido no endpoint em forma de query string.
Como montar a query:
Ao realizar o GET no /urls/products, ao final da consulta será apresentado o campo scroll_id, como visualizado a seguir:
Ao localizar o scroll_id, basta inseri-lo como parâmetro no endpoint para que seja possível acessar a próxima página de resultados. Abaixo temos um exemplo de utilização da paginação:
Example request:
curl --location --request GET 'https://api.skyhub.com.br/urls/products?scroll_id=cXVlcnlUa............wOw==' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
A cada página o valor para o scroll_id será alterado até que chegue na última, quando a requisição retornará sucesso, porém trará um array vazio e não mostrará mais o scroll_id:
Response:
{
"products": []
}
Filtros a serem aplicados
Há a possibilidade de aplicar filtros de acordo com as marcas que constituem o marketplace Americanas, a fim de realizar a listagem das URLs a partir dos valores Lojas Americanas, Shoptime ou Submarino.
Para a aplicação do filtro, deve-se incluir a query ?channels[]= no endpoint de consulta:
O exemplo disponibilizado a seguir utiliza o canal Lojas Americanas para aplicação do filtro:
curl --location -g --request GET 'https://api.skyhub.com.br/urls/products?channels[]=Lojas Americanas' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response esperado:
200 - Success [OK]: No retorno para a consulta acima serão visualizadas as URLs das Lojas Americanas para os SKUs da conta:
