getProductById

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

Products.getProductById(id, langCode)

const value = await Products.getProductById(1)

Схема

id:* Идентификатор продукта

• Идентификатор продукта*
  пример: 1
  

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

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

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

{
  "id": 3,
  "localizeInfos": {
    "title": "Продукт"
  },
  "statusIdentifier": null,
  "statusLocalizeInfos": {},
  "attributeSetIdentifier": "products",
  "position": 1,
  "templateIdentifier": null,
  "shortDescTemplateIdentifier": null,
  "price": 120,
  "additional": {
    "prices": {
      "min": 120,
      "max": 150
    }
  },
  "sku": null,
  "isSync": true,
  "attributeValues": {
    "price": {
      "type": "integer",
      "value": "120",
      "position": 1,
      "isProductPreview": false
    },
    "product-name": {
      "type": "string",
      "value": "Prod",
      "position": 0,
      "isProductPreview": false
    },
    "currency_products": {
      "type": "string",
      "value": "$",
      "position": 2,
      "isProductPreview": false
    }
  },
  "isVisible": true,
  "productPages": {
    "id": 3,
    "pageId": 2,
    "productId": 3,
    "positionId": 215
  },
  "blocks": [
    "product_block",
    "another"
  ]
}

Схема

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