getRelatedProductsById

Поиск всех связанных объектов продуктов по идентификатору страницы

Products.getRelatedProductsById(id, langCode, userQuery)

const value = await Products.getRelatedProductsById(1)

Схема

id: число
Идентификатор страницы продукта, для которого нужно найти связь
пример: 12345

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

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

{
  "offset": 0,
  "limit": 30,
  "sortOrder": "DESC",
  "sortKey": "id"
}

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

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

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

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

templateMarker: строка
Идентификатор статуса страницы продукта, по умолчанию null.
пример: "template_12345"

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

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

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

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

Этот метод извлекает все связанные объекты страниц продуктов для конкретного продукта на основе его идентификатора (id) из API. Он принимает необязательный параметр userQuery для дополнительных параметров запроса, таких как offset, limit, sortOrder и sortKey. Он возвращает Promise, который разрешается в массив объектов.

Пример возвращаемого значения:

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

Схема

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

items: IProductsEntity[]
Массив сущностей продуктов.
пример:

[
  {
    "id": 12345,
    "title": "Продукт 1"
  },
  {
    "id": 67890,
    "title": "Продукт 2"
  }
]

---