getProductById

Get one product object by id.

Description

This method retrieves a single product object based on its identifier (id) from the API. It returns a Promise that resolves to a object for the product IProductsEntity.

Products.getProductById(

id, langCode

);

Parameters schema

Schema

id: number
Product id
example: 12345

langCode: string
Language code. Default: "en_US"
example: "en_US"

Examples

Minimal example

const response = await Products.getProductById(1);

Example with attributes

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

Example response

{
  "id": 2954,
  "localizeInfos": {
    "title": "Box"
  },
  "statusIdentifier": "sale",
  "statusLocalizeInfos": {
    "title": "Sale"
  },
  "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"
  ]
}

Response schema

Schema: IProductsEntity

id: number
The unique identifier.
example: 12345

localizeInfos: ILocalizeInfo
The name of the products, taking into account localization.

statusIdentifier: string | null
Product page status identifiers (may be null).
example: "in_stock"

statusLocalizeInfos: any
JSON description of the item status object, taking into account the language.

attributeSetIdentifier: string | null
Set of attributes id.
example: "set_12345"

position: number
Item number (for sorting).
example: 1

templateIdentifier: string | null
User id of the linked template.
example: "template_12345"

shortDescTemplateIdentifier: string | null
User id of the linked template for a short description.
example: "short_desc_template_12345"

price: number
The value of the product page price taken from the index.
example: 150

additional: object
Additional value from the index.
example:

{
  "en": "In Stock",
  "de": "Auf Lager"
}

sku: string | null
Product SKU (Stock Keeping Unit), may be null.
example: "SKU_12345"

isSync: boolean
Indication of page indexing.
example: true

attributeValues: AttributeType
Array of attribute values from the index, represented.
example:

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

categories: string[]
Product categories.
example:

[
  1,
  2,
  3
]

isVisible: boolean
A sign of page visibility.
example: true

productPages: any[]
Array of product pages or a single product page object.

blocks: string[]
Array of block identifiers.
example:

[
  "block_12345",
  "block_67890"
]

isPositionLocked: boolean
Sorting position lock indicator (optional).
example: false

relatedIds: number[]
Ids of related product pages.
example:

[
  12345,
  67890
]

---