Search

post

https://{yourapiurl}/api/v1/search

Searches for entities based on the provided search request.
Supports Product, ProductVariant, Category, and Trademark entity types.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The search request containing searchKey and entityType.

Represents a unified search request across supported entity types.

searchKey

string | null

required

Gets or sets the keyword used for search.
This field is required for the Search endpoint.

entityTypes

array of objects | null

required

Gets or sets the entity types to include in the search.
This field is required for the Search endpoint.

entityTypes*

Allowed:

clientId

string | null

required

Gets or sets the client identifier for the requesting application.

appKey

string | null

required

Gets or sets the application key used for authentication.

pageIndex

int32 | int32 | null

^-?(?:0|[1-9]\d*)$

Gets or sets the zero-based page index.

pageSize

int32 | int32 | null

^-?(?:0|[1-9]\d*)$

Gets or sets the number of items per page.

sorting

string | null

Gets or sets the sorting expression.

threadId

string | null

Gets or sets the trace identifier used for request logging.

status

array of objects | null

Gets or sets the status values used to filter results.

status

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

URL

Loading…

Response

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

text/plain

application/json

text/json

200The search results.