getProducts

Buscar todos los objetos de producto con paginación y filtro.

Products?.getProducts( body?, langCode?, userQuery? );

Ejemplo mínimo

const body `= [
{
"attributeMarker": "price",?
"conditionMarker": "mth",?
"statusMarker": "waiting",?
"conditionValue": 1,?
"pageUrls": [?
"23-laminat-floorwood-maxima"?
],
"isNested": false,?
"title": ""?
},
{
"attributeMarker": "price",?
"conditionMarker": "lth",?
"conditionValue": 3,?
"pageUrls": [?
"23-laminat-floorwood-maxima"?
],
"isNested": false,?
"title": ""?
}
]

Esquema

body: IFilterParams[]
Cuerpo de la solicitud. Por defecto: []
ejemplo:

[
  {
    "attributeMarker": "price",
    "conditionMarker": "mth",
    "statusMarker": "waiting",
    "conditionValue": 1,
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  },
  {
    "attributeMarker": "price",
    "conditionMarker": "lth",
    "conditionValue": 3,
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  }
]

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

userQuery: IProductsQuery
Parámetros de consulta opcionales

offset(required): number
Parámetro para paginación. Por defecto: 0.

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

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

sortKey(required): string
Campo para ordenar (por defecto - null). Valores posibles: "id", "position", "title", "date", "price". Por defecto: null.

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

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

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

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

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

Este método busca todos los objetos de productos con paginación que no tienen una categoría, basándose en los parámetros de consulta proporcionados (userQuery). Devuelve una Promesa que se resuelve en un array de elementos, donde cada elemento es un objeto.

Ejemplo de respuesta

{
  "items": [
    {
      "id": 2957,
      "localizeInfos": {
        "title": "Cosmo"
      },
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Venta"
      },
      "attributeSetIdentifier": "products",
      "position": 1,
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 50,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "product-name": {
          "type": "string",
          "value": "Cosmo",
          "isIcon": false,
          "position": 0,
          "additionalFields": [],
          "isProductPreview": false
        },
        "price": {
          "type": "integer",
          "value": 150,
          "isIcon": false,
          "position": 1,
          "additionalFields": [],
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "",
          "isIcon": false,
          "position": 2,
          "additionalFields": [],
          "isProductPreview": false
        },
        "img": {
          "type": "image",
          "value": [],
          "isIcon": false,
          "position": 3,
          "additionalFields": [],
          "isProductPreview": false
        }
      },
      "categories": [
        "catalog"
      ],
      "isVisible": true
    },
    {
      "id": 2955,
      "localizeInfos": {
        "title": "Producto"
      },
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Venta"
      },
      "attributeSetIdentifier": null,
      "position": 2,
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "price": null,
      "additional": {
        "prices": {
          "min": 50,
          "max": 150
        }
      },
      "sku": null,
      "isSync": false,
      "attributeValues": {},
      "categories": [
        "catalog"
      ],
      "isVisible": true
    },
    {
      "id": 2954,
      "localizeInfos": {
        "title": "Caja"
      },
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Venta"
      },
      "attributeSetIdentifier": "products",
      "position": 3,
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": "product_preview",
      "price": 50,
      "additional": {
        "prices": {
          "min": 50,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "product-name": {
          "type": "string",
          "value": "product-name",
          "isIcon": false,
          "position": 0,
          "additionalFields": [],
          "isProductPreview": false
        },
        "price": {
          "type": "integer",
          "value": 50,
          "isIcon": false,
          "position": 1,
          "additionalFields": [],
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "usd",
          "isIcon": false,
          "position": 2,
          "additionalFields": [],
          "isProductPreview": false
        },
        "img": {
          "type": "image",
          "value": [],
          "isIcon": false,
          "position": 3,
          "additionalFields": [],
          "isProductPreview": false
        }
      },
      "categories": [
        "catalog"
      ],
      "isVisible": true
    }
  ],
  "total": 3
}

Esquema

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

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

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

---