---
url: https://docs.youcan.shop/store-admin/coupons/create.md
---
# Create a Coupon

Endpoint: `https://api.youcan.shop/coupons`

Method: `POST`

## Required Scopes

* `edit-coupons`

## Parameters

| Param Name | Param Type | Description | Required |
| --- | --- | --- | --- |
| `code` | string | Code in alpha numeric | yes |
| `description` | string | Description | yes |
| `value` | float | Coupon value in fixed price or percentage | yes |
| `type` | int | Value type 1: percentage, 2: Fixed | yes |
| `start_date` | int | Start date of coupon validity (unix timestamp) | yes |
| `end_date` | int | End date of coupon validity (unix timestamp) | no |
| `max_usage` | int | How many times the coupon can be used | no |
| `product_ids` | string\[] | List of product IDs the coupon is valid for | yes |

## Response

\[201] Created

```json
 {
    "id": "5913f1f7-f14d-4046-8a7d-701ab8189f11",
    "code": "code0332",
    "description": "coupoun 02 from api",
    "value": 5,
    "type": 1,
    "type_text": "percentage",
    "start_date": 1619308800,
    "end_date": 1619395200,
    "max_usage": 55,
    "status": "Expired"
}
```