Skip to main content
GET
/
products-by-name
Buscar Produtos por Nome
curl --request GET \
  --url https://mia-gateway.morada.ai/products-by-name \
  --header 'x-morada-api-key: <api-key>'
{
  "term": "\"imovel teste\"",
  "products": [
    {
      "id": "84320188-1452-4fe8-900e-3bca9d46fb6c",
      "name": "[21] imovel teste",
      "description": "teste",
      "similarityScore": 1
    }
  ],
  "pagination": {
    "page": 1,
    "size": 10,
    "totalItems": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}

Authorizations

​
x-morada-api-key
string
header
required

Chave de API do parceiro. Fornecida pelo time da Morada.ai.

Query Parameters

​
term
string
required

Termo de busca para o nome do produto (fuzzy search)

​
page
integer
default:1

Numero da pagina (opcional, padrao: 1)

Required range: x >= 1
​
size
integer
default:10

Quantidade de itens por pagina (opcional, padrao: 10)

Required range: x >= 1

Response

200 - application/json

Busca realizada com sucesso

​
term
string

Termo utilizado na busca

​
products
object[]

Lista de produtos encontrados

​
pagination
object