Müşteriler
Müşterileri listele
GET/v1/customers
Müşteri kartlarını listeleyin veya e-posta/telefonla doğru kartı bulun.
- Gereken izin
Bearer anahtarı ve
customers:read- Koşula bağlı izin
personal_data:read: email, phone, email_key veya phone_key ile ararken gerekir; ayrıca yanıttaki kişisel alanları açar. Eksikse 403 döner.- Yanıtı genişleten izin
internal_notes:read: yanıttaki ilgili alanları açar; izin yoksa bu alanlar atlanır, istek reddedilmez.- 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
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
limit | tam sayı (en az 1; en çok 100) | Hayır | Sayfa başına kayıt/olay adayı sayısı; varsayılan 50, en az 1, en çok 100. | 50 |
cursor | metin (en çok 4096 karakter) · null olabilir | Hayır | Önceki yanıtın next_cursor değeri; çözmeyin, aynı kaynak, yetki ve süzgeçlerle aynen gönderin. | "SUNUCUDAN_DONEN_IMLEC" |
sort | metin (seçenekler: updated_at, -created_at) | Hayır | updated_at: son değişiklikten ileri; -created_at: en yeni müşteri önce. Sıra değişirse yeni sayfalama başlatın. | "-created_at" |
email | metin (en çok 320 karakter) · null olabilir | Hayır | Ham e-posta; sunucu email_key kolonunun normalleştirmesiyle tam eşitlik arar. personal_data:read gerekir. | "Ornek@Example.com" |
phone | metin (en çok 50 karakter) · null olabilir | Hayır | Ham telefon; mevcut müşteri kuralıyla son 10 haneye çevrilir. personal_data:read gerekir. | "+90 500 000 00 00" |
email_key | metin (en çok 320 karakter) · null olabilir | Hayır | Normalize edilmiş e-posta; tam eşitlik araması; personal_data:read gerekir. | "ornek@example.com" |
phone_key | metin · null olabilir | Hayır | Telefonun son 10 hanesi; tam eşitlik araması; personal_data:read gerekir. | "0000000000" |
Örnek istek
curl --fail-with-body --silent --show-error --request GET \
"${SIPARIS_API_URL:-https://api.siparis.app/v1}/customers?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 + "/customers?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 + "/customers?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": [
{
"archived": false,
"created_at": "2026-10-16T09:00:00Z",
"id": "cus_1234567890abcdef1234567890abcdef",
"revision": 1,
"store": "sto_1234567890abcdef1234567890abcdef",
"updated_at": "2026-10-16T09:00:00Z"
}
],
"has_more": false,
"next_cursor": null
}Yanıt alanları (17)
| 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. | |
archived | true/false | Evet | Arşivdeki veya kapanmış kaynaksa true. archived=true süzgeci bunları da içerir. | false |
created_at | tarih-saat | Evet | Oluşturulma zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
id | metin | Evet | Kaynağın dış kimliği; cus_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz. | "cus_1234567890abcdef1234567890abcdef" |
revision | tam sayı (en az 1) | Evet | Müşteri kartının artan sürümü; ETag ve If-Match ile birlikte kullanılır. | 1 |
store | metin | Evet | Marka kimliği (sto_ ve 32 küçük onaltılık karakter). | "sto_1234567890abcdef1234567890abcdef" |
updated_at | tarih-saat | Evet | Son değişiklik zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
address | nesne (Address) · null olabilir | Hayır | Müşteri adresi; personal_data:read yoksa alan atlanır. | |
email | metin · null olabilir | Hayır | E-posta; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez. | null |
instagram | metin · null olabilir | Hayır | Instagram kullanıcı adı; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez. | null |
invoice | nesne (Billing) · null olabilir | Hayır | Fatura alıcı bilgileri; personal_data:read yoksa alan atlanır. | |
marketing_consent | true/false · null olabilir | Hayır | Pazarlama iletişimi izni; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez. | null |
name | metin · null olabilir | Hayır | Müşteri adı; personal_data:read yoksa alan atlanır. | null |
note | metin · null olabilir | Hayır | İç not; internal_notes:read gerekir. Kişisel kaynakta personal_data:read da gerekir. | "Örnek iç not" |
phone | metin · null olabilir | Hayır | Telefon; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez. | null |
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.