Para aplicar filtros por produtos com queries específicas é necessário utilizar a URL base disponibilizada a seguir:
http://api.skyhub.com.br/products
Request headers:
Key
Value
Através da URL e dos headers informados é possível realizar os filtros por:
Status;
Nome;
Quantidade em estoque;
Campos específicos no retorno.
Como filtrar por status
É possível realizar a listagem de produtos através de seus status, onde deverá ser informada a query ?filters[status]= no endpoint /products, referenciando o status a ser consultado, conforme exemplo a seguir:
https://api.skyhub.com.br/products?filters[status]={enabled
ou disabled}
Ao informar o parâmetro ?filters[status]=enabled serão retornados todos os produtos ativos (enabled); caso selecione o parâmetro ?filters[status]=disabled serão retornados os produtos inativos (disabled).
Example request:
Segue um exemplo de requisição para listagem de produtos com status disabled:
curl --location -g --request GET 'https://api.skyhub.com.br/products?filters[status]=disabled' \
--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 visualizados todos os SKUs da conta que possuírem o status disabled como vemos a seguir:
Para realizar a listagem de produtos através de um nome específico deverá ser informada a query ?filters[name]= no endpoint /products, referenciando o nome a ser consultado, conforme exemplo a seguir:
Segue um exemplo de requisição para listagem de SKUs com o termo "produto" no título:
curl --location -g --request GET 'https://api.skyhub.com.br/products?filters[name]=produto' \
--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 visualizados todos os SKUs da conta que possuírem no campo name a string "produto" como vemos a seguir:
O filtro por quantidade (qty) permite a consulta de produtos com determinados estoques, sendo:
Consulta de produtos com quantidade em estoque maior ou igual ao valor especificado
Para realizar a listagem de produtos cujo estoque seja maior ou igual a um valor definido na busca deverá ser informada a query ?filters[qty_from]= no endpoint /products, referenciando a quantidade desejada, conforme exemplo a seguir:
Segue um exemplo de requisição para listagem de produtos com estoque maior ou igual a 50 unidades:
curl --location -g --request GET 'https://api.skyhub.com.br/products?filters[qty_from]=50' \
--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 visualizados todos os SKUs da conta que possuírem o valor maior ou igual a 50 unidades no campo qty, como vemos a seguir:
Consulta de produtos com quantidade em estoque menor ou igual ao valor especificado
Para realizar a listagem de produtos cujo estoque seja menor ou igual a um valor definido na busca deverá ser informada a query ?filters[qty_to]= no endpoint /products referenciando a quantidade desejada, conforme exemplo a seguir:
Segue um exemplo de requisição para listagem de produtos com estoque menor ou igual a 50 unidades:
curl --location -g --request GET 'https://api.skyhub.com.br/products?filters[qty_to]=50' \
--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 visualizados todos os SKUs da conta que possuírem o valor menor ou igual a 50 unidades para o campo qty, como vemos a seguir:
É possível combinar os parâmetros filters[qty_from] e filters[qty_to] para listar produtos cujos estoques se encontram dentro de uma faixa específica, por exemplo:
Desejo consultar apenas os SKUs que possuem estoque entre 5 e 10 unidades: Para isso basta adicionar ao GET no endpoint /products o filtro ?filters[qty_from]=5&filters[qty_to]=10;
Desejo consultar apenas os produtos que possuem 5 unidades em estoque: Para essa listagem basta incluir na pesquisa o ?filters[qty_from]=5&filters[qty_to]=5.
Como consultar campos específicos
Na estrutura de um produto são definidos diversos campos, como SKU, imagens, EAN, entre outros.
Através da API é possível restringir a consulta para que o retorno mostre apenas determinados atributos. Para isto, deverá ser informada a query ?only[]= no endpoint /products referenciando o atributo que deseja visualizar, conforme descrito a seguir:
Segue um exemplo de requisição para listagem de todos os produtos, filtrando no retorno apenas os campos SKU, imagem e custo:
curl --location -g --request GET 'https://api.skyhub.com.br/products?only[]=sku&only[]=images&only[]=cost' \
--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 visualizados os campos sku, images e cost de todos os produtos da conta, como vemos a seguir:
