> For the complete documentation index, see [llms.txt](https://desenvolvedores.skyhub.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://desenvolvedores.skyhub.com.br/produtos/outros-recursos-de-produtos/consulta-url/url-produtos.md). # URL Produtos 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' ``` #### Response esperado: {% hint style="success" %} 200 - Success \[OK] {% endhint %} ``` { "sku": "SKU_02", "channels": [ { "name": "Lojas Americanas", "href": "https://www.americanas.com.br/produto/6785367853?sellerId=34567899879879" }, { "name": "Submarino", "href": "https://www.submarino.com.br/produto/6785367853?sellerId=34567899879879" }, { "name": "Shoptime", "href": "https://www.shoptime.com.br/produto/6785367853?sellerId=34567899879879" } ], "variations": [] } ``` ### Como consultar a URL de todos os produtos 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](#request-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: {% hint style="success" %} 200 - Success \[OK]: Haverá um response body listando os SKUs e suas respectivas URLs: {% endhint %} ``` { "products": [ { "sku": "SKU_01", "channels": [], "variations": [ { "sku": "SKU_01A", "channels": [ { "name": "Lojas Americanas", "href": "https://www.americanas.com.br/produto/4567845678?sellerId=34567899879879" }, { "name": "Submarino", "href": "https://www.submarino.com.br/produto/4567845678?sellerId=34567899879879" }, { "name": "Shoptime", "href": "https://www.shoptime.com.br/produto/4567845678?sellerId=34567899879879" } ] }, { "sku": "SKU_01B", "channels": [ { "name": "Lojas Americanas", "href": "https://www.americanas.com.br/produto/4567845678?sellerId=34567899879879" }, { "name": "Submarino", "href": "https://www.submarino.com.br/produto/4567845678?sellerId=34567899879879" }, { "name": "Shoptime", "href": "https://www.shoptime.com.br/produto/4567845678?sellerId=34567899879879" } ] }, { "sku": "SKU_01C", "channels": [ { "name": "Lojas Americanas", "href": "https://www.americanas.com.br/produto/4567845678?sellerId=34567899879879" }, { "name": "Submarino", "href": "https://www.submarino.com.br/produto/4567845678?sellerId=34567899879879" }, { "name": "Shoptime", "href": "https://www.shoptime.com.br/produto/4567845678?sellerId=34567899879879" } ] } ] }, { "sku": "SKU_02", "channels": [ { "name": "Lojas Americanas", "href": "https://www.americanas.com.br/produto/6785367853?sellerId=34567899879879" }, { "name": "Submarino", "href": "https://www.submarino.com.br/produto/6785367853?sellerId=34567899879879" }, { "name": "Shoptime", "href": "https://www.shoptime.com.br/produto/6785367853?sellerId=34567899879879" } ], "variations": [] } ], "scroll_id": "cXVlcnlUa............wOw==" } ``` {% hint style="warning" %} 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**. {% endhint %} ### 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: ``` { "products": [ (...) ], "scroll_id": "cXVlcnlUa............wOw==" } ``` 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: ``` https://api.skyhub.com.br/urls/products?channels[]={marca/canal} ``` #### Example request: 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: {% hint style="success" %} 200 - Success \[OK]: No retorno para a consulta acima serão visualizadas as URLs das Lojas Americanas para os SKUs da conta: {% endhint %} ``` { "products": [ { "sku": "SKU_01", "channels": [], "variations": [ { "sku": "SKU_01A", "channels": [ { "name": "Lojas Americanas", "href": "https://www.americanas.com.br/produto/4567845678?sellerId=34567899879879" } ] }, { "sku": "SKU_01B", "channels": [ { "name": "Lojas Americanas", "href": "https://www.americanas.com.br/produto/4567845678?sellerId=34567899879879" } ] }, { "sku": "SKU_01C", "channels": [ { "name": "Lojas Americanas", "href": "https://www.americanas.com.br/produto/4567845678?sellerId=34567899879879" } ] }, ] }, { "sku": "SKU_02", "channels": [ { "name": "Lojas Americanas", "href": "https://www.americanas.com.br/produto/6785367853?sellerId=34567899879879" } ], "variations": [] } ], "scroll_id": "cXVlcnlUaGVu.............wOw==" } ``` {% hint style="info" %} Também é possível aplicar o filtro por marca/canal de venda na consulta individual por SKU, como exemplo a seguir: `https://api.skyhub.com.br/urls/products/{SKU}?channels[]=Lojas Americanas` {% endhint %}