Stok
Stok belgesini geri al
POST/v1/inventory/documents/{id}/reverse
Yanlış girilmiş mal girişini veya fireyi ters kayıtla düzeltin.
- Gereken izin
Bearer anahtarı ve
inventory:write- 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-Keybaşlığı.
İstek
Temel adres: https://api.siparis.app/v1
Yol parametreleri
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
id | metin | Evet | Okunacak kaynağın doc_ önekli dış kimliği. | "doc_1234567890abcdef1234567890abcdef" |
Başlıklar
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
Idempotency-Key | metin · null olabilir | Evet | Zorunlu 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" |
If-Match | metin · null olabilir | Hayır | İsteğe bağlı önkoşul: son ETag değerini çift tırnaklarıyla gönderin. Komutun kilidi altında farklıysa 412 revision_mismatch. | "\"3\"" |
Gövde (application/json)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
store | metin · null olabilir | Hayır | sto_ marka kimliği; API belgesinde özgün marka kullanılır, diğer belgelerde çok marka varsa seçin. | null |
Örnek istek
curl --fail-with-body --silent --show-error --request POST \
"${SIPARIS_API_URL:-https://api.siparis.app/v1}/inventory/documents/doc_1234567890abcdef1234567890abcdef/reverse" \
-H "Authorization: Bearer $SIPARIS_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: ornek-post-v1-inventory-documents-doc-1234567890abcdef1234567890abcdef-reverse-001' \
--data-binary @- <<'JSON'
{}
JSONimport 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-documents-doc-1234567890abcdef1234567890abcdef-reverse-001",
}
request = Request(base + "/inventory/documents/doc_1234567890abcdef1234567890abcdef/reverse", headers=headers, method="POST",
data="{}".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/documents/doc_1234567890abcdef1234567890abcdef/reverse", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": "ornek-post-v1-inventory-documents-doc-1234567890abcdef1234567890abcdef-reverse-001",
},
redirect: "manual", // 307 hedefini Bearer olmadan ayrı istekte okuyun.
signal: AbortSignal.timeout(30_000),
body: JSON.stringify({}),
});
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)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
created_at | tarih-saat | Evet | Oluşturulma zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
id | metin | Evet | Kaynağın dış kimliği; doc_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz. | "doc_1234567890abcdef1234567890abcdef" |
kind | metin | Evet | Stok belgesinin türü. | "receipt" |
location | metin · null olabilir | Evet | Depo kimliği (loc_ ve 32 küçük onaltılık karakter). | "loc_1234567890abcdef1234567890abcdef" |
movements | nesne | Evet | Bu belgeye ait görünür stok hareketleri; limit/cursor ile ilerleyin. | |
data | liste: nesne (Movement) | Evet | Bu sayfanın görünür kayıtları; boş liste de geçerli bir sayfadır. | |
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 |
reversed_by | metin · null olabilir | Evet | Bu belgeyi tersine çeviren belge kimliği (doc_ ve 32 küçük onaltılık karakter). | null |
reverses | metin · null olabilir | Evet | Ters kaydı oluşturulan belge kimliği (doc_ ve 32 küçük onaltılık karakter). | null |
revision | tam sayı (en az 1) | Evet | Belgenin sürümü: ilk kayıtta 1, ters kaydı varsa 2. ETag aynı değeri taşır. | 1 |
to_location | metin · null olabilir | Evet | Hedef depo kimliği (loc_ ve 32 küçük onaltılık karakter). | "loc_1234567890abcdef1234567890abcdef" |
invoice_date | tarih · null olabilir | Hayır | Tedarikçi fatura tarihi; YYYY-MM-DD; costs:read gerekir. | "2026-10-16" |
invoice_number | metin · null olabilir | Hayır | Tedarikçi fatura numarası; costs:read gerekir. | "TEST2026000000001" |
note | metin · null olabilir | Hayır | İç not; internal_notes:read gerekir. Kişisel kaynakta personal_data:read da gerekir. | "Örnek iç not" |
supplier | nesne · null olabilir | Hayır | Tedarikçi kimliği ve adı; costs:read gerekir; iletişim bilgileri yayımlanmaz. | |
id | metin | Evet | Kaynağın dış kimliği; sup_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz. | "sup_1234567890abcdef1234567890abcdef" |
name | metin | Evet | Kaydı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
| HTTP | code | Anlamı | Nasıl düzelir? |
|---|---|---|---|
| 403 | forbidden | Mevcut ticari kural bu işlemi yapmanıza izin vermiyor. | Gerekli kapsamları ve siparişin durumunu kontrol edin. |
| 422 | invalid_stock_operation | Stok 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. |
| 422 | store_required | Çok markalı işletmede kaydın markası eksik. | /me yanıtındaki sto_ kimliğini store alanına yazın. |
| 403 | store_forbidden | Anahtar başka markaya yazamaz. | Anahtarın kendi markasını seçin; marka sınırı gövdeyle genişletilmez. |
| 403 | document_forbidden | Belgenin tüm satırları marka kapsamında değil. | İşletmenin tümüne yetkili stok bağlantısı kullanın. |
| 409 | document_already_reversed | Bu stok belgesi zaten tersine çevrilmiş. | Güncel belgedeki reversed_by kaydını okuyun. |
| 400 | invalid_if_match | If-Match geçerli bir güçlü ETag değil. | GET kaynak yanıtındaki ETag değerini çift tırnaklarıyla aynen kullanın. |
| 412 | revision_mismatch | Kayıt siz okuduktan sonra değişmiş. | Güncel kaydı okuyun; düzeltmeyi yeniden değerlendirip yeni tekrar anahtarıyla gönderin. |
Ortak hatalar (anahtar, izin, istek biçimi, hız sınırı, tekrar anahtarı) her uçta aynıdır: Hata kodları › Ortak hatalar.