getProductsPriceByPageUrl

Ищите информацию о продуктах и ценах для выбранной категории.

Описание

Этот метод ищет информацию о продуктах и ценах для выбранной категории на основе предоставленных параметров запроса (userQuery). Он возвращает Promise, который разрешается в объект IProductsInfo.

Products.getProductsPriceByPageUrl( url, langCode, userQuery );

Схема параметров

Схема

url: string
URL страницы
пример: "23-laminat-floorwood-maxima"

langCode: string
Код языка. По умолчанию: "en_US"
пример: "en_US"

userQuery: IProductsQuery
Необязательные параметры запроса
пример:

{
  "limit": 30,
  "offset": 0,
  "sortOrder": "DESC",
  "sortKey": "id",
  "statusId": 123,
  "statusMarker": "in_stock",
  "conditionValue": "new",
  "conditionMarker": "equals",
  "attributeMarker": "color"
}

userQuery.offset(обязательный): number
Параметр для постраничной навигации. По умолчанию: 0.

userQuery.limit(обязательный): number
Параметр для постраничной навигации. По умолчанию: 30.

userQuery.sortOrder(обязательный): string
Порядок сортировки "DESC" | "ASC". По умолчанию: "DESC".

userQuery.sortKey(обязательный): string
Поле для сортировки (по умолчанию - null). Возможные значения: "id", "position", "title", "date", "price". По умолчанию: null.

userQuery.templateMarker: string | null
Маркер шаблона страницы продукта, по умолчанию null.
пример: "template_12345"

userQuery.statusMarker: string | null
Маркер статуса страницы продукта, по умолчанию null.
пример: "in_stock"

userQuery.conditionValue: string | null
Искомое значение, по умолчанию null.
пример: "new"

userQuery.attributeMarker: string | null
Текстовый идентификатор индексируемого атрибута, по которому фильтруются значения, по умолчанию null.
пример: "color"

userQuery.conditionMarker: string | null
Маркер условия фильтрации, по которому фильтруются значения, по умолчанию null.
пример: "equals"

Примеры

Минимальный пример

const response = await Products.getProductsPriceByPageUrl('catalog');

Пример с атрибутами

const userQuery = {
  "offset": 0,
  "limit": 30,
  "statusMarker": "in_stock",
  "conditionValue": "new",
  "conditionMarker": "equals",
  "attributeMarker": "color",
  "sortOrder": "DESC",
  "sortKey": "id",
};

const response = await Products.getProductsPriceByPageUrl('catalog', 'en_US', userQuery);

Пример ответа

{
  "items": [
    {
      "id": 2957,
      "price": 150
    },
    {
      "id": 2954,
      "price": 50
    },
    {
      "id": 2955,
      "price": 0
    }
  ],
  "total": 3
}

Схема ответа

Схема: IProductsInfo

total: number
Общее количество найденных продуктов.
пример: 100

items: IProductInfo[]
Массив объектов информации о продуктах.
пример:

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

---