Kuponlar
Kuponu geri getir
POST/v1/coupons/{id}/restore
Arşivdeki kuponu yeniden kullanıma açın.
- Gereken izin
Bearer anahtarı ve
archive:write,coupons:write- Maliyet
0 puan (bağlantı başına 60 saniyede 600 puan)
- Tekrar anahtarı
Gerekir:
Idempotency-Keybaşlığı.
İstek
Temel adres: https://api.siparis.app/v1
Yol parametreleri
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
id | metin | Evet | Okunacak kaynağın cpn_ önekli dış kimliği. | "cpn_1234567890abcdef1234567890abcdef" |
Başlıklar
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
Idempotency-Key | metin · null olabilir | Evet | Zorunlu tekrar anahtarı; en çok 200 karakter. Yeni işte yeni değer; ağ tekrarında aynı gövde ve aynı değer. | "ilk-esitleme-20261016-001" |
If-Match | metin · null olabilir | Hayır | İsteğe bağlı önkoşul: son ETag değerini çift tırnaklarıyla gönderin. Komutun kilidi altında farklıysa 412 revision_mismatch. | "\"3\"" |
Gövde (application/json)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|
Örnek istek
curl --fail-with-body --silent --show-error --request POST \
"${SIPARIS_API_URL:-https://api.siparis.app/v1}/coupons/cpn_1234567890abcdef1234567890abcdef/restore" \
-H "Authorization: Bearer $SIPARIS_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: ornek-post-v1-coupons-cpn-1234567890abcdef1234567890abcdef-restore-001' \
--data-binary @- <<'JSON'
{}
JSONimport 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"],
"Content-Type": "application/json",
"Idempotency-Key": "ornek-post-v1-coupons-cpn-1234567890abcdef1234567890abcdef-restore-001",
}
request = Request(base + "/coupons/cpn_1234567890abcdef1234567890abcdef/restore", headers=headers, method="POST",
data="{}".encode("utf-8"))
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
// 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/cpn_1234567890abcdef1234567890abcdef/restore", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": "ornek-post-v1-coupons-cpn-1234567890abcdef1234567890abcdef-restore-001",
},
redirect: "manual", // 307 hedefini Bearer olmadan ayrı istekte okuyun.
signal: AbortSignal.timeout(30_000),
body: JSON.stringify({}),
});
const text = await response.text();
if (!response.ok) throw new Error(`${response.status}: ${text}`);
console.log(text);
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ı uygulayın.
Yanıt
200 İstek başarıyla tamamlandı.
İçerik türü: application/json
{
"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"
}Yanıt alanları (23)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
archived | true/false | Evet | Arşivdeyse true; sepette uygulanmaz. | false |
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. | |
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 |
code | metin | Evet | Müşterinin kullanacağı normalleştirilmiş kupon kodu. | "MERHABA10" |
created_at | tarih-saat | Evet | Oluşturulma zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
currency | sabit "TRY" | Evet | Tutarların para birimi. | "TRY" |
customer_restricted | true/false | Evet | Panelden belirli müşterilere atanmışsa true; müşteri kimlikleri ve kişisel alanlar yayımlanmaz. | false |
discount_type | metin (seçenekler: percentage, fixed) · null olabilir | Evet | Yüzde veya TRY tutarı; yalnız ücretsiz kargoda boş olabilir. | "percentage" |
discount_value | metin · null olabilir | Evet | İndirim oranı veya TRY tutarı; ondalık metin. | "10.00" |
exclude_discounted | true/false | Evet | İndirimli ve kampanyalı ürünleri kapsam dışında tutar. | false |
first_order_only | true/false | Evet | Yalnız müşterinin ilk siparişinde geçerliyse true. | false |
free_shipping | true/false | Evet | Kupon geçerliyken kargo da ücretsizse true. | false |
id | metin | Evet | cpn_ önekli dış kupon kimliği. | "cpn_1234567890abcdef1234567890abcdef" |
max_uses | tam sayı · null olabilir | Evet | Toplam kullanım sınırı; null sınırsız. | 100 |
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 |
min_order | metin · null olabilir | Evet | Kupona uygun ürünlerde en az sepet tutarı, TRY. | "100.00" |
revision | tam sayı | Evet | Kaydın revizyonu; If-Match için ETag ile birlikte kullanılır. | 1 |
status | metin (seçenekler: active, inactive) | Evet | active açık, inactive kapalı kupon. | "active" |
store | metin | Evet | Kuponun geçerli olduğu sto_ markası. | "sto_1234567890abcdef1234567890abcdef" |
updated_at | tarih-saat | Evet | Son değişiklik zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
used_count | tam sayı | Evet | Panelin siparişlerden hesapladığı kullanım sayısı; iptal ve tam iadeler sayılmaz. | 0 |
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" |
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" |
Bu uca özgü yanıt başlıkları: ETag (Kaynağın güçlü sürüm etiketi; If-Match için tırnaklarıyla saklayın.).
Hatalar
| HTTP | code | Anlamı | Nasıl düzelir? |
|---|---|---|---|
| 403 | forbidden | Mevcut ticari kural bu işlemi yapmanıza izin vermiyor. | Gerekli kapsamları ve siparişin durumunu kontrol edin. |
| 400 | invalid_if_match | If-Match geçerli bir güçlü ETag değil. | GET kaynak yanıtındaki ETag değerini çift tırnaklarıyla aynen kullanın. |
| 412 | revision_mismatch | Kayıt siz okuduktan sonra değişmiş. | Güncel kaydı okuyun; düzeltmeyi yeniden değerlendirip yeni tekrar anahtarıyla gönderin. |
| 409 | coupon_code_taken | Kupon kodu bu markada başka kuponda kullanılıyor. | Başka kod seçin veya mevcut kuponu güncelleyin; yeni tekrar anahtarı kullanın. |
| 409 | coupon_restore_conflict | Kupon arşivde değil. | Güncel kaydı okuyun. |
| 422 | store_required | Çok markalı işletmede kaydın markası eksik. | /me yanıtındaki sto_ kimliğini store alanına yazın. |
| 403 | store_forbidden | Anahtar başka markaya yazamaz. | Anahtarın kendi markasını seçin; marka sınırı gövdeyle genişletilmez. |
Ortak hatalar (anahtar, izin, istek biçimi, hız sınırı, tekrar anahtarı) her uçta aynıdır: Hata kodları › Ortak hatalar.