Skip to content
docs
Guides
ES
CatalogProducts
catalog:read

Suggest products

Returns product and variant suggestions matching a name, SKU or barcode.

GET/v1/catalog/products/suggest

Returns product and variant suggestions matching a name, SKU or barcode.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

search*string

Free-text filter. Which fields it covers depends on the resource.

limit*integer

Maximum number of results to return.

Formatint32

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalog/products/suggest?search=polo&limit=1" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
[  {    "productId": "7204558912004325301",    "variantId": "7204558912004325301",    "name": "Example resource",    "slug": "example-resource",    "sku": "SKU-001",    "ean": "example",    "variantName": "Example resource",    "unitPrice": 1,    "imageUrl": "https://example.com/resource"  }]