getProductsPriceByPageUrl

Search information about products and prices for selected category.

Products?.getProductsPriceByPageUrl( url?, userQuery? );

Minimal example

const value = await Products.getProductsPriceByPageUrl('catalog')

Schema

url: string
Page url
example: "23-laminat-floorwood-maxima"

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 information about products and prices for the selected 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": [
    {
      "id": 2957,
      "price": 150
    },
    {
      "id": 2954,
      "price": 50
    },
    {
      "id": 2955,
      "price": 0
    }
  ],
  "total": 3
}

Schema

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

items: IProductInfo[]
An array of product information objects.
example:

[
  {
    "id": 12345,
    "price": 150
  },
  {
    "id": 67890,
    "price": 200
  }
]

---