Pular para o conteúdo principal

Mais Vendidos

Visão Geral

O endpoint /api/v1/products/protected/sales-ranking retorna uma lista ranqueada dos produtos mais vendidos. Pode ser filtrado por categoria — sem categoryId, retorna o ranking geral de todas as categorias.

Informações da Requisição

Método HTTP

GET

URL

https://catalog.api.fashionai.dev/api/v1/products/protected/sales-ranking

Headers Obrigatórios

HeaderValorDescrição
X-FashionAI-APP-Token{token}Token de autenticação da aplicação

Parâmetros de Query

ParâmetroTipoObrigatórioDescrição
categoryIdstringNãoID da categoria para filtrar o ranking. Se omitido, retorna o ranking geral

Resposta (200)

Estrutura

Com categoria:

{
"categoryId": "2020602",
"products": ["49373", "12345", "67890"]
}

Sem categoria (ranking geral):

{
"categoryId": null,
"products": ["101905", "40749", "8988"]
}

Parâmetros

CampoTipoDescrição
categoryIdstring | nullID da categoria usada no filtro, ou null para o ranking geral
productsstring[]Array ordenado com os IDs dos produtos mais vendidos (do mais vendido ao menos vendido)

Exemplos

cURL — Ranking Geral

curl -X 'GET' \
'https://catalog.api.fashionai.dev/api/v1/products/protected/sales-ranking' \
-H 'accept: application/json' \
-H 'X-FashionAI-APP-Token: YOUR_TOKEN_HERE'

cURL — Ranking por Categoria

curl -X 'GET' \
'https://catalog.api.fashionai.dev/api/v1/products/protected/sales-ranking?categoryId=2020602' \
-H 'accept: application/json' \
-H 'X-FashionAI-APP-Token: YOUR_TOKEN_HERE'

Códigos de Status HTTP

CódigoDescrição
200Sucesso. Retorna o ranking de mais vendidos
401Não autorizado. Token inválido ou expirado
500Erro interno do servidor

Notas Importantes

  • O array products está ordenado do mais vendido para o menos vendido
  • Este é um endpoint protegido e requer autenticação via X-FashionAI-APP-Token