Skip to main content

getProductsEmptyPage

Search all product objects with pagination that do not have a category.

Products?.getProductsEmptyPage( langCode?, userQuery? );

Minimal example

const value = await Products.getProductsEmptyPage('en_US', userQuery)
Schema

langCode: string
Language code. Default: "en_US"
example: "en_US"

userQuery: IProductsQuery
Optional set query parameters

offset(required): number
Parameter for pagination. Default: 0.

limit(required): number
Parameter for pagination. Default: 30.

sortOrder(required): string
Sort order "DESC" | "ASC". Default: "DESC".

sortKey(required): string
Field for sorting (default - null). Possible values: "id", "position", "title", "date", "price". Default: null.

templateMarker: string | null
Product page template marker, default null.
example: "template_12345"

statusMarker: string | null
Product page status marker, default null.
example: "in_stock"

conditionValue: string | null
The value that is being searched for, default null.
example: "new"

attributeMarker: string | null
The text identifier of the indexed attribute by which values are filtered, default null.
example: "color"

conditionMarker: string | null
Marker of the filter condition by which the values are filtered, default null.
example: "equals"

This method searches for product page objects with pagination that do not have a category, based on the provided query parameters (userQuery). It returns a Promise that resolves to an array of items, where each item is a object.

Example response

{
"items": [],
"total": 0
}
Schema

total: number
The total number of products found.
example: 100

items: IProductsEntity[]
An array of product entities.
example:

[
{
"id": 12345,
"title": "Product 1"
},
{
"id": 67890,
"title": "Product 2"
}
]