Dışa aktarma
Dışa aktarmanın durumunu getir
GET/v1/exports/{id}
Dosyanın hazırlanmasını izleyin; hazır olunca dosya ve devam imleci gelir.
- Gereken izin
Bearer anahtarı ve
exports:write- Kaynağa göre ek izin
customers:customers:read;inventory_levels:inventory:read;orders:orders:read;products:products:read;variants:products:read- Maliyet
1 puan (bağlantı başına 60 saniyede 600 puan)
- Tekrar anahtarı
Gerekmez (okuma).
İstek
Temel adres: https://api.siparis.app/v1
Yol parametreleri
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
id | metin | Evet | Okunacak kaynağın exp_ önekli dış kimliği. | "exp_1234567890abcdef1234567890abcdef" |
Örnek istek
curl --fail-with-body --silent --show-error --request GET \
"${SIPARIS_API_URL:-https://api.siparis.app/v1}/exports/exp_1234567890abcdef1234567890abcdef" \
-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 + "/exports/exp_1234567890abcdef1234567890abcdef", 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 + "/exports/exp_1234567890abcdef1234567890abcdef", {
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
{
"completed_at": "2026-10-16T09:00:10Z",
"created_at": "2026-10-16T09:00:00Z",
"error_code": null,
"file": {
"bytes": 2048,
"content_type": "application/x-ndjson",
"download_path": "/v1/files/fil_1234567890abcdef1234567890abcdef",
"expires_at": "2026-10-23T09:00:00Z",
"id": "fil_1234567890abcdef1234567890abcdef"
},
"format": "jsonl",
"id": "exp_1234567890abcdef1234567890abcdef",
"resource": "orders",
"resume_cursor": "SUNUCUDAN_DONEN_IMLEC",
"row_count": 1,
"status": "completed"
}Yanıt alanları (16)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
completed_at | tarih-saat · null olabilir | Evet | Tamamlanma zamanı; RFC 3339 UTC. Hazır değilse null. | null |
created_at | tarih-saat | Evet | Oluşturulma zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
error_code | metin · null olabilir | Evet | Hazırlama başarısızsa kod: export_too_large (süzgeçle daraltın), snapshot_timeout (daha küçük dosya isteyin), export_access_changed (güncel izinlerle yeniden başlatın); diğer hatalarda destek alın. Başarıda null. | null |
file | nesne · null olabilir | Evet | Tamamlanmış dosya bilgisi; hazırlama sürerken null. | null |
bytes | tam sayı | Evet | Dosyanın bayt cinsinden boyutu. | 2048 |
content_type | metin | Evet | İndirilecek dosyanın içerik türü. | "application/x-ndjson" |
download_path | metin | Evet | API kökenine eklenecek /v1/files/fil_… yolu; Bearer anahtarı gerekir. | "/v1/files/fil_1234567890abcdef1234567890abcdef" |
expires_at | tarih-saat | Evet | Dışa aktarmanın created_at zamanından tam 7 gün sonrası; bu anda indirme 410 file_expired döner. | "2026-10-23T09:00:00Z" |
id | metin | Evet | Kaynağın dış kimliği; fil_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz. | "fil_1234567890abcdef1234567890abcdef" |
format | metin (seçenekler: jsonl, csv) | Evet | jsonl: satır başına JSON nesnesi; csv: her hücresi JSON değeri olan CSV. | "jsonl" |
id | metin | Evet | Kaynağın dış kimliği; exp_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz. | "exp_1234567890abcdef1234567890abcdef" |
resource | metin (seçenekler: orders, customers, products, variants, inventory_levels) | Evet | Dışa aktarılacak kaynak; aynı kaynağın okuma kapsamı da gerekir. | "orders" |
resume_cursor | metin · null olabilir | Evet | Dosya tamamen uygulandıktan sonra /events cursor parametresine verilir; types eklenmez. Hazır değilse null. | null |
row_count | tam sayı | Evet | Dosyaya yazılmış nesne sayısı. | 0 |
status | metin (seçenekler: queued, running, completed, failed) | Evet | queued: sırada; running: hazırlanıyor; completed: hazır; failed: başarısız. | "queued" |
mode | sabit "consistent_snapshot" | Hayır | consistent_snapshot: bütün kayıtlar aynı anın tutarlı görünümüdür. | "consistent_snapshot" |
Hatalar
| HTTP | code | Anlamı | Nasıl düzelir? |
|---|---|---|---|
| 403 | export_access_changed | Dosya oluşturulduktan sonra erişim kapsamı değişmiş. | Güncel izinlerle yeni dışa aktarma başlatı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.