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

Dışa aktarma

Dışa aktarma başlat

POST/v1/exports

İlk eşitleme için siparişlerin, müşterilerin, ürünlerin veya stoğun tek andaki tutarlı dosyasını hazırlatın.

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

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

Tekrar anahtarı

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

İstek

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

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"

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}/exports" \
  -H "Authorization: Bearer $SIPARIS_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: ornek-post-v1-exports-001' \
  --data-binary @- <<'JSON'
{
  "format": "jsonl",
  "mode": "consistent_snapshot",
  "resource": "orders"
}
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-exports-001",
}
request = Request(base + "/exports", headers=headers, method="POST",
    data="{\"format\":\"jsonl\",\"mode\":\"consistent_snapshot\",\"resource\":\"orders\"}".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 + "/exports", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": "ornek-post-v1-exports-001",
  },
  redirect: "manual", // 307 hedefini Bearer olmadan ayrı istekte okuyun.
  signal: AbortSignal.timeout(30_000),
  body: JSON.stringify({
  "format": "jsonl",
  "mode": "consistent_snapshot",
  "resource": "orders"
}),
});
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

202 Hazırlama kuyruğa alındı; dosya henüz hazır değildir.

İçerik türü: application/json

{
  "completed_at": null,
  "created_at": "2026-10-16T09:00:00Z",
  "error_code": null,
  "file": null,
  "format": "jsonl",
  "id": "exp_1234567890abcdef1234567890abcdef",
  "resource": "orders",
  "resume_cursor": null,
  "row_count": 0,
  "status": "queued"
}
Yanıt alanları (16)
AlanTürZorunluAçıklamaÖrnek
completed_attarih-saat · null olabilirEvetTamamlanma zamanı; RFC 3339 UTC. Hazır değilse null.null
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
error_codemetin · null olabilirEvetHazı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
filenesne · null olabilirEvetTamamlanmış dosya bilgisi; hazırlama sürerken null.null
bytestam sayıEvetDosyanın bayt cinsinden boyutu.2048
content_typemetinEvetİndirilecek dosyanın içerik türü."application/x-ndjson"
download_pathmetinEvetAPI kökenine eklenecek /v1/files/fil_… yolu; Bearer anahtarı gerekir."/v1/files/fil_1234567890abcdef1234567890abcdef"
expires_attarih-saatEvetDış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"
idmetinEvetKaynağın dış kimliği; fil_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."fil_1234567890abcdef1234567890abcdef"
formatmetin (seçenekler: jsonl, csv)Evetjsonl: satır başına JSON nesnesi; csv: her hücresi JSON değeri olan CSV."jsonl"
idmetinEvetKaynağın dış kimliği; exp_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."exp_1234567890abcdef1234567890abcdef"
resourcemetin (seçenekler: orders, customers, products, variants, inventory_levels)EvetDışa aktarılacak kaynak; aynı kaynağın okuma kapsamı da gerekir."orders"
resume_cursormetin · null olabilirEvetDosya tamamen uygulandıktan sonra /events cursor parametresine verilir; types eklenmez. Hazır değilse null.null
row_counttam sayıEvetDosyaya yazılmış nesne sayısı.0
statusmetin (seçenekler: queued, running, completed, failed)Evetqueued: sırada; running: hazırlanıyor; completed: hazır; failed: başarısız."queued"
modesabit "consistent_snapshot"Hayırconsistent_snapshot: bütün kayıtlar aynı anın tutarlı görünümüdür."consistent_snapshot"

Hatalar

HTTPcodeAnlamıNasıl düzelir?
403export_access_changedDosya oluşturulduktan sonra erişim kapsamı değişmiş.Güncel izinlerle yeni dışa aktarma başlatın.
409export_in_progressBu işletmede başka bir dosya hazırlanıyor.Retry-After kadar bekleyin; mevcut hazırlama bitince yeni Idempotency-Key ile isteyin.
422invalid_rangeZaman aralığının başlangıcı bitişten önce değil.Başlangıç dahil, bitiş hariç olacak şekilde başlangıcı bitişten önce seçin.
422invalid_date_rangeZaman aralığının başlangıcı bitişten sonra.Başlangıç ve bitiş sırasını düzeltin.
422invalid_datetimeZamanın saat dilimi eksik.RFC 3339 değere Z veya +03:00 gibi saat dilimi ekleyin.

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