İçeriğe geç
siparis.app geliştiriciAnahtarları yönet ↗

Kuponlar

Kuponu arşivle

POST/v1/coupons/{id}/archive

Kuponu kullanımdan kaldırın; geçmişi silinmez.

Gereken izin

Bearer anahtarı ve archive:write, coupons:write

Maliyet

0 puan (bağlantı başına 60 saniyede 600 puan)

Tekrar anahtarı

Gerekir: Idempotency-Key başlığı.

İstek

Temel adres: https://api.siparis.app/v1

Yol parametreleri

AlanTürZorunluAçıklamaÖrnek
idmetinEvetOkunacak kaynağın cpn_ önekli dış kimliği."cpn_1234567890abcdef1234567890abcdef"

Başlıklar

AlanTürZorunluAçıklamaÖrnek
Idempotency-Keymetin · null olabilirEvetZorunlu 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-Matchmetin · null olabilirHayı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)

AlanTürZorunluAçıklamaÖrnek

Örnek istek

curl --fail-with-body --silent --show-error --request POST \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/coupons/cpn_1234567890abcdef1234567890abcdef/archive" \
  -H "Authorization: Bearer $SIPARIS_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: ornek-post-v1-coupons-cpn-1234567890abcdef1234567890abcdef-archive-001' \
  --data-binary @- <<'JSON'
{}
JSON
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"],
    "Content-Type": "application/json",
    "Idempotency-Key": "ornek-post-v1-coupons-cpn-1234567890abcdef1234567890abcdef-archive-001",
}
request = Request(base + "/coupons/cpn_1234567890abcdef1234567890abcdef/archive", 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/archive", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": "ornek-post-v1-coupons-cpn-1234567890abcdef1234567890abcdef-archive-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)
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseEvetArşivdeyse true; sepette uygulanmaz.false
categoriesliste: metinEvetGörünür cat_ kategori kimlikleri; alt kategoriler dahil. Marka sınırı bazı kimlikleri gizleyebilir; kapsamı category_restricted belirtir.
category_restrictedtrue/falseEvetKupon kategoriyle sınırlıysa true; categories boş görünse de kapsam bütün ürünler olmayabilir.false
codemetinEvetMüşterinin kullanacağı normalleştirilmiş kupon kodu."MERHABA10"
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
currencysabit "TRY"EvetTutarların para birimi."TRY"
customer_restrictedtrue/falseEvetPanelden belirli müşterilere atanmışsa true; müşteri kimlikleri ve kişisel alanlar yayımlanmaz.false
discount_typemetin (seçenekler: percentage, fixed) · null olabilirEvetYüzde veya TRY tutarı; yalnız ücretsiz kargoda boş olabilir."percentage"
discount_valuemetin · null olabilirEvetİndirim oranı veya TRY tutarı; ondalık metin."10.00"
exclude_discountedtrue/falseEvetİndirimli ve kampanyalı ürünleri kapsam dışında tutar.false
first_order_onlytrue/falseEvetYalnız müşterinin ilk siparişinde geçerliyse true.false
free_shippingtrue/falseEvetKupon geçerliyken kargo da ücretsizse true.false
idmetinEvetcpn_ önekli dış kupon kimliği."cpn_1234567890abcdef1234567890abcdef"
max_usestam sayı · null olabilirEvetToplam kullanım sınırı; null sınırsız.100
max_uses_per_customertam sayı · null olabilirEvetAynı müşteri için kullanım sınırı; null sınırsız.1
min_ordermetin · null olabilirEvetKupona uygun ürünlerde en az sepet tutarı, TRY."100.00"
revisiontam sayıEvetKaydın revizyonu; If-Match için ETag ile birlikte kullanılır.1
statusmetin (seçenekler: active, inactive)Evetactive açık, inactive kapalı kupon."active"
storemetinEvetKuponun geçerli olduğu sto_ markası."sto_1234567890abcdef1234567890abcdef"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
used_counttam sayıEvetPanelin siparişlerden hesapladığı kullanım sayısı; iptal ve tam iadeler sayılmaz.0
valid_frommetin · null olabilirEvetMarkanı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_untilmetin · null olabilirEvetMarkanı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

HTTPcodeAnlamıNasıl düzelir?
403forbiddenMevcut ticari kural bu işlemi yapmanıza izin vermiyor.Gerekli kapsamları ve siparişin durumunu kontrol edin.
400invalid_if_matchIf-Match geçerli bir güçlü ETag değil.GET kaynak yanıtındaki ETag değerini çift tırnaklarıyla aynen kullanın.
412revision_mismatchKayıt siz okuduktan sonra değişmiş.Güncel kaydı okuyun; düzeltmeyi yeniden değerlendirip yeni tekrar anahtarıyla gönderin.
409coupon_code_takenKupon kodu bu markada başka kuponda kullanılıyor.Başka kod seçin veya mevcut kuponu güncelleyin; yeni tekrar anahtarı kullanın.
409coupon_restore_conflictKupon arşivde değil.Güncel kaydı okuyun.
422store_requiredÇok markalı işletmede kaydın markası eksik./me yanıtındaki sto_ kimliğini store alanına yazın.
403store_forbiddenAnahtar 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.