Busca Global de Entidades
/entities/search
Realiza uma busca textual cruzada entre differentes módulos da plataforma (produtos, clientes, pedidos).
Descrição
Este endpoint é uma ferramenta de pesquisa centralizada projetada para facilitar a localização rápida de informações em diferentes domínios da plataforma.
Ele permite que o integrador realize buscas simultâneas por produtos, clientes ou pedidos que correspondam a um termo comum.
Ao invés de realizar múltiplas requisições para endpoints específicos, esta rota processa a busca de forma sequencial através das entidades solicitadas no parâmetro entities.
O sistema respeita um limite global de resultados, distribuindo os registros encontrados entre as entidades.
É ideal para implementações de barras de busca administrativas que precisam de um contexto rápido sobre um termo de interesse.
O acesso a este recurso requer que o usuário esteja autenticado no ambiente administrativo com um token válido através do middleware UserAuth.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
| Content-Type | application/json | Tipo de conteúdo |
| Authorization | Bearer {userToken} | Token de autenticação |
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| term | string | ✅ | Termo de pesquisa (Ex: Nome, SKU, E-mail, ID) |
| limit | integer | ✅ | Limite máximo de registros na resposta (1 a 100) |
| entities | array | ✅ | Lista de entidades para buscar (product, customer, orderGroup) |
Exemplo de Requisição
1curl --request GET \2 --url https://sua-loja-uappi.com.br/api/v3/entities/search?term=uappi&limit=10&entities[]=product&entities[]=customer \3 --header "Authorization: Bearer SEU_TOKEN_AQUI"✅ Resposta de Sucesso
HTTP Status: 200 OK
1[2 {3 "id": 123,4 "name": "Produto Uappi Especial",5 "type": "product"6 },7 {8 "id": 456,9 "name": "Cliente João Uappi",10 "type": "customer"11 }12]