getProductById

Получить один объект продукта по id

Products.getProductById(id, langCode)

const value = await Products.getProductById(1)

Схема

id: число
Идентификатор продукта
пример: 12345

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

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

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

{
  "id": 2954,
  "localizeInfos": {
    "title": "Коробка"
  },
  "statusIdentifier": "sale",
  "statusLocalizeInfos": {
    "title": "Распродажа"
  },
  "attributeSetIdentifier": "products",
  "position": 1,
  "templateIdentifier": null,
  "shortDescTemplateIdentifier": "product_preview",
  "price": 50,
  "additional": {
    "prices": {
      "min": 50,
      "max": 150
    }
  },
  "sku": null,
  "isSync": true,
  "attributeValues": {
    "product-name": {
      "type": "string",
      "value": "product-name",
      "isIcon": false,
      "position": 0,
      "additionalFields": [],
      "isProductPreview": false
    },
    "price": {
      "type": "integer",
      "value": 50,
      "isIcon": false,
      "position": 1,
      "additionalFields": [],
      "isProductPreview": false
    },
    "currency_products": {
      "type": "string",
      "value": "usd",
      "isIcon": false,
      "position": 2,
      "additionalFields": [],
      "isProductPreview": false
    },
    "img": {
      "type": "image",
      "value": [],
      "isIcon": false,
      "position": 3,
      "additionalFields": [],
      "isProductPreview": false
    }
  },
  "categories": [
    "catalog"
  ],
  "isVisible": true,
  "productPages": [
    {
      "id": 2847,
      "pageId": 10,
      "productId": 2954,
      "positionId": 3190,
      "categoryPath": "catalog"
    }
  ],
  "blocks": [
    "product_block"
  ]
}

Схема

id: число
Уникальный идентификатор.
пример: 12345

attributeValues: AttributeType
Массив значений атрибутов из индекса, представленный.
пример:

[
  {
    "id": "color",
    "value": "red"
  }
]

additional: объект
Дополнительное значение из индекса.
пример:

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

localizeInfos: ILocalizeInfo
Название продуктов с учетом локализации.
пример:

{
  "title": "Cosmo"
}

isVisible: логическое
Признак видимости страницы.
пример: true

isPositionLocked: логическое
Индикатор блокировки позиции сортировки (необязательно).
пример: false

statusIdentifier: число
Идентификаторы статуса страницы продукта (могут быть null).
пример: NaN

relatedIds: число[]
Идентификаторы связанных страниц продуктов.
пример:

[
  12345,
  67890
]

attributeSetIdentifier: строка
Идентификатор набора атрибутов.
пример: "set_12345"

isSync: логическое
Индикатор индексации страницы.
пример: true

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

templateIdentifier: строка
Идентификатор связанного шаблона.
пример: "template_12345"

shortDescTemplateIdentifier: строка
Идентификатор связанного шаблона для краткого описания.
пример: "short_desc_template_12345"

statusLocalizeInfos: любой
JSON-описание объекта статуса элемента с учетом языка.
пример:

{
  "en": "В наличии",
  "de": "Auf Lager"
}

position: число
Номер элемента (для сортировки).
пример: 1

sku: строка
SKU продукта (единица учета запасов), может быть null.
пример: "SKU_12345"

blocks: строк[]
Массив идентификаторов блоков.
пример:

[
  "block_12345",
  "block_67890"
]

productPages: любой[]
Массив страниц продуктов или объект одной страницы продукта.
пример:

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

---