getProductsPriceByPageUrl

Search information about products and prices for selected category

Products.getProductsPriceByPageUrl(url, userQuery)

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

Schema

url:* string
Page url
example: catalog

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

userQuery: IProductsQuery
Optional set query parameters

userQuery.offset: number
Optional parameter for pagination, default is 0
example: 0

userQuery.limit: number
Optional parameter for pagination, default is 30
example: 30

userQuery.statusMarker: string
Optional identifier of the product page status
example: waiting

userQuery.conditionValue: string
Optional value that is being searched
example: 1

userQuery.conditionMarker: string
Optional identifier of the filter condition by which values are filtered
example: mth

userQuery.attributeMarker: string
Optional text identifier of the indexed attribute by which values are filtered
example: price

userQuery.sortOrder: string
Optional sorting order DESC | ASC
example: DESC

userQuery.sortKey: string
Optional field to sort by (id, title, date, price, position, status)
example: id

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 return:

{
  "total": 100,
  "items": [
    {
      "id": 1764,
      "price": 0
    }
  ]
}

Schema

total: number
total number of found records
example: 100

id: number
object identifier
example: 1764

price: number
price value of the product page taken from the index
example: 0