Skip to content
ExtensionsStorefronts
extensions / Commerce extension
POST/__runtime/products/search

Search storefront products

Searches the products and pages of a project for the storefront search UI and returns matching products plus page results.

POST

Authentication

Requirement
Not specified
Credential type
Not specified
Scopes
Not specified

Permissions

  • Requires the commerce products extension to be enabled for the project.

Headers

No header metadata is available for this operation.

Path Parameters

This operation has no path parameters.

Query Parameters

This operation does not accept query parameters.

Request Body

Schema: RuntimeProductsRequest

FieldRequiredTypeDetails
project_idYesinteger
Description: Target project identifier.
extension_idNointeger
Description: Target extension identifier.
pageNointeger
Description: Page number. Defaults to 1.
Range: min 1
page_sizeNointeger
Description: Number of products returned per page. Product listing/search requests are clamped by the product API.
Range: min 1, max 200
page_items_limitNointeger
Description: Maximum number of matching page results returned with product search results.
Range: min 1
qNostring
Description: Search text used by this operation.
sortNostring
Description: Product sort field. Unknown values fall back to position.
Allowed values: positionnameproduct_namepricebrand
directionNostring
Description: Sort direction. Defaults to descending for position and ascending for other product fields.
Allowed values: ascascendingdescdescending
filtersNoobject<string,array<string>>
Description: Filter map keyed by product attribute code. Use system keys for category/price filters, or replace an attribute key with a real product attribute code such as color, size, or brand.
Object shape: category array<string>category_slug array<string>price array<number|string>price__min array<number|string>price__max array<number|string>color array<string> example attribute keysize array<string> example attribute key
pathNostring
Description: Current storefront path. Category pages can infer category filters from this path.
queryNostring
Description: Original storefront query string used to preserve pagination/filter URLs.

Response Body

Example 200 response

json
{
  "items": [],
  "page_items": [],
  "page_total": 1,
  "total": 1,
  "page": 1,
  "page_size": 1,
  "total_pages": 1
}

Errors

400 BAD_REQUEST404 NOT_FOUND500 INTERNAL_SERVER_ERROR

Availability

Available in
v0.1.0
Available since
v0.1.0
Implementation
Available
Deprecation
Not specified
Rate limits
Not specified