getRelatedProductsById

Pesquise todos os objetos de produtos relacionados pelo ID da página

Products.getRelatedProductsById(id, langCode, userQuery)

const value = await Products.getRelatedProductsById(1)

Esquema

id:* número
Identificador da página do produto para o qual encontrar a relação
exemplo:

langCode: string
Parâmetro do código de idioma. Padrão "en_US"
exemplo: en_US

userQuery: IProductsQuery
Parâmetros de consulta opcionais
exemplo: []

userQuery.offset: número
Parâmetro opcional para paginação, o padrão é 0
exemplo: 0

userQuery.limit: número
Parâmetro opcional para paginação, o padrão é 30
exemplo: 30

userQuery.sortOrder: string
Ordem de classificação opcional DESC | ASC
exemplo: DESC

userQuery.sortKey: string
Campo opcional para ordenar (id, título, data, preço, posição, status)
exemplo: id

Este método recupera todos os objetos de página de produtos relacionados para um produto específico com base em seu identificador (id) da API. Ele aceita um parâmetro opcional userQuery para parâmetros de consulta adicionais, como offset, limit, sortOrder e sortKey. Retorna uma Promise que resolve para um array de objetos.

Exemplo de retorno:

{
  "total": 100,
  "items": [
    {
      "id": 2,
      "localizeInfos": {
        "title": "Caixa"
      },
      "statusIdentifier": "vendido",
      "statusLocalizeInfos": {
        "title": "Vendido"
      },
      "attributeSetIdentifier": "produtos",
      "position": 3,
      "templateIdentifier": null,
      "isPositionLocked": false,
      "shortDescTemplateIdentifier": null,
      "price": 148,
      "additional": {
        "prices": {
          "min": 120,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "price": {
          "type": "integer",
          "value": 148,
          "position": 1,
          "isProductPreview": false
        },
        "product-name": {
          "type": "string",
          "value": "Texto da caixa",
          "position": 0,
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "R$",
          "position": 2,
          "isProductPreview": false
        }
      },
      "isVisible": true,
      "isPositionLocked": false
    }

  ]
}

Esquema

total: número
número total de registros encontrados
exemplo: 100

id: número
identificador do objeto
exemplo: 1764

additional: Record<string, any>
valor adicional do índice
exemplo:

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

statusLocalizeInfos: CommonLocalizeInfos
descrição json do objeto de status do item, levando em conta o idioma
exemplo:

{ "title": "Produto" }

localizeInfos: Record<string, any>
descrição json do objeto de dados da página principal levando em conta o idioma "en_US" (por exemplo)
exemplo:

{
  "en_US": {
    "title": "Catálogo",
    "plainContent": "Conteúdo para catálogo",
    "htmlContent": "<b>Conteúdo para catálogo</b>",
    "menuTitle": "Catálogo"
  }
}

isVisible: booleano
flag de visibilidade da página
exemplo: true

position: número
número da posição (para ordenação)
exemplo: 192

templateIdentifier: string
identificador personalizado do template associado
exemplo: meu-template

attributeSetId: número
identificador do conjunto de atributos
exemplo: 7

blocks: array
blocos de produtos
exemplo: ['product_block']

isSync: booleano
indicador de indexação da página (true ou false)
exemplo: false

attributeValues: Record<string, string>
Array de valores de atributos do índice (apresentados como um par de identificador de atributo personalizado: valor do atributo)
exemplo:

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string"
    }
  }
}

statusId: número
identificadores de status da página do produto (pode ser nulo)
exemplo: 1

sku: string
valor SKU do produto retirado do índice
exemplo: 1

relatedIds: array
identificadores das páginas de produtos relacionados
exemplo:

[ 1, 2, 3 ]

price: número
valor do preço da página do produto retirado do índice
exemplo: 0

templateIdentifier string
identificador personalizado do template associado
exemplo: meu-template

shortDescTemplateIdentifier string
identificador personalizado do template associado para descrição curta
exemplo: meu-template-curto