Passer au contenu principal
Les produits sont au cœur de votre boutique Chariow. Ce guide explique comment récupérer et travailler avec les produits via l’API publique.

Types de produits

Chariow prend en charge plusieurs types de produits :

Catégories de produits

Les produits sont organisés selon les catégories suivantes :

États des produits

Les produits peuvent être dans différents états :
  • Draft - Non visible pour les clients, encore en cours de modification
  • Published - Disponible à l’achat sur votre boutique
  • Archived - Plus disponible mais conservé dans les archives
L’API publique retourne uniquement les produits publiés. Les produits en brouillon et archivés ne sont pas accessibles via l’API.

Lister les produits

Récupérez tous les produits publiés de votre boutique avec filtrage optionnel :

Paramètres de requête

Pagination

L’API utilise une pagination basée sur les curseurs pour une récupération efficace des données :

Exemple de réponse

Récupérer un produit unique

Récupérez les informations détaillées d’un produit spécifique par son ID public ou son slug :

Détails du produit

Le point de terminaison pour un produit unique retourne des informations complètes incluant :
  • Tarification : Prix actuel, prix de base, prix effectif, prix de vente (si applicable), prix minimum, prix suggéré et pourcentage de réduction (price_off)
  • Images : Miniature et images de couverture via pictures
  • Catégorie : Catégorie du produit avec valeur et libellé
  • Tarification par variante : Indique si le produit a une tarification par variante (has_variant_pricing)
  • Évaluations : Note moyenne et nombre d’avis via rating
  • Ventes : Nombre de ventes (si non masqué) via sales_count
  • Quantité : Informations sur le stock (si le produit a une quantité limitée)
  • Paramètres : Paramètres du produit tels que is_shipping_address_required
  • Expiration de la promotion : Date et heure on_sale_until pour la tarification promotionnelle temporaire
  • Texte CTA personnalisé : Texte d’appel à l’action personnalisé via custom_cta_text
  • Offre groupée : Informations sur les économies pour les produits groupés
  • Champs personnalisés : Champs de produit supplémentaires via fields (lorsque chargés)
  • SEO : Métadonnées SEO via seo (lorsque chargées)
  • Boutique : Informations sur la boutique (lorsque chargées)

Types de tarification

Les produits peuvent avoir différents modèles de tarification :
Un prix fixe que les clients paient une fois pour accéder au produit. C’est le type de tarification le plus courant.
Les clients choisissent le montant à payer, avec un prix minimum et un prix suggéré optionnels. Utile pour les dons, les logiciels à contribution ou la tarification déterminée par le client.
Produits disponibles gratuitement, souvent utilisés pour la génération de leads, les cadeaux ou les contenus d’exemple.
Les produits peuvent avoir des prix promotionnels temporaires avec une date d’expiration. Le current_price reflète le prix actif.

Offres groupées

Les offres groupées combinent plusieurs produits à un prix réduit. Lors de la récupération d’une offre groupée, vous recevrez des informations sur la valeur totale du groupe et les économies réalisées :
Le bundle.value indique la valeur totale si tous les produits étaient achetés séparément, tandis que pricing.current_price indique le prix réduit de l’offre groupée. Le bundle.savings montre combien les clients économisent en achetant l’offre groupée.

Travailler avec les données de produit

Filtrer les produits

Vous pouvez combiner plusieurs filtres pour affiner vos requêtes de produits :

Comprendre les évaluations

Les produits incluent des informations d’évaluation avec la note moyenne et le nombre total :
  • average : Note de 0 à 5
  • count : Nombre total d’évaluations reçues

Quantité en stock

Pour les produits avec stock limité, le champ quantity fournit des informations détaillées :
Les produits sans stock limité auront quantity: null.

Formatage des prix

Tous les objets de prix incluent quatre champs pour un affichage flexible :
  • value : Valeur numérique du montant (ex. 99 pour $99.00)
  • formatted : Chaîne prête à afficher (ex. $99.00, £99.00, €99.00)
  • short : Chaîne abrégée lisible avec forHumans (ex. 99, 5K, 1.25M)
  • currency : Code de devise ISO (ex. USD, EUR, GBP)

Cas d’utilisation courants

Créer un catalogue de produits

Afficher les produits en promotion

Trouver les produits populaires

Bonnes pratiques

Utilisez toujours la pagination basée sur les curseurs au lieu de récupérer tous les produits en une seule fois. Cela garantit une récupération efficace des données et évite les dépassements de délai.
Les données de produit ne changent pas fréquemment. Envisagez de mettre en cache les produits localement et de les actualiser périodiquement pour réduire les appels API.
Tous les produits n’ont pas d’images miniatures ou de couverture. Vérifiez toujours les valeurs null avant d’afficher les images.
Utilisez le champ formatted des objets de prix pour l’affichage. Cela garantit un formatage correct des devises et des symboles.
Lors de l’affichage des prix promotionnels, vérifiez que on_sale_until est dans le futur pour éviter d’afficher des promotions expirées.

Prochaines étapes

Lister les produits

Consultez la référence API pour lister les produits

Récupérer un produit

Consultez la référence API pour récupérer un produit

Guide de paiement

Apprenez à créer des sessions de paiement

Authentification

Apprenez comment fonctionne l’authentification API