# Gutscheine

## Gutscheinobjekt

Das Objekt `coupon` stellt einen Rabattgutschein dar, der auf einen Auftrag angewendet werden kann. Es besitzt folgende Eigenschaften:

## Eigenschaften

| Eigenschaft | Typ | Beschreibung |
| --- | --- | --- |
| `reference_name` | string | Interner Referenzname, der Kunden nicht angezeigt wird. |
| `code` | string | Code, mit dem Kunden den Gutschein einlösen. Er sollte eindeutig und leicht zu merken sein. |
| `note` | string | Kunden angezeigter Hinweis beim Anwenden des Gutscheins, etwa mit Informationen zum Rabatt. |
| `coupon_type` | string | Gutscheinart. Gültige Werte: `"direct_discount"` und `"gift"`. |
| `discount_type` | string | Rabattart. Gültige Werte: `"flat"` und `"percent"`. |
| `discount_value` | number | Rabattwert: je nach `discount_type` ein fester Betrag oder Prozentsatz. |
| `min_amount` | number | Mindestbestellwert zur Verwendung des Gutscheins. |
| `max_amount` | number | Höchstbestellwert, auf den der Gutschein angewendet werden kann. |
| `max_discount` | number | Höchstmöglicher Rabatt. |
| `max_uses` | number | Maximale Anzahl der Gutscheineinlösungen. |
| `max_uses_user` | number | Maximale Anzahl der Einlösungen pro Nutzer. |
| `new_user` | boolean | Gibt an, ob der Gutschein nur für neue Nutzer verfügbar ist. |
| `start_at` | string | Datum und Uhrzeit, ab denen der Gutschein verfügbar ist. |
| `end_at` | string | Ablaufdatum und -uhrzeit des Gutscheins. |
| `active` | boolean | Gibt an, ob der Gutschein derzeit aktiv ist. |

## Beispiel

Beispiel für ein `coupon`-Objekt:

```json
{
    "coupon": {
        "reference_name": "Holiday Campaign",
        "code": "HOLIDAY",
        "note": "Great! You have received $10 disount.",
        "coupon_type": "direct_discount",
        "discount_type": "flat",
        "discount_value": 10,
        "min_amount": 100,
        "max_amount": 0,
        "max_discount": 10,
        "max_uses": 1000,
        "max_uses_user": 1,
        "new_user": true,
        "start_at": "2022-12-12 00:00:00",
        "end_at": "2022-12-31 00:00:00",
        "active": true
    }
}
```