Passer au contenu principal
Les réductions vous permettent d’offrir des tarifs promotionnels à vos clients. Créez des réductions en pourcentage ou à montant fixe avec des limites d’utilisation optionnelles, des dates d’expiration, des restrictions de produits et des codes spécifiques aux clients.

​
Objet Réduction

Une réduction contient les informations suivantes : 
{
  "id": "dis_abc123",
  "name": "Summer Sale",
  "code": "SUMMER20",
  "type": "percentage",
  "status": "active",
  "value_off": {
    "raw": 20,
    "formatted": "20%"
  },
  "products": [
    {
      "id": "prd_def456",
      "name": "Premium Course",
      "type": "course",
      "pictures": {
        "thumbnail": "https://cdn.chariow.com/thumb.jpg",
        "cover": "https://cdn.chariow.com/cover.jpg"
      },
      "category": {
        "value": "education",
        "label": "Education"
      },
      "pricing": {
        "type": "one_time",
        "price": {
          "raw": 99.99,
          "formatted": "$99.99"
        }
      },
      "bundle": null
    }
  ],
  "store": {
    "id": "str_xyz789",
    "name": "My Store"
  },
  "customer_email": null,
  "usage_limit": 100,
  "usage_count": 45,
  "start_date": "2025-06-01T00:00:00+00:00",
  "end_date": "2025-08-31T23:59:59+00:00",
  "is_auto_generated": false,
  "created_at": "2025-05-15T10:00:00+00:00",
  "updated_at": "2025-06-20T15:30:00+00:00"
}

​
Types de Réduction

TypeDescriptionExemple
percentagePourcentage de réduction sur le prix20% de réduction
fixedMontant fixe de réduction10$ de réduction

​
Statuts de Réduction

StatutDescription
activeLa réduction est valide et peut être utilisée (dans la plage de dates et sous la limite d’utilisation)
expiredLa réduction a dépassé sa date de fin ou la limite d’utilisation a été atteinte

​
Liste des Réductions

Récupérez toutes les réductions de votre boutique : 
curl -X GET "https://api.chariow.com/v1/discounts" \
  -H "Authorization: Bearer sk_live_your_api_key"

​
Paramètres de Requête

ParamètreTypeDescription
per_pageintegerNombre de réductions par page (max 100, par défaut 15)
cursorstringCurseur de pagination de la réponse précédente
statusstringFiltrer par statut (active, expired)
searchstringRechercher par code de réduction, nom ou ID public
start_datestringFiltrer les réductions créées à partir de cette date (format Y-m-d)
end_datestringFiltrer les réductions créées jusqu’à cette date (format Y-m-d)

​
Exemples de Filtrage

# Obtenir uniquement les réductions actives
curl -X GET "https://api.chariow.com/v1/discounts?status=active" \
  -H "Authorization: Bearer sk_live_your_api_key"

# Rechercher un code ou un nom spécifique
curl -X GET "https://api.chariow.com/v1/discounts?search=SUMMER" \
  -H "Authorization: Bearer sk_live_your_api_key"

# Filtrer par plage de dates
curl -X GET "https://api.chariow.com/v1/discounts?start_date=2025-01-01&end_date=2025-01-31" \
  -H "Authorization: Bearer sk_live_your_api_key"

# Combiner plusieurs filtres
curl -X GET "https://api.chariow.com/v1/discounts?status=active&search=VIP&per_page=50" \
  -H "Authorization: Bearer sk_live_your_api_key"

​
Exemple de Réponse

{
  "message": "success",
  "data": {
    "data": [
      {
        "id": "dis_abc123",
        "name": "Summer Sale",
        "code": "SUMMER20",
        "type": "percentage",
        "status": "active",
        "value_off": {
          "raw": 20,
          "formatted": "20%"
        },
        "products": [
          {
            "id": "prd_def456",
            "name": "Premium Course"
          }
        ],
        "store": {
          "id": "str_xyz789",
          "name": "My Store"
        },
        "customer_email": null,
        "usage_count": 45,
        "usage_limit": 100,
        "start_date": "2025-06-01T00:00:00+00:00",
        "end_date": "2025-08-31T23:59:59+00:00",
        "is_auto_generated": false,
        "created_at": "2025-05-15T10:00:00+00:00",
        "updated_at": "2025-06-20T15:30:00+00:00"
      }
    ],
    "pagination": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  },
  "errors": []
}

​
Obtenir une Réduction Spécifique

Récupérez une réduction spécifique par son ID public : 
curl -X GET "https://api.chariow.com/v1/discounts/dis_abc123" \
  -H "Authorization: Bearer sk_live_your_api_key"

​
Appliquer des Réductions lors du Paiement

Utilisez un code de réduction lors de l’initiation du paiement : 
curl -X POST "https://api.chariow.com/v1/checkout" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "prd_abc123",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "phone": {
      "number": "1234567890",
      "country_code": "US"
    },
    "discount_code": "SUMMER20"
  }'

​
Restrictions de Réduction

Les réductions peuvent avoir diverses restrictions :
Limitez le nombre de fois qu’une réduction peut être utilisée :
{
  "usage_limit": 100,
  "usage_count": 45
}
Lorsque usage_count atteint usage_limit, la réduction devient invalide.
Définissez des dates de début et de fin pour la réduction :
{
  "start_date": "2025-06-01T00:00:00+00:00",
  "end_date": "2025-08-31T23:59:59+00:00"
}
La réduction n’est valide qu’entre ces dates.
Limitez la réduction à des produits spécifiques :
{
  "products": [
    { "id": "prd_abc123", "name": "Course A" },
    { "id": "prd_def456", "name": "Course B" }
  ]
}
Si products est vide, la réduction s’applique à tous les produits.
Limitez la réduction à un client spécifique :
{
  "customer_email": "[email protected]"
}
Seul le client spécifié peut utiliser cette réduction.

​
Validation des Réductions

Lors de l’application d’une réduction au moment du paiement, elle est automatiquement validée selon ces critères :
  1. Statut - Doit être active
  2. Plage de dates - La date actuelle doit être comprise entre start_date et end_date (si spécifié)
  3. Limite d’utilisation - usage_count ne doit pas avoir atteint usage_limit (si spécifié)
  4. Éligibilité du produit - Le produit doit être dans le tableau products (si non vide, s’applique à tous les produits)
  5. Éligibilité du client - L’email du client doit correspondre à customer_email (si spécifié)
Le statut de la réduction est automatiquement mis à jour à expired lorsque :
  • La end_date est dépassée
  • La date actuelle est antérieure à start_date
  • La usage_limit a été atteinte
Si la validation échoue lors du paiement, l’API renverra un message d’erreur approprié.

​
Cas d’Utilisation Courants

Suivez les performances des réductions pour les campagnes marketing :
const discounts = await getDiscounts({ status: 'active' });

const campaignStats = discounts.map(d => ({
  code: d.code,
  uses: d.usage_count,
  remaining: d.usage_limit - d.usage_count,
  conversionRate: (d.usage_count / d.usage_limit * 100).toFixed(1) + '%'
}));
Créez des codes de réduction uniques pour les affiliés et suivez leur utilisation :
// Récupérer une réduction par son ID public
const response = await fetch('https://api.chariow.com/v1/discounts/dis_affiliate123', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
});

const { data: discount } = await response.json();
console.log(`Le code d'affiliation ${discount.code} a été utilisé ${discount.usage_count} fois`);
Créez des réductions à usage unique pour les clients VIP :
{
  "code": "VIP_CUSTOMER_ABC",
  "customer_email": "[email protected]",
  "usage_limit": 1
}

​
Ressources Associées

Guide de Paiement

Appliquez des réductions lors du paiement

API Réductions

Consultez la référence complète de l’API Réductions