Réductions

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/products/thumb.jpg",
        "cover": "https://cdn.chariow.com/products/cover.jpg"
      },
      "category": {
        "value": "education_and_learning",
        "label": "Education and Learning"
      },
      "pricing": {
        "type": "one_time",
        "price": {
          "value": 99,
          "formatted": "$99.00",
          "short": "99",
          "currency": "USD"
        },
        "effective": {
          "value": 99,
          "formatted": "$99.00",
          "short": "99",
          "currency": "USD"
        }
      },
      "bundle": null,
      "metadata": null
    }
  ],
  "store": {
    "id": "store_xyz789",
    "name": "My Store",
    "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
    "url": "https://mystore.mychariow.com"
  },
  "customer_email": null,
  "usage_limit": 100,
  "usage_limit_per_customer": 1,
  "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

Type	Description	Exemple
`percentage`	Pourcentage de réduction sur le prix	20% de réduction
`fixed`	Montant fixe de réduction	10$ de réduction

Statuts de Réduction

Statut	Description
`active`	La réduction est valide et peut être utilisée (dans la plage de dates et sous la limite d’utilisation)
`expired`	La 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"

const response = await fetch('https://api.chariow.com/v1/discounts', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
});

const { data } = await response.json();

import requests

response = requests.get(
    'https://api.chariow.com/v1/discounts',
    headers={'Authorization': 'Bearer sk_live_your_api_key'}
)

discounts = response.json()['data']

Paramètres de Requête

Paramètre	Type	Description
`per_page`	integer	Nombre de réductions par page (max 100, par défaut 10)
`cursor`	string	Curseur de pagination de la réponse précédente
`status`	string	Filtrer par statut (`active`, `expired`)
`search`	string	Rechercher par code de réduction, nom ou ID public
`from`	string	Réductions créées à partir de cette date incluse (format Y-m-d). À envoyer avec `to`
`to`	string	Réductions créées jusqu’à cette date incluse (format Y-m-d). À envoyer avec `from`
`period`	string	Plage de dates de création prédéfinie, à la place de `from` et `to` : `today`, `yesterday`, `last7days`, `last30days`, `thisWeek`, `lastWeek`, `thisMonth`, `lastMonth`, `thisYear`, `lastYear`

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?from=2025-01-01&to=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

{
  "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",
          "type": "course",
          "pictures": {
            "thumbnail": "https://cdn.chariow.com/products/thumb.jpg",
            "cover": "https://cdn.chariow.com/products/cover.jpg"
          },
          "category": {
            "value": "education_and_learning",
            "label": "Education and Learning"
          },
          "pricing": {
            "type": "one_time",
            "price": {
              "value": 99,
              "formatted": "$99.00",
              "short": "99",
              "currency": "USD"
            },
            "effective": {
              "value": 99,
              "formatted": "$99.00",
              "short": "99",
              "currency": "USD"
            }
          },
          "bundle": null,
          "metadata": null
        }
      ],
      "store": {
        "id": "store_xyz789",
        "name": "My Store",
        "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
        "url": "https://mystore.mychariow.com"
      },
      "customer_email": null,
      "usage_limit": 100,
      "usage_limit_per_customer": 1,
      "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"
    }
  ],
  "pagination": {
    "count": 1,
    "path": "https://api.chariow.com/v1/discounts",
    "per_page": 10,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null,
    "has_more_pages": false,
    "has_pages": false
  }
}

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"

const response = await fetch('https://api.chariow.com/v1/discounts/dis_abc123', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
});

const { data } = await response.json();

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": "customer@example.com",
    "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 :

Limites d'Utilisation

Limitez le nombre de fois qu’une réduction peut être utilisée :

{
  "usage_limit": 100,
  "usage_limit_per_customer": 1,
  "usage_count": 45
}

Lorsque usage_count atteint usage_limit, la réduction est refusée au paiement. usage_limit_per_customer plafonne le nombre d’utilisations réussies par adresse email de client.

Restrictions de Date

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.

Restrictions de Produit

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.

Restrictions de Client

Limitez la réduction à un client spécifique :

{
  "customer_email": "vip@example.com"
}

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 :

Statut - Doit être active
Plage de dates - La date actuelle doit être comprise entre start_date et end_date (si spécifié)
Limite d’utilisation - usage_count ne doit pas avoir atteint usage_limit (si spécifié)
Limite par client - Le client ne doit pas avoir atteint usage_limit_per_customer utilisations réussies (si spécifié)
Éligibilité du produit - Le produit doit être dans le tableau products (si non vide, s’applique à tous les produits)
Éligibilité du client - L’email du client doit correspondre à customer_email (si spécifié)
Montant fixe - Une réduction fixed ne peut pas dépasser le prix actuel du produit

Le statut de la réduction passe à expired une fois sa end_date dépassée (une tâche planifiée le met à jour). Une réduction qui a atteint sa limite d’utilisation, ou dont la start_date n’est pas encore arrivée, garde le statut active mais est refusée au paiement. Si la validation échoue lors du paiement, l’API renverra un message d’erreur approprié.

Cas d’Utilisation Courants

Campagnes Promotionnelles

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) + '%'
}));

Codes d'Affiliation

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`);

Clients VIP

Créez des réductions à usage unique pour les clients VIP :

{
  "code": "VIP_CUSTOMER_ABC",
  "customer_email": "vip@example.com",
  "usage_limit": 1
}

Introduction

Guides

Intégration MCP

Intégration n8n

Resources

Objet Réduction

Types de Réduction

Statuts de Réduction

Liste des Réductions

Paramètres de Requête

Exemples de Filtrage

Exemple de Réponse

Obtenir une Réduction Spécifique

Appliquer des Réductions lors du Paiement

Restrictions de Réduction

Validation des Réductions

Cas d’Utilisation Courants

Ressources Associées

Guide de Paiement

API Réductions

​Objet Réduction

​Types de Réduction

​Statuts de Réduction

​Liste des Réductions

​Paramètres de Requête

​Exemples de Filtrage

​Exemple de Réponse

​Obtenir une Réduction Spécifique

​Appliquer des Réductions lors du Paiement

​Restrictions de Réduction

​Validation des Réductions

​Cas d’Utilisation Courants

​Ressources Associées

Guide de Paiement

API Réductions

Objet Réduction

Types de Réduction

Statuts de Réduction

Liste des Réductions

Paramètres de Requête

Exemples de Filtrage

Exemple de Réponse

Obtenir une Réduction Spécifique

Appliquer des Réductions lors du Paiement

Restrictions de Réduction

Validation des Réductions

Cas d’Utilisation Courants

Ressources Associées