getRelatedProductsById

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

Products.getRelatedProductsById(id, langCode, userQuery)

const value = await Products.getRelatedProductsById(1)

Схема

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

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

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

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

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

userQuery.sortOrder: строка
Необязательный порядок сортировки DESC | ASC
пример: DESC

userQuery.sortKey: строка
Необязательное поле для сортировки (id, title, date, price, position, status)
пример: id

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

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

{
  "total": 100,
  "items": [
    {
      "id": 2,
      "localizeInfos": {
        "title": "Коробка"
      },
      "statusIdentifier": "продан",
      "statusLocalizeInfos": {
        "title": "Продан"
      },
      "attributeSetIdentifier": "продукты",
      "position": 3,
      "templateIdentifier": null,
      "isPositionLocked": false,
      "shortDescTemplateIdentifier": null,
      "price": 148,
      "additional": {
        "prices": {
          "min": 120,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "price": {
          "type": "integer",
          "value": 148,
          "position": 1,
          "isProductPreview": false
        },
        "product-name": {
          "type": "string",
          "value": "Текст коробки",
          "position": 0,
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "$",
          "position": 2,
          "isProductPreview": false
        }
      },
      "isVisible": true,
      "isPositionLocked": false
    }

  ]
}

Схема

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

id: число
идентификатор объекта
пример: 1764

additional: Record<string, any>
дополнительное значение из индекса
пример:

{ 
  "prices": { 
    "min": 0, 
    "max": 100 
  } 
}

statusLocalizeInfos: CommonLocalizeInfos
json-описание объекта статуса элемента с учетом языка
пример:

{ "title": "Продукт" }

localizeInfos: Record<string, any>
json-описание основного объекта данных страницы с учетом языка "en_US" (например)
пример:

{
  "en_US": {
    "title": "Каталог",
    "plainContent": "Содержимое для каталога",
    "htmlContent": "<b>Содержимое для каталога</b>",
    "menuTitle": "Каталог"
  }
}

isVisible: булево
Флаг видимости страницы
пример: true

position: число
номер позиции (для сортировки)
пример: 192

templateIdentifier: строка
пользовательский идентификатор связанного шаблона
пример: my-template

attributeSetId: число
идентификатор набора атрибутов
пример: 7

blocks: массив
блоки продукта
пример: ['product_block']

isSync: булево
индикатор индексации страницы (true или false)
пример: false

attributeValues: Record<string, string>
Массив значений атрибутов из индекса (представленный в виде пары пользовательский идентификатор атрибута: значение атрибута)
пример:

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string"
    }
  }
}

statusId: число
идентификаторы статусов страницы продукта (может быть null)
пример: 1

sku: строка
значение SKU продукта, взятое из индекса
пример: 1

relatedIds: массив
идентификаторы связанных страниц продуктов
пример:

[ 1, 2, 3 ]

price: число
значение цены страницы продукта, взятое из индекса
пример: 0

templateIdentifier строка
пользовательский идентификатор связанного шаблона
пример: my-template

shortDescTemplateIdentifier строка
пользовательский идентификатор связанного шаблона для краткого описания
пример: my-template-short