Pular para o conteúdo principal

Produtos Similares

Visão Geral

O endpoint /api/v1/products/protected/similar retorna uma lista de produtos similares com base em um ID de produto fornecido.

Informações da Requisição

Método HTTP

POST

URL

https://catalog.api.fashionai.dev/api/v1/products/protected/similar

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonDefine o formato do corpo da requisição
acceptapplication/jsonDefine o formato esperado da resposta
X-FashionAI-APP-Token{token}Token de autenticação da aplicação

Corpo da Requisição

Estrutura

{
"userId": "",
"sessionId": "123",
"data": {
"id": "979935"
}
}

Parâmetros

CampoTipoObrigatórioDescrição
userIdstring | nullNãoIdentificador do usuário (opcional)
sessionIdstringSimIdentificador único da sessão
dataSimilarDataSimObjeto contendo os dados da requisição

SimilarData

CampoTipoObrigatórioDescrição
idstringSimID do produto para o qual buscar produtos similares

Resposta

Estrutura

{
"products": ["product_id_1", "product_id_2", "product_id_3"]
}

Parâmetros

CampoTipoDescrição
productsstring[]Array contendo os IDs dos produtos similares

Exemplos

cURL Request

curl -X 'POST' \
'https://catalog.api.fashionai.dev/api/v1/products/protected/similar' \
-H 'accept: application/json' \
-H 'X-FashionAI-APP-Token: YOUR_TOKEN_HERE' \
-H 'Content-Type: application/json' \
-d '{
"userId": "",
"sessionId": "123",
"data": {
"id": "979935"
}
}'

Códigos de Status HTTP

CódigoDescrição
200Sucesso. Retorna a lista de produtos similares
400Erro na validação da requisição (parâmetros inválidos ou faltando)
401Não autorizado. Token inválido ou expirado
404Produto não encontrado
500Erro interno do servidor

Validações

  • sessionId: Campo obrigatório, deve ser uma string não vazia
  • data.id: Campo obrigatório, deve ser uma string não vazia representando um ID válido de produto
  • userId: Opcional, pode ser null ou uma string
  • X-FashionAI-APP-Token: Token obrigatório para autenticação

Notas Importantes

  • A resposta contém apenas os IDs dos produtos similares, não os dados completos dos produtos