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
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
id | metin | Evet | Okunacak kaynağın ord_ önekli dış kimliği. | "ord_1234567890abcdef1234567890abcdef" |
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" |
Ö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)
| 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. | |
discount | metin · null olabilir | Evet | Satır indirimi; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin. | "0.00" |
id | metin | Evet | Kaynağın dış kimliği; lin_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz. | "lin_1234567890abcdef1234567890abcdef" |
name | metin | Evet | Kaydın görünen adı. | "Örnek Kupa" |
product | metin · null olabilir | Evet | Ürün kimliği (prd_ ve 32 küçük onaltılık karakter). | "prd_1234567890abcdef1234567890abcdef" |
quantity | metin | Evet | Miktar; birimi ilgili ürün/depo alanında verilen ondalık metin. | "1.000" |
refunded_quantity | metin | Evet | İade edilen miktar; birimi ilgili ürün/depo alanında verilen ondalık metin. | "0.000" |
tax_amount | metin · null olabilir | Evet | Vergi tutarı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin. | "20.00" |
tax_rate | metin · null olabilir | Evet | Yüzde cinsinden vergi oranı; ondalık metin. | "20.00" |
total | metin | Evet | Toplam tutar; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin. | "120.00" |
unit | metin | Evet | Ürünün satış miktarı birimi. | "adet" |
unit_price | metin | Evet | Satı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" |
variant | metin · null olabilir | Evet | Seçenek kimliği (var_ ve 32 küçük onaltılık karakter). | "var_1234567890abcdef1234567890abcdef" |
variant_name | metin · null olabilir | Evet | Satırdaki seçeneğin sipariş anındaki adı. | "Mavi" |
currency | sabit "TRY" | Hayır | Para birimi; v1 tutarları Türk lirasıdır. | "TRY" |
unit_cost | metin · null olabilir | Hayır | Birim 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_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.