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

Siparişler

Sipariş satırlarını listele

GET/v1/orders/{id}/lines

Sipariş anındaki ürün, seçenek, miktar ve fiyatları alın; ERP sipariş kalemlerini oluştururken kullanın.

Gereken izin

Bearer anahtarı ve orders:read

Yanıtı genişleten izin

costs: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

Yol parametreleri

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

Sorgu parametreleri

AlanTürZorunluAçıklamaÖrnek
limittam sayı (en az 1; en çok 100)HayırSayfa başına kayıt/olay adayı sayısı; varsayılan 50, en az 1, en çok 100.50
cursormetin (en çok 4096 karakter) · null olabilirHayırÖnceki yanıtın next_cursor değeri; çözmeyin, aynı kaynak, yetki ve süzgeçlerle aynen gönderin."SUNUCUDAN_DONEN_IMLEC"

Örnek istek

curl --fail-with-body --silent --show-error --request GET \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/orders/ord_1234567890abcdef1234567890abcdef/lines?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 + "/orders/ord_1234567890abcdef1234567890abcdef/lines?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 + "/orders/ord_1234567890abcdef1234567890abcdef/lines?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": [
    {
      "currency": "TRY",
      "discount": "0.00",
      "id": "lin_1234567890abcdef1234567890abcdef",
      "name": "Kupa",
      "product": null,
      "quantity": "1.000",
      "refunded_quantity": "0.000",
      "tax_amount": "20.00",
      "tax_rate": "20.00",
      "total": "120.00",
      "unit": "adet",
      "unit_price": "120.00",
      "variant": null,
      "variant_name": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}
Yanıt alanları (18)
AlanTürZorunluAçıklamaÖrnek
dataliste: nesneEvetBu sayfanın görünür kayıtları; boş liste de geçerli bir sayfadır.
discountmetin · null olabilirEvetSatır indirimi; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
idmetinEvetKaynağın dış kimliği; lin_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."lin_1234567890abcdef1234567890abcdef"
namemetinEvetKaydın görünen adı."Örnek Kupa"
productmetin · null olabilirEvetÜrün kimliği (prd_ ve 32 küçük onaltılık karakter)."prd_1234567890abcdef1234567890abcdef"
quantitymetinEvetMiktar; birimi ilgili ürün/depo alanında verilen ondalık metin."1.000"
refunded_quantitymetinEvetİade edilen miktar; birimi ilgili ürün/depo alanında verilen ondalık metin."0.000"
tax_amountmetin · null olabilirEvetVergi tutarı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."20.00"
tax_ratemetin · null olabilirEvetYüzde cinsinden vergi oranı; ondalık metin."20.00"
totalmetinEvetToplam tutar; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
unitmetinEvetÜrünün satış miktarı birimi."adet"
unit_pricemetinEvetSatırın birim satış fiyatı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
variantmetin · null olabilirEvetSeçenek kimliği (var_ ve 32 küçük onaltılık karakter)."var_1234567890abcdef1234567890abcdef"
variant_namemetin · null olabilirEvetSatırdaki seçeneğin sipariş anındaki adı."Mavi"
currencysabit "TRY"HayırPara birimi; v1 tutarları Türk lirasıdır."TRY"
unit_costmetin · null olabilirHayırBirim maliyet; yalnız costs:read ile görünür; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."80.00"
has_moretrue/falseEvetTaranacak başka sayfa varsa true; olaylarda boş data ile de true olabilir.false
next_cursormetin · null olabilirEvetSonraki 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.