getRelatedProductsById

Buscar todos los objetos de productos relacionados por id de página

Products.getRelatedProductsById(id, langCode, userQuery)

const value = await Products.getRelatedProductsById(1)

Esquema

id:* número
Identificador de la página del producto para el cual encontrar la relación
ejemplo:

langCode: cadena
Parámetro del código de idioma. Por defecto "en_US"
ejemplo: en_US

userQuery: IProductsQuery
Parámetros de consulta opcionales
ejemplo: []

userQuery.offset: número
Parámetro opcional para paginación, por defecto es 0
ejemplo: 0

userQuery.limit: número
Parámetro opcional para paginación, por defecto es 30
ejemplo: 30

userQuery.sortOrder: cadena
Orden de clasificación opcional DESC | ASC
ejemplo: DESC

userQuery.sortKey: cadena
Campo opcional para ordenar (id, título, fecha, precio, posición, estado)
ejemplo: id

Este método recupera todos los objetos de la página de productos relacionados para un producto específico basado en su identificador (id) de la API. Acepta un parámetro opcional userQuery para parámetros de consulta adicionales como offset, limit, sortOrder y sortKey. Devuelve una Promesa que se resuelve en un array de objetos.

Ejemplo de retorno:

{
  "total": 100,
  "items": [
    {
      "id": 2,
      "localizeInfos": {
        "title": "Caja"
      },
      "statusIdentifier": "vendido",
      "statusLocalizeInfos": {
        "title": "Vendido"
      },
      "attributeSetIdentifier": "productos",
      "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 de la caja",
          "position": 0,
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "$",
          "position": 2,
          "isProductPreview": false
        }
      },
      "isVisible": true,
      "isPositionLocked": false
    }

  ]
}

Esquema

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

id: número
identificador del objeto
ejemplo: 1764

additional: Record<string, any>
valor adicional del índice
ejemplo:

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

statusLocalizeInfos: CommonLocalizeInfos
descripción json del objeto de estado del ítem, teniendo en cuenta el idioma
ejemplo:

{ "title": "Producto" }

localizeInfos: Record<string, any>
descripción json del objeto de datos de la página principal teniendo en cuenta el idioma "en_US" (por ejemplo)
ejemplo:

{
  "en_US": {
    "title": "Catálogo",
    "plainContent": "Contenido para el catálogo",
    "htmlContent": "<b>Contenido para el catálogo</b>",
    "menuTitle": "Catálogo"
  }
}

isVisible: booleano
bandera de visibilidad de la página
ejemplo: true

position: número
número de posición (para ordenar)
ejemplo: 192

templateIdentifier: cadena
identificador personalizado de la plantilla asociada
ejemplo: my-template

attributeSetId: número
identificador del conjunto de atributos
ejemplo: 7

blocks: array
bloques de producto
ejemplo: ['product_block']

isSync: booleano
indicador de indexación de la página (true o false)
ejemplo: false

attributeValues: Record<string, string>
Array de valores de atributos del índice (presentados como un par de identificador de atributo personalizado: valor de atributo)
ejemplo:

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

statusId: número
identificadores de estado de la página del producto (puede ser nulo)
ejemplo: 1

sku: cadena
valor SKU del producto tomado del índice
ejemplo: 1

relatedIds: array
identificadores de páginas de productos relacionados
ejemplo:

[ 1, 2, 3 ]

price: número
valor del precio de la página del producto tomado del índice
ejemplo: 0

templateIdentifier cadena
identificador personalizado de la plantilla asociada
ejemplo: my-template

shortDescTemplateIdentifier cadena
identificador personalizado de la plantilla asociada para la descripción corta
ejemplo: my-template-short