getProductsEmptyPage

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

Description

Cette méthode recherche des objets de page de 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 objet IProductsResponse.

Produits.getProductsEmptyPage( langCode, userQuery );

Schéma des paramètres

Schéma

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

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

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

userQuery.offset(required): number
Paramètre pour la pagination. Par défaut : 0.

userQuery.limit(required): number
Paramètre pour la pagination. Par défaut : 30.

userQuery.sortOrder(required): string
Ordre de tri "DESC" | "ASC". Par défaut : "DESC".

userQuery.sortKey(required): string
Champ pour le tri (par défaut - null). Valeurs possibles : "id", "position", "title", "date", "price". Par défaut : null.

userQuery.templateMarker: string | null
Marqueur de modèle de page de produit, par défaut null.
exemple : "template_12345"

userQuery.statusMarker: string | null
Marqueur de statut de page de produit, par défaut null.
exemple : "in_stock"

userQuery.conditionValue: string | null
La valeur recherchée, par défaut null.
exemple : "new"

userQuery.attributeMarker: string | null
L'identifiant textuel de l'attribut indexé par lequel les valeurs sont filtrées, par défaut null.
exemple : "color"

userQuery.conditionMarker: string | null
Marqueur de la condition de filtre par laquelle les valeurs sont filtrées, par défaut null.
exemple : "equals"

Exemples

Exemple minimal

const response = await Products.getProductsEmptyPage();

Exemple avec des attributs

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

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

Exemple de réponse

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

Schéma de réponse

Schéma : IProductsResponse

total: number
Le nombre total de produits trouvés.
exemple : 100

items: IProductsEntity[]
Un tableau d'entités de produit.
exemple :

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

---