Collections (StoreCollection)

Le module StoreCollectionModule permet de créer des collections de produits (manuelles ou dynamiques) pour les mettre en avant.

Accès : client.app.store.collection

Méthodes

`create`

Crée une nouvelle collection.

Exemple


const response = await client.app.store.collection.create({
  appId: "app_id",
  apiKey: "user_api_key",
  title: "Nouveautés Été",
  description: "Notre sélection pour l'été",
  productIds: ["product_id_1", "product_id_2"]
});

Paramètres

Champs requis :

appId: ID de l’application
apiKey: Clé API de l’utilisateur
title: Titre de la collection

Champs optionnels :

description: Description
slug: URL slug
image: Image de couverture
type: MANUAL ou AUTOMATIC (défaut: MANUAL)
productIds: Liste des IDs de produits (si manuel)
isActive: Activer/Désactiver (défaut: true)
sellerId: ID du vendeur (si applicable)

Réponse


{
  "success": true,
  "data": {
    "id": "collection_id",
    "title": "Nouveautés Été",
    // ...
  }
}

`list`

Liste les collections avec pagination, recherche et filtres.

Exemple


const response = await client.app.store.collection.list({
  appId: "app_id",
  apiKey: "user_api_key",
  search: "Été", // Recherche par titre, description ou slug
  isActive: true, // Filtrer les collections actives
  page: 1,
  limit: 20
});

Paramètres

Champs requis :

appId: ID de l’application
apiKey: Clé API de l’utilisateur

Filtres optionnels :

search: Recherche textuelle (string)
ids: Filtrer par liste d’IDs (string[])
sellerId: Filtrer par vendeur (string)
type: Filtrer par type (MANUAL, AUTOMATIC)
isActive: Filtrer par état d’activation (boolean)
page: Numéro de page (défaut: 1)
limit: Nombre d’éléments par page (défaut: 20, max: 100)

Réponse


{
  "success": true,
  "data": [
    { "id": "col1", "title": "Été 2024", ... },
    { "id": "col2", "title": "Hiver 2024", ... }
  ],
  "meta": {
    "total": 10,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

`get`

Récupère les détails d’une collection.

Exemple


const response = await client.app.store.collection.get({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "collection_id"
});

`update`

Met à jour une collection.

Exemple


const response = await client.app.store.collection.update({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "collection_id",
  title: "Soldes d'hiver",
  isActive: false
});

`delete`

Supprime une collection.

Exemple


const response = await client.app.store.collection.delete({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "collection_id"
});