getProductsByIds

Getting multiple products by its ids.

Description

This method retrieves multiple product objects by their identifiers (comma-separated ids). It returns a Promise that resolves to an array of IProductsEntity objects.

Products.getProductsByIds(
ids,
langCode,
userQuery
);

Parameters schema

Schema

ids(required): string
Product page identifiers for which to find relationships
example: "12345,67890"

langCode: string
Language code. Default "en_US"

userQuery: IProductsQuery
Optional set query parameters
example:

{
  "limit": 30,
  "offset": 0,
  "sortOrder": "DESC",
  "sortKey": "id",
  "signPrice": "orders",
  "templateMarker": "template_12345",
  "statusMarker": "in_stock",
  "conditionValue": "new",
  "conditionMarker": "eq",
  "attributeMarker": "color"
}

userQuery.offset(required): number
Parameter for pagination. Default: 0.

userQuery.limit(required): number
Parameter for pagination. Default: 30.

userQuery.sortOrder(required): string
Sort order "DESC" | "ASC". Default: "DESC".

userQuery.sortKey(required): string
Field for sorting (default - null). Possible values: "id", "position", "title", "date", "price". Default: null.

userQuery.signPrice: string
Price sign. Default: null.

userQuery.templateMarker: string | null
Product page template marker, default null.
example: "template_12345"

userQuery.statusMarker: string | null
Product page status marker, default null.
example: "in_stock"

userQuery.conditionValue: string | null
The value that is being searched for, default null.
example: "new"

userQuery.attributeMarker: string | null
The text identifier of the indexed attribute by which values are filtered, default null.
example: "color"

userQuery.conditionMarker: string | null
Marker of the filter condition by which the values are filtered, default null.
example: "equals"

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

userQuery.ids: string
Comma-separated list of product ids — used by getProductsByIds.
example: "1,2,3"

By default, you can retrieve 10 objects. This is due to the record limit in the module's permissions settings.
For pagination to work correctly, you need to configure Module permissions according to your needs in the corresponding section.

Examples

Try it live

Run this method interactively in the JS SDK sandbox — connect your Project URL and App Token on first visit, then open:

Get products by IDs — fetch multiple products at once with a comma-separated list of IDs.

Minimal example

const response = await Products.getProductsByIds('1, 5, 8');

Example with attributes

const userQuery = {
  "offset": 0,
  "limit": 30,
  "sortOrder": "DESC",
  "sortKey": "id"
};
const response = await Products.getProductsByIds('1, 5, 8', 'en_US', userQuery);

Use filters to find specific products:

attributeMarker: The text identifier of the indexed attribute by which values are filtered. conditionMarker: The type of condition to apply to the attribute value.

Marker	Meaning	Example
eq	Equal	statusId = 1 (active only)
neq	Not equal	category ≠ "archived"
in	Contains (one of)	category in ["electronics", "books"]
nin	Not contains	brand not in ["fake_brand"]
exs	Exists (has value)	Has description
nexs	Does not exist	No image

conditionValue: The value to compare against.

Example response

[
  {
    "id": 2954,
    "attributeSetIdentifier": "products",
    "localizeInfos": {
      "title": "Box"
    },
    "statusLocalizeInfos": {
      "title": "Sale"
    },
    "isVisible": true,
    "statusIdentifier": "sale",
    "position": 2,
    "templateIdentifier": "my-template",
    "shortDescTemplateIdentifier": "My template description",
    "price": 51,
    "additional": {
      "prices": {
        "min": 51,
        "max": 150
      }
    },
    "sku": null,
    "isSync": true,
    "categories": [
      "catalog"
    ],
    "paymentStages": [
      {
        "title": "Part A",
        "marker": "part_a",
        "value": 100
      },
      {
        "title": "Part B",
        "marker": "part_b",
        "value": 200
      }
    ],
    "rating": {
      "votes": 42,
      "value": 4.5,
      "like": 10,
      "dislike": 2,
      "method": "weighted"
    },
    "attributeValues": {
      "product-name": {
        "type": "string",
        "value": "product-name",
        "isIcon": false,
        "position": 0,
        "additionalFields": {},
        "isProductPreview": false
      },
      "price": {
        "type": "integer",
        "value": 51,
        "isIcon": false,
        "position": 1,
        "additionalFields": {},
        "isProductPreview": false
      },
      "currency_products": {
        "type": "string",
        "value": "usd",
        "isIcon": false,
        "position": 2,
        "additionalFields": {},
        "isProductPreview": false
      },
      "img": {
        "type": "image",
        "value": {
          "size": 241636,
          "filename": "files/project/product/2954/image/7e0a6a70-a23d-410f-8b6a-f8b4f7483244.png",
          "contentType": "image/png",
          "downloadLink": "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/7e0a6a70-a23d-410f-8b6a-f8b4f7483244.png"
        },
        "isIcon": false,
        "position": 3,
        "additionalFields": {},
        "isProductPreview": false
      }
    },
    "productPages": [
      {
        "id": 2847,
        "pageId": 10,
        "productId": 2954,
        "positionId": 3190,
        "categoryPath": "catalog"
      }
    ],
    "blocks": [
      "product_block",
      "product_block"
    ],
    "signedPrice": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "moduleFormConfigs": [
      {
        "id": 12,
        "formIdentifier": "review",
        "moduleIdentifier": "catalog",
        "isGlobal": false,
        "isClosed": false,
        "isModerate": false,
        "viewOnlyMyData": false,
        "commentOnlyMyData": false,
        "entityIdentifiers": [
          {
            "id": "catalog",
            "isNested": true
          }
        ],
        "formDataCount": 374,
        "ratingCalculation": "average",
        "allowHalfRatings": true,
        "maxRatingScale": 5,
        "isAnonymous": true,
        "allowRerating": true,
        "isRating": true,
        "entityFormDataCount": {
          "2954": 374
        },
        "nestedEntityIdentifiers": [
          "catalog"
        ],
        "exceptionIds": []
      }
    ],
    "discountConfig": {
      "discounts": [
        {
          "id": 5,
          "identifier": "summer-sale",
          "type": "DISCOUNT",
          "localizeInfos": {
            "title": "Summer Sale"
          },
          "startDate": "2026-01-01T06:32:19.736Z",
          "endDate": "2026-01-28T06:32:22.632Z",
          "discountValue": {
            "value": 30,
            "maxAmount": 0,
            "discountType": "FIXED_PRICE",
            "applicability": "TO_PRODUCT"
          },
          "exclusions": [
            {
              "id": 2
            }
          ],
          "position": 3,
          "conditionLogic": "OR",
          "gifts": [
            {
              "id": 3,
              "localizeInfos": {
                "title": "hhh222"
              },
              "attributeSetIdentifier": "attr-set-1",
              "statusIdentifier": null,
              "statusLocalizeInfos": {},
              "templateIdentifier": null,
              "price": 90,
              "sku": null,
              "attributeValues": {
                "price1": {
                  "type": "integer",
                  "value": "90",
                  "isIcon": false,
                  "position": 0,
                  "additionalFields": [],
                  "isProductPreview": false
                }
              },
              "isVisible": true
            }
          ],
          "conditions": [
            {
              "conditionType": "PRODUCT",
              "entityIds": [
                {
                  "id": 4,
                  "isNested": false
                },
                {
                  "isNested": false
                }
              ],
              "value": null
            },
            {
              "conditionType": "ATTRIBUTE",
              "entityIds": [
                {
                  "isNested": false
                }
              ],
              "value": {
                "value": "100",
                "condition": "eq"
              }
            }
          ]
        }
      ],
      "discountPrice": 90,
      "settings": {
        "allowStacking": true,
        "maxDiscountValue": 30,
        "allowGiftStacking": false
      }
    }
  },
  {
    "id": 2955,
    "attributeSetIdentifier": null,
    "localizeInfos": {
      "title": "Product"
    },
    "statusLocalizeInfos": {
      "title": "Sale"
    },
    "isVisible": true,
    "statusIdentifier": "sale",
    "position": 1,
    "templateIdentifier": null,
    "shortDescTemplateIdentifier": null,
    "price": null,
    "additional": {
      "prices": {
        "min": 51,
        "max": 150
      }
    },
    "sku": null,
    "isSync": false,
    "categories": [
      "catalog"
    ],
    "paymentStages": null,
    "rating": {},
    "attributeValues": {},
    "productPages": [
      {
        "id": 2848,
        "pageId": 10,
        "productId": 2955,
        "positionId": 3191,
        "categoryPath": "catalog"
      }
    ],
    "blocks": [
      "product_block",
      "product_block"
    ],
    "moduleFormConfigs": [
      {
        "id": 12,
        "formIdentifier": "review",
        "moduleIdentifier": "catalog",
        "isGlobal": false,
        "isClosed": false,
        "isModerate": false,
        "viewOnlyMyData": false,
        "commentOnlyMyData": false,
        "entityIdentifiers": [
          {
            "id": "catalog",
            "isNested": true
          }
        ],
        "formDataCount": 374,
        "ratingCalculation": "average",
        "allowHalfRatings": null,
        "maxRatingScale": null,
        "isAnonymous": null,
        "allowRerating": null,
        "isRating": null,
        "entityFormDataCount": {
          "2954": 374
        },
        "nestedEntityIdentifiers": [
          "catalog"
        ],
        "exceptionIds": []
      }
    ],
    "discountConfig": {}
  }
]

Response schema

Schema: IProductsEntity[]

id: number
The unique identifier.
example: 12345

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

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

statusLocalizeInfos: ILocalizeInfo
Localized status name for the product.
example: { "title": "Sale" }

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

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

price: number | null
The value of the product page price taken from the index.
example: 150.00

additional: object
Additional value from the index.
example: { prices: { min: 5 max: 150 } }

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

moduleFormConfigs: Array<IFormConfig>
Module form configurations (optional).

rating: IRating
Rating data.

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

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

paymentStages: unknown
Payment stages data (may be null).
example: null

discountConfig: Record<string, unknown>
Discount configuration object.
example:

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"

signedPrice: string
Price sign.

productPages: IProductPageRef[]
Array of product page references linking the product to its pages.
example:

[
  {
    "id": 16,
    "pageId": 4,
    "productId": 15,
    "positionId": 244,
    "categoryPath": "products"
  }
]

productPages.id: number
Unique identifier of the product-to-page link record.
example: 16

productPages.pageId: number
Identifier of the page the product is linked to.
example: 4

productPages.productId: number
Identifier of the product.
example: 15

productPages.positionId: number
Sorting position identifier within the page.
example: 244

productPages.categoryPath: string
Category path of the page the product belongs to.
example: "products"

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

[
  "block_12345",
  "block_67890"
]

Description​

Parameters schema​

Examples​

Try it live​

Minimal example​

Example with attributes​

Example response​

Response schema​