Fatura
Fatura iptalini önizle
POST/v1/invoices/{id}/cancel/preview
Faturanın API ile mi, sağlayıcı portalından mı iptal edileceğini öğrenin.
- Gereken izin
Bearer anahtarı ve
invoices:write,money_out:write- Maliyet
1 puan (bağlantı başına 60 saniyede 600 puan)
- Tekrar anahtarı
Gerekmez; istek hiçbir şeyi değiştirmez.
İstek
Temel adres: https://api.siparis.app/v1
Yol parametreleri
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
id | metin | Evet | Okunacak kaynağın inv_ önekli dış kimliği. | "inv_1234567890abcdef1234567890abcdef" |
Gövde (application/json)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|
Örnek istek
curl --fail-with-body --silent --show-error --request POST \
"${SIPARIS_API_URL:-https://api.siparis.app/v1}/invoices/inv_1234567890abcdef1234567890abcdef/cancel/preview" \
-H "Authorization: Bearer $SIPARIS_API_KEY" \
-H 'Content-Type: application/json' \
--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",
}
request = Request(base + "/invoices/inv_1234567890abcdef1234567890abcdef/cancel/preview", 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 + "/invoices/inv_1234567890abcdef1234567890abcdef/cancel/preview", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
"Content-Type": "application/json",
},
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
200 İstek başarıyla tamamlandı.
İçerik türü: application/json
{
"code": null,
"detail": null,
"invoice": "inv_1234567890abcdef1234567890abcdef",
"portal_required": false,
"via_api": true
}Yanıt alanları (5)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
code | metin · null olabilir | Evet | Portal gerektiğinde invoice_portal_required; aksi halde null. | null |
detail | metin · null olabilir | Evet | Paneldeki sağlayıcı iptal açıklaması. | null |
invoice | metin | Evet | İptali incelenen inv_ kimliği. | "inv_1234567890abcdef1234567890abcdef" |
portal_required | true/false | Evet | Önce portalda iptal gerekiyorsa true. | false |
via_api | true/false | Evet | Sağlayıcı API ile iptali destekliyorsa true. | true |
Hatalar
| HTTP | code | Anlamı | Nasıl düzelir? |
|---|---|---|---|
| 409 | invoice_not_connected | Fatura sağlayıcısı bağlı değil. | İşletme > Entegrasyonlar bölümünden sağlayıcınızı bağlayın. |
| 409 | invoice_order_not_allowed | Bu siparişe fatura kesilemez. | Siparişin iptal/iade durumunu kontrol edin. |
| 409 | invoice_zero_total | Sipariş tutarı 0 TL; fatura kesilmez. | Sipariş tutarını kontrol edin. |
| 409 | invoice_payment_required | Ödeme gelince fatura kesilebilir. | Ödeme kaydını kontrol edin. |
| 409 | invoice_billing_invalid | Siparişin fatura bilgileri uygun değil. | Paneldeki açıklamaya göre fatura bilgilerini tamamlayın. |
| 400 | invoice_seller_invalid | İşletmenin vergi bilgileri eksik. | İşletme bilgilerini tamamlayın. |
| 409 | invoice_empty_order | Siparişte ürün yok; fatura kesilemez. | Sipariş kalemlerini kontrol edin. |
| 409 | invoice_exists | Siparişin etkin faturası var. | Mevcut faturayı okuyun; hazırlanan fatura için yeni istek açmayın. |
| 409 | invoice_not_allowed | Fatura işlemi şu an yapılamıyor. | Açıklamadaki panel kuralını izleyin. |
| 409 | invoice_already_cancelled | Fatura zaten iptal edilmiş. | Güncel faturayı okuyun. |
| 409 | invoice_not_ready | Fatura belgesi henüz hazır değil. | Faturanın numarası kesinleşince yeniden deneyin. |
| 409 | invoice_portal_required | Sağlayıcı portalından iptal gerekiyor. | Portalda tamamladıktan sonra portal_done=true gönderin. |
| 409 | invoice_cancel_running | Fatura iptali sürüyor. | Süren çağrının bitmesini bekleyin. |
| 409 | invoice_connection_changed | Fatura sağlayıcı bağlantısı değişti. | Önceki sağlayıcı hesabında faturayı kontrol edin. |
| 409 | invoice_cancel_uncertain | Fatura iptalinin sonucu belirsiz. | Yeni dış iptal gönderilmez; portalda doğrulayıp portal_done=true ile tamamlayın. |
| 409 | invoice_provider_auth | Fatura sağlayıcısı bağlantı bilgilerini kabul etmedi. | İşletme > Entegrasyonlar bölümünden bağlantıyı düzeltin; aynı faturayı izleyin. |
| 409 | invoice_provider_error | Fatura sağlayıcısı işlemi tamamlayamadı. | Faturanın durumunu ve sağlayıcı portalını kontrol edin. |
Ortak hatalar (anahtar, izin, istek biçimi, hız sınırı, tekrar anahtarı) her uçta aynıdır: Hata kodları › Ortak hatalar.