getProductsEmptyPage

Rechercher tous les objets de produit avec pagination qui n'ont pas de catégorie

Products.getProductsEmptyPage(langCode, userQuery)

const value = await Products.getProductsEmptyPage('en_US', userQuery)

Schéma

langCode: chaîne
Paramètre de code de langue. Par défaut "en_US"
exemple : en_US

userQuery: IProductsQuery
Paramètres de requête optionnels.

userQuery.offset: nombre
Paramètre optionnel pour la pagination, par défaut 0
exemple : 0

userQuery.limit: nombre
Paramètre optionnel pour la pagination, par défaut 30
exemple : 30

userQuery.statusMarker: chaîne
Identifiant optionnel de l'état de la page produit
exemple : waiting

userQuery.conditionValue: chaîne
Valeur optionnelle recherchée
exemple : 1

userQuery.conditionMarker: chaîne
Identifiant optionnel de la condition de filtre par laquelle les valeurs sont filtrées
exemple : lth

userQuery.attributeMarker: chaîne
Identifiant textuel optionnel de l'attribut indexé par lequel les valeurs sont filtrées
exemple : price

userQuery.sortOrder: chaîne
Ordre de tri optionnel DESC | ASC
exemple : DESC

userQuery.sortKey: chaîne
Champ optionnel pour trier (id, title, date, price, position, status)
exemple : id

Cette méthode recherche des objets de page produit avec pagination qui n'ont pas de catégorie, en fonction des paramètres de requête fournis (userQuery). Elle renvoie une promesse qui se résout en un tableau d'éléments, où chaque élément est un objet.

Exemple de retour :

{
  "total": 100,
  "itema": [
    {
      "id": 4,
      "localizeInfos": {
        "title": "Cosmo"
      },
      "statusIdentifier": null,
      "statusLocalizeInfos": {},
      "attributeSetIdentifier": "products",
      "position": 1,
      "templateIdentifier": null,
      "isPositionLocked": false,
      "shortDescTemplateIdentifier": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 120,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "price": {
          "type": "integer",
          "value": 150,
          "position": 1,
          "isProductPreview": false
        },
        "product-name": {
          "type": "string",
          "value": "Cosmo",
          "position": 0,
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "",
          "position": 2,
          "isProductPreview": false
        }
      },
      "isVisible": true
    }
  ]

}

Schéma

total: nombre
nombre total d'enregistrements trouvés
exemple : 100

id: nombre
identifiant de l'objet
exemple : 1764

additional: Record<string, any>
valeur supplémentaire de l'index
exemple :

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

statusLocalizeInfos: CommonLocalizeInfos
description json de l'objet d'état de l'élément, en tenant compte de la langue
exemple :

{ "title": "Produit" }

localizeInfos: Record<string, any>
description json de l'objet de données de la page principale en tenant compte de la langue "en_US" (par exemple)
exemple :

{
  "en_US": {
    "title": "Catalogue",
    "plainContent": "Contenu pour le catalogue",
    "htmlContent": "<b>Contenu pour le catalogue</b>",
    "menuTitle": "Catalogue"
  }
}

isVisible: booléen
Indicateur de visibilité de la page
exemple : true

position: nombre
numéro de position (pour le tri)
exemple : 192

templateIdentifier: chaîne
identifiant personnalisé du modèle associé
exemple : my-template

attributeSetId: nombre
identifiant de l'ensemble d'attributs
exemple : 7

blocks: tableau
blocs de produit
exemple :

["product_block"]

isSync: booléen
indicateur d'indexation de la page (true ou false)
exemple : false

attributeValues: Record<string, string>
Tableau des valeurs d'attributs de l'index (présenté sous forme de paire d'identifiant d'attribut personnalisé : valeur d'attribut)
exemple :

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

statusId: nombre
identifiants d'état de la page produit (peut être nul)
exemple : 1

sku: chaîne
valeur SKU du produit prise de l'index
exemple : 1

relatedIds: tableau
identifiants des pages de produits connexes
exemple :

[ 1, 2, 3 ]

price: nombre
valeur de prix de la page produit prise de l'index
exemple : 0

templateIdentifier chaîne
identifiant personnalisé du modèle associé
exemple : my-template

shortDescTemplateIdentifier chaîne
identifiant personnalisé du modèle associé pour la description courte
exemple : my-template-short