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

Stok

Stok belgesini getir

GET/v1/inventory/documents/{id}

Bir stok girişi, sayım, fire veya taşıma belgesini hareketleriyle okuyun.

Gereken izin

Bearer anahtarı ve inventory:read

Yanıtı genişleten izin

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

Yol parametreleri

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

Sorgu parametreleri

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

Örnek istek

curl --fail-with-body --silent --show-error --request GET \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/inventory/documents/doc_1234567890abcdef1234567890abcdef?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 + "/inventory/documents/doc_1234567890abcdef1234567890abcdef?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 + "/inventory/documents/doc_1234567890abcdef1234567890abcdef?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

{
  "created_at": "2026-10-16T09:00:00Z",
  "id": "doc_1234567890abcdef1234567890abcdef",
  "kind": "receipt",
  "location": "loc_1234567890abcdef1234567890abcdef",
  "movements": {
    "data": [
      {
        "count_reason": null,
        "created_at": "2026-10-16T09:00:00Z",
        "currency": "TRY",
        "document": "doc_1234567890abcdef1234567890abcdef",
        "id": "mov_1234567890abcdef1234567890abcdef",
        "location": "loc_1234567890abcdef1234567890abcdef",
        "order": "ord_1234567890abcdef1234567890abcdef",
        "product": "prd_1234567890abcdef1234567890abcdef",
        "quantity_change": "-1.000",
        "reason": "sale",
        "variant": "var_1234567890abcdef1234567890abcdef",
        "variant_balance_after": "12.000"
      }
    ],
    "has_more": false,
    "next_cursor": null
  },
  "reversed_by": null,
  "reverses": null,
  "revision": 1,
  "to_location": "loc_1234567890abcdef1234567890abcdef"
}
Yanıt alanları (18)
AlanTürZorunluAçıklamaÖrnek
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
idmetinEvetKaynağın dış kimliği; doc_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."doc_1234567890abcdef1234567890abcdef"
kindmetinEvetStok belgesinin türü."receipt"
locationmetin · null olabilirEvetDepo kimliği (loc_ ve 32 küçük onaltılık karakter)."loc_1234567890abcdef1234567890abcdef"
movementsnesneEvetBu belgeye ait görünür stok hareketleri; limit/cursor ile ilerleyin.
dataliste: nesne (Movement)EvetBu sayfanın görünür kayıtları; boş liste de geçerli bir sayfadır.
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
reversed_bymetin · null olabilirEvetBu belgeyi tersine çeviren belge kimliği (doc_ ve 32 küçük onaltılık karakter).null
reversesmetin · null olabilirEvetTers kaydı oluşturulan belge kimliği (doc_ ve 32 küçük onaltılık karakter).null
revisiontam sayı (en az 1)EvetBelgenin sürümü: ilk kayıtta 1, ters kaydı varsa 2. ETag aynı değeri taşır.1
to_locationmetin · null olabilirEvetHedef depo kimliği (loc_ ve 32 küçük onaltılık karakter)."loc_1234567890abcdef1234567890abcdef"
invoice_datetarih · null olabilirHayırTedarikçi fatura tarihi; YYYY-MM-DD; costs:read gerekir."2026-10-16"
invoice_numbermetin · null olabilirHayırTedarikçi fatura numarası; costs:read gerekir."TEST2026000000001"
notemetin · null olabilirHayırİç not; internal_notes:read gerekir. Kişisel kaynakta personal_data:read da gerekir."Örnek iç not"
suppliernesne · null olabilirHayırTedarikçi kimliği ve adı; costs:read gerekir; iletişim bilgileri yayımlanmaz.
idmetinEvetKaynağın dış kimliği; sup_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."sup_1234567890abcdef1234567890abcdef"
namemetinEvetKaydın görünen adı."Örnek Tedarikçi"

Bu uca özgü yanıt başlıkları: ETag (Stok belgesinin güçlü sürüm etiketi.).

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.