Search product with text expression for search and autocomplete

get

https://example.com/v2/shop/autocomplete

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

currency

string

input

string

Search is based on the following fields : brand, product id, product sku, product external id, product name, product description, variant name, variant sku, variant description, variant ean, variant mpn, variant external id, attribute values, custom field values

locale

string

required

productTags

array of strings

productTags

aggregation

string

enum

Allowed:

sort

string

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Format: property:direction (recommended) or property,direction (kept for backward compatibility).

page

integer

≥ 0

Defaults to 0

Zero-based page index (0..N)

size

integer

≥ 1

Defaults to 20

The size of the page to be returned

Headers

dj-client

string

enum

required

Specifies the client type making the request.

OPERATOR: Platform operator user.
ACCOUNT: Customer account user.
SUPPLIER: Supplier managing orders.

Allowed:

dj-api-key

string

required

API key required for authentication. Must be valid and linked to the requesting user.

dj-store

string

(Optional) Store ID in multi-store environments.

dj-store-view

string

(Optional) Store view ID in multi-store environments.

customer-account-id

string

(Optional) Customer account ID in multi-account customer user.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Products retrieve with success