Search Products

POST

/store/products/search

Store API/ProductsProducts

Run a search query on products using the search service installed on the Medusa backend. The searching is handled through the search service, so the returned data's format depends on the search service you're using.

Request

Body Params application/json

string

optional

The search query.

offset

number

optional

The number of products to skip when retrieving the products.

limit

number

optional

Limit the number of products returned.

filter

string

optional

Example

{
    "q": "string",
    "offset": 0,
    "limit": 0,
    "filter": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/store/products/search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "q": "string",
    "offset": 0,
    "limit": 0,
    "filter": "string"
}'

Responses

🟢200OK

application/json

Body

The list of search results.

hits

array[string]

required

Array of search results. The format of the items depends on the search engine installed on the Medusa backend.

Example

{
    "hits": [
        "string"
    ]
}

🟠400Client Error or Multiple Errors

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2024-05-23 07:10:14

Create a Payment Session

List Products