getProductsByIds

Obtendo múltiplos produtos pelos seus ids.

Descrição

Este método recupera objetos de produtos com base em seus identificadores (ids) da API. Ele retorna uma Promise que resolve para objetos IProductsEntity para o produto.

Produtos.getProductsByIds( ids, langCode, userQuery );

Esquema de parâmetros

Esquema

ids(obrigatório): string
Identificadores da página do produto para os quais encontrar relacionamentos
exemplo: "12345,67890"

langCode: string
Código do idioma. Padrão "en_US"

userQuery: IProductsQuery
Conjunto de parâmetros de consulta opcionais
exemplo:

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

userQuery.offset(obrigatório): number
Parâmetro para paginação. Padrão: 0.

userQuery.limit(obrigatório): number
Parâmetro para paginação. Padrão: 30.

userQuery.sortOrder(obrigatório): string
Ordem de classificação "DESC" | "ASC". Padrão: "DESC".

userQuery.sortKey(obrigatório): string
Campo para ordenação (padrão - null). Valores possíveis: "id", "position", "title", "date", "price". Padrão: null.

userQuery.signPrice: string
Sinal do preço. Padrão: null.

userQuery.templateMarker: string | null
Marcador de template da página do produto, padrão null.
exemplo: "template_12345"

userQuery.statusMarker: string | null
Marcador de status da página do produto, padrão null.
exemplo: "in_stock"

userQuery.conditionValue: string | null
O valor que está sendo buscado, padrão null.
exemplo: "new"

userQuery.attributeMarker: string | null
O identificador de texto do atributo indexado pelo qual os valores são filtrados, padrão null.
exemplo: "color"

userQuery.conditionMarker: string | null
Marcador da condição de filtro pela qual os valores são filtrados, padrão null.
exemplo: "equals"

userQuery.langCode: string
Código do idioma. Padrão: "en_US".

userQuery.ids: string
Lista de ids de produtos separados por vírgula — usada por getProductsByIds.
exemplo: "1,2,3"

Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registro nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar as Permissões do Módulo de acordo com suas necessidades na seção correspondente.

Exemplos

Exemplo mínimo

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

Exemplo com atributos

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

Use filtros para encontrar produtos específicos:

attributeMarker: O identificador de texto do atributo indexado pelo qual os valores são filtrados. conditionMarker: O tipo de condição a ser aplicada ao valor do atributo.

Marcador	Significado	Exemplo
eq	Igual	statusId = 1 (apenas ativo)
neq	Não igual	categoria ≠ "arquivado"
in	Contém (um dos)	categoria in ["eletrônicos", "livros"]
nin	Não contém	marca não in ["marca_falsa"]
exs	Existe (tem valor)	Tem descrição
nexs	Não existe	Sem imagem

conditionValue: O valor a ser comparado.

Exemplo de resposta

[
  {
    "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": {}
  }
]

Esquema de resposta

Esquema: IProductsEntity[]

id: number
O identificador único.
exemplo: 12345

localizeInfos: ILocalizeInfo
O nome dos produtos, levando em conta a localização.
exemplo:

statusIdentifier: string | null
Identificadores de status da página do produto (pode ser nulo).
exemplo: "in_stock"

statusLocalizeInfos: ILocalizeInfo
Nome de status localizado para o produto.
exemplo: { "title": "Venda" }

attributeSetIdentifier: string | null
Conjunto de ids de atributos.
exemplo: "set_12345"

position: number
Número do item (para ordenação).
exemplo: 1

price: number | null
O valor do preço da página do produto retirado do índice.
exemplo: 150.00

additional: object
Valor adicional do índice.
exemplo: { prices: { min: 5 max: 150 } }

sku: string | null
SKU do produto (Unidade de Manutenção de Estoque), pode ser nulo.
exemplo: "SKU_12345"

isSync: boolean
Indicação de indexação da página.
exemplo: true

attributeValues: AttributeType
Array de valores de atributos do índice, representados.
exemplo:

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

categories: string[]
Categorias de produtos.
exemplo:

[
  1,
  2,
  3
]

isVisible: boolean
Um sinal de visibilidade da página.
exemplo: true

moduleFormConfigs: Array<IFormConfig>
Configurações de formulário do módulo (opcional).

rating: IRating
Dados de avaliação.

isPositionLocked: boolean
Indicador de bloqueio da posição de ordenação (opcional).
exemplo: false

relatedIds: number[]
Ids de páginas de produtos relacionadas.
exemplo:

[
  12345,
  67890
]

paymentStages: unknown
Dados das etapas de pagamento (pode ser nulo).
exemplo: null

discountConfig: Record<string, unknown>
Objeto de configuração de desconto.
exemplo:

templateIdentifier: string | null
Id do usuário do template vinculado.
exemplo: "template_12345"

shortDescTemplateIdentifier: string | null
Id do usuário do template vinculado para uma descrição curta.
exemplo: "short_desc_template_12345"

signedPrice: string
Sinal do preço.

productPages: IProductPageRef[]
Array de referências de páginas de produtos ligando o produto às suas páginas.
exemplo:

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

productPages.id: number
Identificador único do registro de link produto-página.
exemplo: 16

productPages.pageId: number
Identificador da página à qual o produto está vinculado.
exemplo: 4

productPages.productId: number
Identificador do produto.
exemplo: 15

productPages.positionId: number
Identificador da posição de ordenação dentro da página.
exemplo: 244

productPages.categoryPath: string
Caminho da categoria da página à qual o produto pertence.
exemplo: "products"

blocks: string[]
Array de identificadores de blocos.
exemplo:

[
  "block_12345",
  "block_67890"
]

---