Aller au contenu principal

Obtenir le nombre total de produits

Cette méthode renvoie le nombre total de produits dans votre projet. Vous pouvez éventuellement passer un corps de filtre pour ne compter que les produits correspondant à des conditions spécifiques.

✅ Objectif du scénario :

  • Obtenir le nombre total de produits
  • Filtrer éventuellement par conditions d'attribut
  • Utiliser le compte pour la pagination ou les vérifications de disponibilité

✅ Ce dont vous avez besoin :

  • Un PROJECT_URL et un APP_TOKEN valides pour l'authentification avec l'API OneEntry.
  • Au moins un produit dans le projet

📌 Important :

  • Ces exemples n'incluent pas la gestion des erreurs.
  • Vous pouvez gérer les erreurs en utilisant un bloc try-catch ou en employant une construction comme await Promise.catch((error) => error).
  • Passez un tableau vide [] pour compter tous les produits sans filtrage.

📚 Voir dans la documentation :

📦 Référence SDK :

Essayez-le en direct​

Exécutez cette méthode de manière interactive dans le bac à sable JS SDK — connectez votre Project URL et App Token lors de votre première visite, puis ouvrez :

  • Obtenir le nombre total de produits — Cette méthode renvoie le nombre total de produits dans votre projet. Vous pouvez éventuellement passer un corps de filtre pour ne compter que les produits correspondant à des conditions spécifiques.

Scénario​

1. Importer defineOneEntry depuis le SDK et définir PROJECT_URL et APP_TOKEN​

Exemple :

import { defineOneEntry } from 'oneentry';
import { IFilterParams } from 'oneentry/dist/products/productsInterfaces';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

2. Créer un client API avec defineOneEntry()​

Exemple :

const { Products } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

3. Définir éventuellement un corps de filtre (tableau vide = tous les produits)​

Exemple :

// To filter, use conditions like: [{ attributeMarker: 'price', conditionMarker: 'mth', conditionValue: 100, isNested: false }]
const body: IFilterParams[] = [];

4. Appeler Products.getProductsCount() avec getProductsCount()​

Exemple :

const data = await Products.getProductsCount(body);

if ('statusCode' in data) {
  throw new Error(data.message);
}

console.log('Count data: ', data);
Résultat :
{
  "totalAll": 12,
  "totalInCategory": 0,
  "totalInCategoryWithNested": 0
}

Exemple final​

// 1. Import defineOneEntry from SDK and define PROJECT_URL and APP_TOKEN
import { defineOneEntry } from 'oneentry';
import { IFilterParams } from 'oneentry/dist/products/productsInterfaces';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

// 2. Creating an API client with [defineOneEntry()](/docs/index/#Installation)
const { Products } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

// 3. Optionally define a filter body (empty array = all products)
// To filter, use conditions like: [{ attributeMarker: 'price', conditionMarker: 'mth', conditionValue: 100, isNested: false }]
const body: IFilterParams[] = [];

// 4. Call Products.getProductsCount() with [getProductsCount()](/docs/products/#getProductsCount)
const data = await Products.getProductsCount(body);

if ('statusCode' in data) {
  throw new Error(data.message);
}

console.log('Count data: ', data);