getRelatedProductsById

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

Описание

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

Products.getRelatedProductsById( id, langCode, userQuery );

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

Схема

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

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(required): number
Параметр для постраничной навигации. По умолчанию: 0.

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

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

userQuery.sortKey(required): 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.getRelatedProductsById(1);

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

const userQuery = {
  "offset": 0,
  "limit": 30,
  "sortOrder": "DESC",
  "sortKey": "id"
};

const response = await Products.getRelatedProductsById(1, 'en_US', userQuery);

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

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

Схема ответа

Схема: IProductsResponse

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

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

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

---