getProductsPriceByPageUrl

Busca información sobre productos y precios para la categoría seleccionada.

Descripción

Este método busca información sobre productos y precios para la categoría seleccionada, basado en los parámetros de consulta proporcionados (userQuery). Devuelve una Promesa que se resuelve en un objeto IProductsInfo.

Products.getProductsPriceByPageUrl( url, langCode, userQuery );

Esquema de parámetros

Esquema

url: string
URL de la página
ejemplo: "23-laminat-floorwood-maxima"

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

userQuery: IProductsQuery
Conjunto de 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. Por defecto: 0.

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

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

userQuery.sortKey(required): string
Campo para la clasificación (por defecto - null). Valores posibles: "id", "position", "title", "date", "price". Por defecto: null.

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

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

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

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

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

Por defecto, puedes recuperar 10 objetos. Esto se debe al límite de registros en la configuración de permisos del módulo.
Para que la paginación funcione correctamente, necesitas configurar Permisos del módulo de acuerdo a tus necesidades en la sección correspondiente.

Ejemplos

Ejemplo mínimo

const response = await Products.getProductsPriceByPageUrl('catalog');

Ejemplo con atributos

const userQuery = {
  "offset": 0,
  "limit": 30,
  "statusMarker": "in_stock",
  "conditionValue": "new",
  "conditionMarker": "equals",
  "attributeMarker": "color",
  "sortOrder": "DESC",
  "sortKey": "id",
};

const response = await Products.getProductsPriceByPageUrl('catalog', 'en_US', userQuery);

Ejemplo de respuesta

{
  "items": [
    {
      "id": 2957,
      "price": 150
    },
    {
      "id": 2954,
      "price": 51
    },
    {
      "id": 2955,
      "price": 0
    }
  ],
  "total": 3
}

Esquema de respuesta

Esquema: IProductsInfo

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

items: IProductInfo[]
Un array de objetos de información de productos.
ejemplo:

[
  {
    "id": 12345,
    "price": 150
  },
  {
    "id": 67890,
    "price": 200
  }
]

---