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

Stok

Fire ve kayıp yaz

POST/v1/inventory/write_offs

Kırılan, kaybolan veya kullanılamayan ürünü stoktan düşün.

Gereken izin

Bearer anahtarı ve inventory:write

Koşula bağlı izin

internal_notes:write: İstekte note gönderirseniz gerekir. Eksikse 403 döner.

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

1 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
linesliste: nesne (en çok 500 öğe)EvetAzalan seçenekler ve pozitif miktarları.
quantitysayı (en az 0; en çok 100000000) veya metinEvetİşlenecek miktar; en çok üç ondalık hane, adet biriminde tam sayı."2"
skumetin (en çok 200 karakter) · null olabilirHayırStok kodu; baş/son boşluk ve harf farkı kaldırılarak tam eşleşir."KUPA-MAVI"
variantmetin · null olabilirHayırvar_ seçenek kimliği; variant veya sku alanından tam biri gerekir. Ortak stokta havuzun var_ kimliğini kullanın."var_1234567890abcdef1234567890abcdef"
locationmetinEvetİşlemin loc_ depo kimliği; /locations listesinden seçin."loc_1234567890abcdef1234567890abcdef"
reasonmetin (seçenekler: broken, lost, other, defective, fitting, sample, expired)EvetPanelin neden kodu: broken, lost, other her sektörde; defective/fitting/sample giyimde, expired gıda/kozmetikte. other için not zorunlu."broken"
notemetin (en çok 300 karakter) · null olabilirHayırİç açıklama; internal_notes:write gerekir, okumak için internal_notes:read gerekir."Depoda kontrol edildi."
storemetin · null olabilirHayırsto_ marka kimliği; tek markada veya marka sınırlı anahtarda atlanabilir."sto_1234567890abcdef1234567890abcdef"

Örnek istek

curl --fail-with-body --silent --show-error --request POST \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/inventory/write_offs" \
  -H "Authorization: Bearer $SIPARIS_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: ornek-post-v1-inventory-write-offs-001' \
  --data-binary @- <<'JSON'
{
  "lines": [
    {
      "quantity": "2",
      "sku": "KUPA-MAVI"
    }
  ],
  "location": "loc_1234567890abcdef1234567890abcdef",
  "reason": "broken"
}
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-inventory-write-offs-001",
}
request = Request(base + "/inventory/write_offs", headers=headers, method="POST",
    data="{\"lines\":[{\"quantity\":\"2\",\"sku\":\"KUPA-MAVI\"}],\"location\":\"loc_1234567890abcdef1234567890abcdef\",\"reason\":\"broken\"}".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 + "/inventory/write_offs", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": "ornek-post-v1-inventory-write-offs-001",
  },
  redirect: "manual", // 307 hedefini Bearer olmadan ayrı istekte okuyun.
  signal: AbortSignal.timeout(30_000),
  body: JSON.stringify({
  "lines": [
    {
      "quantity": "2",
      "sku": "KUPA-MAVI"
    }
  ],
  "location": "loc_1234567890abcdef1234567890abcdef",
  "reason": "broken"
}),
});
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

201 İ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.); Location (Yeni stok belgesinin API kökenine göre yolu.).

Hatalar

HTTPcodeAnlamıNasıl düzelir?
403forbiddenMevcut ticari kural bu işlemi yapmanıza izin vermiyor.Gerekli kapsamları ve siparişin durumunu kontrol edin.
422invalid_stock_operationStok işlemi ürünün veya deponun kurallarına uygun değil.Birimi, depo durumunu, sayılmayan stoğu ve belge türünü kontrol edin.
422store_requiredÇok markalı işletmede kaydın markası eksik./me yanıtındaki sto_ kimliğini store alanına yazın.
403store_forbiddenAnahtar başka markaya yazamaz.Anahtarın kendi markasını seçin; marka sınırı gövdeyle genişletilmez.
422reserved_noteBu açıklama sistem işlemlerine ayrılmıştır.İşlemi kendi sözcüklerinizle açıklayın; yeni tekrar anahtarı kullanın.
400insufficient_stockSipariş için yeterli stok yok.Miktarı azaltın veya paneldeki bekleyen stok kuralını açıkça allow_waiting=true ile seçin.

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