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

Olaylar ve Webhook

Olayları listele

GET/v1/events

Sipariş, stok, ürün ve müşterideki kalıcı değişiklikleri yayın sırasıyla okuyun; webhook yerine düzenli sorgulamak için kullanın.

Gereken izin

Bearer anahtarı ve events:read

Kaynağa göre ek izin

channel.order_imported: channels:read; channel.problem: channels:read; channel.recovered: channels:read; collection.recorded: payments:read; collection.reversed: payments:read; coupon.archived: coupons:read; coupon.created: coupons:read; coupon.restored: coupons:read; coupon.updated: coupons:read; customer.anonymized: customers:read; customer.archived: customers:read; customer.created: customers:read; customer.restored: customers:read; customer.updated: customers:read; inventory.document_created: inventory:read; inventory.document_reversed: inventory:read; inventory.level_changed: inventory:read; inventory.low: inventory:read; invoice.cancelled: invoices:read; invoice.failed: invoices:read; invoice.issued: invoices:read; job.completed: exports:write veya products:write veya inventory:write; order.created: orders:read; order.status_changed: orders:read; order.updated: orders:read; payment.failed: payments:read; product.archived: products:read; product.created: products:read; product.restored: products:read; product.updated: products:read; refund.succeeded: payments:read; return.approved: returns:read; return.closed: returns:read; return.received: returns:read; return.rejected: returns:read; return.requested: returns:read; shipment.cod_changed: shipments:read; shipment.created: shipments:read; shipment.status_changed: shipments:read; store_price.updated: products:read; store_product.linked: products:read; store_product.unlinked: products:read; subscription.cancelled: subscriptions:read; subscription.created: subscriptions:read; subscription.paused: subscriptions:read; subscription.payment_issue: subscriptions:read; subscription.renewed: subscriptions:read; subscription.resumed: subscriptions:read; variant.archived: products:read; variant.created: products:read; variant.restored: products:read; variant.updated: products:read

Maliyet

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

Tekrar anahtarı

Gerekmez (okuma).

İstek

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

Sorgu parametreleri

AlanTürZorunluAçıklamaÖrnek
limittam sayı (en az 1; en çok 100)HayırSayfa başına en fazla kayıt/olay adayı; varsayılan 50, aralık 1–100.50
cursormetin (en çok 4096 karakter) · null olabilirHayırÖnceki yanıttaki next_cursor; aynı yetki ve süzgeçlerle değiştirmeden gönderin."SUNUCUDAN_DONEN_IMLEC"
typesmetin (en çok 2000 karakter) · null olabilirHayırVirgülle ayrılmış olay türleri; her türün kaynak okuma kapsamı gerekir."order.created,order.status_changed"

Örnek istek

curl --fail-with-body --silent --show-error --request GET \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/events?limit=50" \
  -H "Authorization: Bearer $SIPARIS_API_KEY"
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 + "/events?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
// 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 + "/events?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);

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

{
  "data": [
    {
      "actor": {
        "type": "user"
      },
      "created_at": "2026-10-16T09:00:00Z",
      "data": {
        "changes": {
          "current": {},
          "previous": {}
        },
        "object": {
          "id": "ord_1234567890abcdef1234567890abcdef"
        }
      },
      "id": "evt_1234567890abcdef1234567890abcdef",
      "livemode": true,
      "schema_version": 1,
      "store": "sto_1234567890abcdef1234567890abcdef",
      "type": "order.created"
    }
  ],
  "has_more": false,
  "next_cursor": "SUNUCUDAN_DONEN_IMLEC"
}
Yanıt alanları (11)
AlanTürZorunluAçıklamaÖrnek
dataliste: nesneEvetBu sayfanın görünür kayıtları; boş liste de geçerli bir sayfadır.
actornesne (EventActor)Evetİşlemi yapanın türü; kişi veya ekip üyesi kimliği verilmez.
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
datanesne (EventData)EvetOlayın kişisel veri içermeyen kaynak kimliği ve değişiklik özeti.
idmetinEvetKaynağın dış kimliği; evt_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."evt_1234567890abcdef1234567890abcdef"
livemodetrue/falseEvetGerçek ortamda oluşan olay için true.true
schema_versionsabit 1EvetOlay yükünün şema sürümü.1
storemetin · null olabilirEvetMarka kimliği (sto_ ve 32 küçük onaltılık karakter)."sto_1234567890abcdef1234567890abcdef"
typemetin (seçenekler: job.completed, order.created, order.updated, order.status_changed, collection.recorded, collection.reversed, refund.succeeded, payment.failed, return.requested, return.approved, return.rejected, return.received, return.closed, invoice.issued, invoice.failed, invoice.cancelled, shipment.created, shipment.status_changed, shipment.cod_changed, inventory.level_changed, inventory.low, inventory.document_created, inventory.document_reversed, product.created, product.updated, product.archived, product.restored, variant.created, variant.updated, variant.archived, variant.restored, store_product.linked, store_product.unlinked, store_price.updated, customer.created, customer.updated, customer.archived, customer.restored, customer.anonymized, subscription.created, subscription.renewed, subscription.payment_issue, subscription.paused, subscription.resumed, subscription.cancelled, coupon.created, coupon.updated, coupon.archived, coupon.restored, channel.order_imported, channel.problem, channel.recovered, webhook.test)Evetİşlem veya olay türü."order.created"
has_moretrue/falseEvetTaranacak başka sayfa varsa true; olaylarda boş data ile de true olabilir.false
next_cursormetinEvetHer yanıtta döner; boş/son sayfada da kaydedin. has_more=false olunca bekleyip bu imleçle yeniden okuyun."SUNUCUDAN_DONEN_IMLEC"

Hatalar

HTTPcodeAnlamıNasıl düzelir?
422invalid_event_typesOlay türü geçersiz veya izinli tür yok.Olay kataloğundan tür seçin ve kaynak kapsamını açın.
409snapshot_publisher_changedOlay yayıncısının sürümü ilk görüntüyle uyuşmuyor.Yeni tutarlı dışa aktarma ve onun resume_cursor değeriyle başlayın.

Ortak hatalar (anahtar, izin, istek biçimi, hız sınırı, tekrar anahtarı) her uçta aynıdır: Hata kodları › Ortak hatalar.