getRelatedProductsById

Busca todos los objetos de productos relacionados por el id de la página.

Descripción

Este método recupera todos los objetos de página de productos relacionados para un producto específico basado en su identificador (id) desde 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 objeto IProductsResponse.

Products.getRelatedProductsById( id, langCode, userQuery );

Esquema de parámetros

Esquema

id: number
Identificador de la página del producto para el cual encontrar la relación
ejemplo: 12345

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

userQuery: IProductsQuery
Parámetros de consulta opcionales
ejemplo:

{
  "limit": 30,
  "offset": 0,
  "sortOrder": "DESC",
  "sortKey": "id",
  "statusId": 123,
  "statusMarker": "in_stock",
  "conditionValue": "new",
  "conditionMarker": "equals",
  "attributeMarker": "color"
}

userQuery.offset(required): number
Parámetro para la paginación. Predeterminado: 0.

userQuery.limit(required): number
Parámetro para la paginación. Predeterminado: 30.

userQuery.sortOrder(required): string
Orden de clasificación "DESC" | "ASC". Predeterminado: "DESC".

userQuery.sortKey(required): string
Campo para ordenar (predeterminado - null). Valores posibles: "id", "position", "title", "date", "price". Predeterminado: null.

userQuery.templateMarker: string | null
Marcador de plantilla de página de producto, predeterminado null.
ejemplo: "template_12345"

userQuery.statusMarker: string | null
Marcador de estado de página de producto, predeterminado null.
ejemplo: "in_stock"

userQuery.conditionValue: string | null
El valor que se está buscando, predeterminado null.
ejemplo: "new"

userQuery.attributeMarker: string | null
El identificador de texto del atributo indexado por el cual se filtran los valores, predeterminado null.
ejemplo: "color"

userQuery.conditionMarker: string | null
Marcador de la condición del filtro por la cual se filtran los valores, predeterminado null.
ejemplo: "equals"

Ejemplos

Ejemplo mínimo

const response = await Products.getRelatedProductsById(1);

Ejemplo con atributos

const userQuery = {
  "offset": 0,
  "limit": 30,
  "sortOrder": "DESC",
  "sortKey": "id"
};

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

Ejemplo de respuesta

{
  "items": [],
  "total": 0
}

Esquema de respuesta

Esquema: IProductsResponse

total: number
El número total de productos encontrados.
ejemplo: 100

items: IProductsEntity[]
Un array de entidades de productos.
ejemplo:

[
  {
    "id": 12345,
    "title": "Producto 1"
  },
  {
    "id": 67890,
    "title": "Producto 2"
  }
]

---