# Kuponları listele

`GET /v1/coupons` · Grup: Kuponlar

Markanın veya işletmenin kuponlarını ve kullanım sayılarını alın.

> **Bilmeniz gerekenler:** id artan sırayla ve imleçle gelir; store ile marka seçilebilir. Kullanım sayıları siparişlerden hesaplanır. Kişisel veriler yayımlanmaz.

- **Gereken izin:** Bearer anahtarı ve `coupons:read`
- **Maliyet:** 2 puan (bağlantı başına 60 saniyede 600 puan)
- **Tekrar anahtarı:** Gerekmez (okuma).

## İstek

Temel adres: `https://api.siparis.app/v1`. Yol: `/v1/coupons`.

### Sorgu parametreleri

| Alan | Tür | Zorunlu | Açıklama | Örnek |
| --- | --- | --- | --- | --- |
| `archived` | true/false | Hayır | true arşivdeki ve kapalı kayıtları da içerir; varsayılan false. | `false` |
| `store` | metin · null olabilir | Hayır | Marka dış kimliği (sto_ ve 32 küçük onaltılık karakter). | `"sto_1234567890abcdef1234567890abcdef"` |
| `limit` | tam sayı (en az 1; en çok 100) | Hayır | Sayfa başına en fazla kayıt/olay adayı; varsayılan 50, aralık 1–100. | `50` |
| `cursor` | metin (en çok 4096 karakter) · null olabilir | Hayır | Önceki yanıttaki next_cursor; aynı yetki ve süzgeçlerle değiştirmeden gönderin. | `"SUNUCUDAN_DONEN_IMLEC"` |

## Örnek istek

Kimlik içeren yollarda örnek kimliği kendi liste yanıtınızdan alın. `SIPARIS_API_KEY` sunucu ortamında tanımlı olmalı; yerelde `SIPARIS_API_URL` ile /v1 içeren adresi değiştirin. Üretimde [tekrar kurallarını](https://developer.siparis.app/hiz-siniri) uygulayın.

### curl


```bash
curl --fail-with-body --silent --show-error --request GET \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/coupons?limit=50" \
  -H "Authorization: Bearer $SIPARIS_API_KEY"
```


### Python


```python
import json
import os
from urllib.request import Request, build_opener, HTTPRedirectHandler
from urllib.error import HTTPError

# İmzalı indirme hedefine Bearer taşımamak için yönlendirme kendiliğinden izlenmez.
class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

base = os.environ.get("SIPARIS_API_URL", "https://api.siparis.app/v1")
headers = {
    "Authorization": "Bearer " + os.environ["SIPARIS_API_KEY"],
}
request = Request(base + "/coupons?limit=50", headers=headers, method="GET")
try:
    with build_opener(NoRedirect).open(request, timeout=30) as response:
        print(response.read().decode("utf-8"))
except HTTPError as error:
    print(error.code, error.read().decode("utf-8"))
    raise
```


### TypeScript


```typescript
// Node.js 22+; anahtar yalnız sunucunun ortam değişkenindedir.
const base = process.env.SIPARIS_API_URL ?? "https://api.siparis.app/v1";
if (!process.env.SIPARIS_API_KEY) throw new Error("SIPARIS_API_KEY gerekli");
const response = await fetch(base + "/coupons?limit=50", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
  },
  redirect: "manual", // 307 hedefini Bearer olmadan ayrı istekte okuyun.
  signal: AbortSignal.timeout(30_000),
});
const text = await response.text();
if (!response.ok) throw new Error(`${response.status}: ${text}`);
console.log(text);
```


## Yanıt

### 200 · İstek başarıyla tamamlandı.

İçerik türü: `application/json`.


```json
{
  "data": [
    {
      "archived": false,
      "categories": [],
      "category_restricted": false,
      "code": "MERHABA10",
      "created_at": "2026-10-16T09:00:00Z",
      "currency": "TRY",
      "customer_restricted": false,
      "discount_type": "percentage",
      "discount_value": "10.00",
      "exclude_discounted": false,
      "first_order_only": false,
      "free_shipping": false,
      "id": "cpn_1234567890abcdef1234567890abcdef",
      "max_uses": 100,
      "max_uses_per_customer": 1,
      "min_order": "100.00",
      "revision": 1,
      "status": "active",
      "store": "sto_1234567890abcdef1234567890abcdef",
      "updated_at": "2026-10-16T09:00:00Z",
      "used_count": 0,
      "valid_from": "2026-10-16",
      "valid_until": "2026-12-31T23:59"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

Yanıt alanları:

| Alan | Tür | Zorunlu | Açıklama | Örnek |
| --- | --- | --- | --- | --- |
| `data` | liste: nesne | Evet | Bu sayfanın görünür kayıtları; boş liste de geçerli bir sayfadır. |  |
| `data[].archived` | true/false | Evet | Arşivdeyse true; sepette uygulanmaz. | `false` |
| `data[].categories` | liste: metin | Evet | Görünür cat_ kategori kimlikleri; alt kategoriler dahil. Marka sınırı bazı kimlikleri gizleyebilir; kapsamı category_restricted belirtir. |  |
| `data[].category_restricted` | true/false | Evet | Kupon kategoriyle sınırlıysa true; categories boş görünse de kapsam bütün ürünler olmayabilir. | `false` |
| `data[].code` | metin | Evet | Müşterinin kullanacağı normalleştirilmiş kupon kodu. | `"MERHABA10"` |
| `data[].created_at` | tarih-saat | Evet | Oluşturulma zamanı; RFC 3339 UTC. | `"2026-10-16T09:00:00Z"` |
| `data[].currency` | sabit "TRY" | Evet | Tutarların para birimi. | `"TRY"` |
| `data[].customer_restricted` | true/false | Evet | Panelden belirli müşterilere atanmışsa true; müşteri kimlikleri ve kişisel alanlar yayımlanmaz. | `false` |
| `data[].discount_type` | metin (seçenekler: percentage, fixed) · null olabilir | Evet | Yüzde veya TRY tutarı; yalnız ücretsiz kargoda boş olabilir. | `"percentage"` |
| `data[].discount_value` | metin · null olabilir | Evet | İndirim oranı veya TRY tutarı; ondalık metin. | `"10.00"` |
| `data[].exclude_discounted` | true/false | Evet | İndirimli ve kampanyalı ürünleri kapsam dışında tutar. | `false` |
| `data[].first_order_only` | true/false | Evet | Yalnız müşterinin ilk siparişinde geçerliyse true. | `false` |
| `data[].free_shipping` | true/false | Evet | Kupon geçerliyken kargo da ücretsizse true. | `false` |
| `data[].id` | metin | Evet | cpn_ önekli dış kupon kimliği. | `"cpn_1234567890abcdef1234567890abcdef"` |
| `data[].max_uses` | tam sayı · null olabilir | Evet | Toplam kullanım sınırı; null sınırsız. | `100` |
| `data[].max_uses_per_customer` | tam sayı · null olabilir | Evet | Aynı müşteri için kullanım sınırı; null sınırsız. | `1` |
| `data[].min_order` | metin · null olabilir | Evet | Kupona uygun ürünlerde en az sepet tutarı, TRY. | `"100.00"` |
| `data[].revision` | tam sayı | Evet | Kaydın revizyonu; If-Match için ETag ile birlikte kullanılır. | `1` |
| `data[].status` | metin (seçenekler: active, inactive) | Evet | active açık, inactive kapalı kupon. | `"active"` |
| `data[].store` | metin | Evet | Kuponun geçerli olduğu sto_ markası. | `"sto_1234567890abcdef1234567890abcdef"` |
| `data[].updated_at` | tarih-saat | Evet | Son değişiklik zamanı; RFC 3339 UTC. | `"2026-10-16T09:00:00Z"` |
| `data[].used_count` | tam sayı | Evet | Panelin siparişlerden hesapladığı kullanım sayısı; iptal ve tam iadeler sayılmaz. | `0` |
| `data[].valid_from` | metin · null olabilir | Evet | Markanın yerel takvim günü (YYYY-MM-DD) veya dakika dahil saati (YYYY-MM-DDTHH:MM); null sınırsız. | `"2026-10-16"` |
| `data[].valid_until` | metin · null olabilir | Evet | Markanın yerel bitiş günü veya saati; gün ve son dakika dahildir. null sınırsız. | `"2026-12-31T23:59"` |
| `has_more` | true/false | Evet | Taranacak başka sayfa varsa true; olaylarda boş data ile de true olabilir. | `false` |
| `next_cursor` | metin · null olabilir | Evet | Sonraki sayfa için aynen gönderilecek opak imleç; kaynak listesi bittiyse null. | `null` |

## Hatalar

Bu uca özgü hata yok.

Ortak hatalar (anahtar, izin, istek biçimi, hız sınırı, tekrar anahtarı) her uçta aynıdır: [Hata kodları › Ortak hatalar](https://developer.siparis.app/hatalar#ortak-hatalar).
