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

Kodlar ve durumlar

API’deki kodlu değerlerin Türkçe karşılıkları. Kodlar İngilizcedir ve değişmez; ekranda göstereceğiniz ad için “Türkçe adı” sütununu kullanabilirsiniz. Temel adres https://api.siparis.app/v1. Kimlik önekleri: Kavramlar ve kimlik önekleri; hata kodları: Hata kodları.

Sipariş durumları

Olağan akış: Yeni → Onaylandı → Hazırlanıyor → Kargoda → Teslim edildi. Açık sipariş iptal edilebilir; teslimden sonra iade gelir. Yanlış seçilen durum Sipariş durumunu düzelt ile gerekçe yazılarak düzeltilir. Alan: Order.status. Gönderilebilir mi? sütunu Sipariş durumunu düzelt isteğindeki status alanının kabul ettiği kodları gösterir.

KodTürkçe adıNe zamanGönderilebilir mi?
pendingYeniSipariş geldi veya açıldı, henüz onaylanmadı. Vitrinden gelen havale veya kartlı siparişte ödeme gelince onaylanır; ödeme payment_state alanındadır. Sonraki adım: Siparişi onayla ya da Siparişi iptal et.Evet
payment_pendingÖdeme bekliyorEski değer: 19 Ekim 2026'ya kadar havale veya kart ödemesi beklenen sipariş. Artık hiçbir sipariş bu durumda olmaz; yalnız eski olaylarda (previous_status, webhook changes) görülür. Süzgeçte kabul edilir, boş sonuç verir; durum düzeltmede 409 döner. Ödeme payment_state alanındadır.Evet
confirmedOnaylandıOnaylandı; hazırlanmayı veya kargoya verilmeyi bekliyor. Sonraki adım: Siparişi hazırlamaya başla, Gönderi oluştur ya da Siparişi teslim et.Evet
processingHazırlanıyorHazırlanıyor; markadan teslimde "teslim almaya hazır" bilgisi de bu durumdadır. Sonraki adım: Gönderi oluştur ya da Siparişi teslim et.Evet
shippedKargodaKargoya verildi; teslim bilgisi kargo firmasından gelir.Evet
deliveredTeslim edildiMüşteriye teslim edildi. Sonrasında yalnız iade ile İade edildi olabilir.Evet
cancelledİptalİptal edildi; stok geri geldi. Son durumdur.Evet
refundedİade edildiTeslimden sonra ürünler iade edildi. Son durumdur.Hayır, yalnız okunur

Ödeme yöntemleri

Okunan siparişte gelen ödeme yöntemi. Alan: Order.payment_method. Gönderilebilir mi? sütunu Sipariş oluştur isteğindeki payment_method alanının kabul ettiği kodları gösterir.

KodTürkçe adıNe zamanGönderilebilir mi?
codKapıda ödemeKapıda ödeme: kurye tahsil eder (cod_type: cash nakit, card kart). Markadan veya elden teslimde "Teslimatta ödeme" görünür.Evet
bank_transferHavale/EFTHavale veya EFT.Evet
credit_cardKartKartla ödeme: vitrinde çevrimiçi kart ya da POS cihazıyla alınmış ödeme; POS ile alınan siparişi de bu kodla açın. API karttan para çekmez. Tahsilat yazarken (Alınan ödemeyi kaydet) POS’un yöntem kodu pos’tur.Evet
splitParçalı ödemeBirden çok yöntemle alınan ödeme.Evet
cashNakitNakit.Evet
marketplacePazaryeriÖdemeyi pazaryeri veya başka satış kanalı aldı. Siparişte gönderilmez; ödemesi başka kanalda alınmış satışı Başka kanaldaki satışı bildir (POST /v1/external_orders) ile kaydedin.Hayır, yalnız okunur

Ödeme durumları

Sipariş durumundan ayrıdır; alınan ve iade edilen paradan hesaplanır, siz yazmazsınız. Alan: Order.payment_state.

KodTürkçe adıNe zaman
noneÖdeme yokBeklenen ödeme yok; ör. kuponla 0 TL olan sipariş.
awaitingÖdeme bekleniyorHiç ödeme alınmadı; tutarın tamamı bekleniyor. Havalede "Havale bekleniyor" görünür.
partialKısmen ödendiBir kısmı alındı (ör. kapora); kalan bekleniyor.
paidÖdendiTutarın tamamı alındı.
refund_dueİade edilecekAlınan para sipariş tutarını aşıyor; fark müşteriye iade edilecek. Açık siparişte "Fazla ödendi" görünür.
refundedİade edildiAlınan para müşteriye iade edildi.
testTest ödemesiÖdeme sağlayıcısının deneme kipinde alınmış ödeme; gerçek para değildir.

Teslim yöntemleri

Pazaryeri siparişlerinde boş (null) olabilir. Alan: Order.delivery_method. Gönderilebilir mi? sütunu Sipariş oluştur isteğindeki delivery_method alanının kabul ettiği kodları gösterir.

KodTürkçe adıNe zamanGönderilebilir mi?
shippingKargoKargoyla gönderilir; müşteri ve teslimat adresi gerekir.Evet
handElden teslimSiz veya kuryeniz elden teslim edersiniz; kargo gönderisi açılmaz.Evet
pickupMarkadan teslimMüşteri siparişi markanızın adresinden teslim alır.Evet
digitalDijital teslimKargo gerekmez; dijital ürün e-postayla teslim edilir.Evet

Gönderi ortak durumları

Kargo firmasından bağımsız durum; entegrasyonunuzu buna bağlayın. Olaylarda da aynı değerler gelir. Alan: Shipment.state.

KodTürkçe adıNe zaman
draftTaslakGönderi kargo firmasında taslakta; kargo kodu yok ya da kod iptal edildi.
readyGönderime hazırKargo kodu alındı, kurye paketi henüz almadı; iptal edilebilir.
in_transitYoldaKurye paketi aldı; dağıtımda, gecikmede veya kargo firması sorun bildirdiğinde de bu durumdadır.
deliveredTeslim edildiPaket alıcıya teslim edildi.
returningGeri dönüyorPaket göndericiye geri dönüyor.
returnedGeri döndüPaket göndericiye geri döndü.
lostKayıpKargo firması paketi kayıp bildirdi.
cancelledİptalGönderi iptal edildi veya kargo firmasında silindi.

Gönderi durumları

Kargo firmasının bildirdiği kod aynen gelir; büyük harfli kodlar BasitKargo’nundur. Firmadan bağımsız okumak için state. Alan: Shipment.status.

KodTürkçe adıNe zaman
pendingAçılıyorGönderi açma isteği kuyrukta; sonucu Gönderiyi getir ile izleyin.
failedAçılamadıGönderi açılamadı; error_code nedenini söyler.
createdOluşturulduKargo kodu alındı, kurye paketi henüz almadı.
NEWYeniKargo firmasında taslak olarak açıldı.
READY_TO_SHIPGönderime hazırPaket kuryeye verilmeyi bekliyor.
SHIPPEDYoldaKurye paketi aldı.
OUT_FOR_DELIVERYDağıtımdaPaket alıcıya dağıtıma çıktı.
DELIVEREDTeslim edildiPaket alıcıya teslim edildi.
COMPLETEDTeslim edildiEski kayıtlarda teslim edildi.
NEEDS_SUPPORTSorunluKargo firması destek istiyor; BasitKargo panelinden bakın.
DELAYEDGecikmeliTeslim gecikti.
RETURNINGGeri dönüyorPaket göndericiye geri dönüyor.
RETURNEDGeri döndüPaket göndericiye geri döndü.
LOSTKayıpKargo firması paketi kayıp bildirdi.
DELETEDİptalGönderi kargo firmasında silindi.
cancelledİptalGönderi iptal edildi.

Kapıda ödeme durumları

Kurye tahsilatının kargo firmasından bağımsız durumu; para BasitKargo üzerinden size geçer. Gönderinin cod_status alanı da aynı değerleri taşır. Alan: Shipment.cod_state.

KodTürkçe adıNe zaman
pendingTahsil edilecekKurye teslimde parayı alacak veya tahsilat bilgisi kargo firmasından bekleniyor.
collectedTahsil edildiKurye parayı aldı; BasitKargo’nun size aktarması bekleniyor.
settledAktarıldıBasitKargo parayı size aktardı.
settled_directKargo firması öderKurye parayı aldı; kargo firması kendi anlaşmanızla doğrudan size öder.
not_collectedTahsil edilmediPara tahsil edilmedi (ör. alıcı paketi almadı).

İade durumları

Müşteri talebinden paranın iadesine kadar. Alan: Return.status.

KodTürkçe adıNe zaman
requestedTalep geldiMüşteri talep açtı; kararınız bekleniyor.
approvedOnaylandıTalep onaylandı; ürünün gelmesi bekleniyor.
declinedReddedildiTalep reddedildi. Son durumdur.
code_sentKargo kodu verildiMüşteriye geri gönderim kargo kodu verildi.
arrivedÜrün geldiÜrün size ulaştı; kontrol ve para iadesi bekliyor.
refund_pendingMüşteriye iade edilecekPara müşteriye iade edilecek.
refundedPara iade edildiPara müşteriye iade edildi. Son durumdur.
exchangedTamamlandıDeğişim tamamlandı. Son durumdur.
closedKapandıKayıt kapandı.
exchange_cancelledDeğişim iptal edildiDeğişim siparişi iptal edildi; paranın iadesi veya değişimin geri alınması kararınızı bekliyor.

İade türleri

Alan: Return.kind.

KodTürkçe adıNe zaman
returnİadeÜrün geri gelir, para iade edilir.
exchangeDeğişimÜrün başka bir ürünle veya seçenekle değiştirilir.
moneyYalnız para iadesiÜrün dönmez; fiyat farkı veya tazminat ödenir.

Kart iadesi durumları

Kart iadesinde sorun yoksa alan null gelir. Alan: RefundResult.card_status.

KodTürkçe adıNe zaman
pendingSürüyorKart iadesi sağlayıcıya iletildi, sonucu bekleniyor.
blockedDurduKart iadesi başlatılamadı; paneldeki açıklamaya göre ilerleyin.
unknownSonuç belirsizSağlayıcı yanıt vermedi; yeniden başlatmayın, sağlayıcı panelinde doğrulayın.
failedBaşarısızKart iadesi yapılamadı.

Fatura durumları

Alan: Invoice.status.

KodTürkçe adıNe zaman
pendingHazırlanıyorFatura sağlayıcıya gönderildi; numara bekleniyor.
issuedKesildiFatura kesildi; belge indirilebilir.
failedKesilemediSağlayıcı faturayı kesemedi; error_code nedenini söyler.
cancelledİptal edildiFatura iptal edildi.

Fatura iptal durumları

İptal istenmediyse alan yoktur. Alan: Invoice.cancellation_status.

KodTürkçe adıNe zaman
pendingİptal sürüyorİptal sağlayıcıya iletildi; fatura bu sırada issued kalır.
unknownSonuç belirsizSağlayıcı yanıt vermedi; portalda doğrulayıp portal_done=true gönderin.
failedİptal edilemediSağlayıcı iptali reddetti.
succeededİptal edildiİptal tamamlandı.

Olay türleri

Kalıcı olayları okumak için events:read ve kaynak kapsamı gerekir. webhook.test yalnız ilgili uca gönderilen denemedir; events akışına girmez. Alan: Event.type.

KodTürkçe adıNe zaman
job.completedİş bittiDışa aktarma veya toplu fiyat/stok işi tamamlandı ya da başarısız oldu. Kapsam: exports:write, products:write, inventory:write.
order.createdSipariş oluşturulduVitrin, panel, AI, API veya pazaryerinden yeni sipariş geldi. Kapsam: orders:read.
order.updatedSipariş değiştiSiparişin tutarı, kalemleri, adresi, notları veya alt kayıtları değişti. Kapsam: orders:read.
order.status_changedSipariş durumu değiştiSipariş başka bir duruma geçti (ör. Onaylandı → Kargoda). Kapsam: orders:read.
collection.recordedÖdeme alındıSiparişe tahsilat yazıldı. Kapsam: payments:read.
collection.reversedÖdeme geri alındıYanlış kaydedilen tahsilat ters kayıtla geri alındı. Kapsam: payments:read.
refund.succeededPara iade edildiMüşteriye para iadesi tamamlandı. Kapsam: payments:read.
payment.failedKart ödemesi başarısızPayTR veya iyzico kart denemesi kesin olarak reddedildi; aynı deneme yalnız bir kez bildirilir. Kapsam: payments:read.
return.requestedİade/değişim açıldıMüşteri veya satıcı iade/değişim sürecini açtı. Kapsam: returns:read.
return.approvedİade/değişim onaylandıTalep approved veya code_sent durumuna geçti; bu iki durum arasındaki kod değişikliği yeniden onay değildir. Kapsam: returns:read.
return.rejectedİade/değişim reddedildiTalep declined durumuna geçti. Kapsam: returns:read.
return.receivedİade ürünü geldiÜrün ulaştı veya kontrol sonucu kaydedildi; ilk teslim alınma olgusu. Kapsam: returns:read.
return.closedİade/değişim kapandıKayıt closed, refunded veya exchanged durumuna geçti. Para ödemesi ayrı refund.succeeded olayıdır. Kapsam: returns:read.
invoice.issuedFatura kesildie-Arşiv/e-Fatura kaydı issued oldu. Kapsam: invoices:read.
invoice.failedFatura kesilemediKesin hata veya sağlayıcı reddiyle failed oldu; belirsiz bekleyiş hata sayılmaz, sağlayıcı metni gönderilmez. Kapsam: invoices:read.
invoice.cancelledFatura iptal edildiFatura cancelled oldu; iptal isteğinin açılması tek başına yeterli değildir. Kapsam: invoices:read.
shipment.createdGönderi açıldıSiparişe kargo gönderisi açıldı. Kapsam: shipments:read.
shipment.status_changedGönderi durumu değiştiKargo firmasından yeni durum geldi veya gönderi iptal edildi. Kapsam: shipments:read.
shipment.cod_changedKapıda ödeme değiştiKapıda ödeme tutarı veya tahsilat durumu değişti. Kapsam: shipments:read.
inventory.level_changedStok miktarı değiştiBir seçeneğin bir depodaki miktarı değişti. Kapsam: inventory:read.
inventory.lowStok azaldıGüncel stok, eşik ve marka bağı birlikte değerlendirilir. Yayın öncesi düşük stoklar başlangıç sayılır; yeni seçenek × depoda ilk düşük stok, sonraki düşüş veya etkin eşik değişip stok düşük kaldığında bildirilir. Kapsam: inventory:read.
inventory.document_createdStok belgesi yazıldıStok girişi, sayım, fire veya taşıma belgesi oluştu. Kapsam: inventory:read.
inventory.document_reversedStok belgesi geri alındıStok belgesi ters kayıtla düzeltildi. Kapsam: inventory:read.
product.createdÜrün oluşturulduYeni ürün açıldı. Kapsam: products:read.
product.updatedÜrün değiştiÜrünün bilgileri, fiyatı, satış durumu veya seçenekleri değişti. Kapsam: products:read.
product.archivedÜrün arşivlendiÜrün listeden ve vitrinden kalktı. Kapsam: products:read.
product.restoredÜrün geri getirildiArşivdeki ürün geri geldi. Kapsam: products:read.
variant.createdSeçenek oluşturulduÜrüne yeni seçenek eklendi. Kapsam: products:read.
variant.updatedSeçenek değiştiSeçeneğin fiyatı veya bilgileri değişti. Kapsam: products:read.
variant.archivedSeçenek arşivlendiSeçenek üründen kaldırıldı. Kapsam: products:read.
variant.restoredSeçenek geri getirildiArşivdeki seçenek ürünle birlikte geri geldi. Kapsam: products:read.
store_product.linkedÜrün markaya eklendiÜrün bir satış markasında satışa açıldı. Kapsam: products:read.
store_product.unlinkedÜrün markadan çıkarıldıÜrün bir satış markasından kaldırıldı. Kapsam: products:read.
store_price.updatedMarka fiyatı değiştiÜrünün veya seçeneğin bir markadaki fiyatı değişti ya da kaldırıldı. Kapsam: products:read.
customer.createdMüşteri oluşturulduYeni müşteri kartı açıldı. Kapsam: customers:read.
customer.updatedMüşteri değiştiMüşteri kartının bilgileri değişti. Kapsam: customers:read.
customer.archivedMüşteri arşivlendiMüşteri kartı etkin listeden kalktı. Kapsam: customers:read.
customer.restoredMüşteri geri getirildiArşivdeki müşteri kartı geri geldi. Kapsam: customers:read.
customer.anonymizedMüşteri anonimleştirildiKVKK isteğiyle kişisel bilgiler temizlendi. Kapsam: customers:read.
subscription.createdAbonelik başladıDüzenli teslimatlı sipariş onaylanınca abonelik açıldı; ilk sipariş ve ürün satırlarıyla. Kapsam: subscriptions:read.
subscription.renewedAbonelik siparişi açıldıVadesi gelen teslimatın yenileme siparişi açıldı; sipariş kimliği ve teslimat günüyle. Kapsam: subscriptions:read.
subscription.payment_issueAbonelikte ödeme sorunuAbonelik ödeme sorunu durumuna geçti; yeni teslimat açılmaz. Kart reddi ayrıca payment.failed olayıdır. Kapsam: subscriptions:read.
subscription.pausedAbonelik durduAbonelik durdu (ürün satıştan kalktı, işletme kapandı veya iptal geri alınıp durmuş haline döndü). Kapsam: subscriptions:read.
subscription.resumedAbonelik sürdüDurmuş, ödeme sorunlu veya iptal edilmiş abonelik yeniden etkin oldu. Kapsam: subscriptions:read.
subscription.cancelledAbonelik iptal edildiMüşteri, satıcı veya ilk siparişin iptali aboneliği kapattı; açılmış siparişler değişmez. Kapsam: subscriptions:read.
coupon.createdKupon oluşturulduYeni kupon açıldı. Kapsam: coupons:read.
coupon.updatedKupon değiştiKuponun kodu, indirimi, geçerliliği, sınırları, kapsamı veya açık/kapalı durumu değişti. Kapsam: coupons:read.
coupon.archivedKupon arşivlendiKupon silindi: listeden kalktı, sepette uygulanmaz; siparişlerdeki kupon kalır. Kapsam: coupons:read.
coupon.restoredKupon geri getirildiArşivdeki kupon geri geldi. Kapsam: coupons:read.
channel.order_importedKanal siparişi alındıBağlı satış kanalındaki (pazaryeri veya site) yeni sipariş içe alındı; sipariş başına bir kez. Kapsam: channels:read.
channel.problemKanal bağlantısında sorunKanal bağlantısı çalışmıyor (anahtar veya yetki geçersiz, uygulama kaldırıldı): stok gitmez, sipariş gelmez. Sorun sürerken tekrarlanmaz. Kapsam: channels:read.
channel.recoveredKanal bağlantısı düzeldiSorunlu kanal bağlantısı yeniden çalışıyor. Kapsam: channels:read.
webhook.testDeneme bildirimiUç kurulurken veya deneme istendiğinde imzalı gönderilir; abonelikte seçilmesi gerekmez ve olay akışında bulunmaz. Kapsam: webhooks:manage.

Kapsamlar

İşletme sahibi anahtar veya uygulama onayı verirken seçer; yazma kapsamı okuma izni vermez. Alan: scopes.

KodTürkçe adıNe zaman
orders:readSiparişler · GörSiparişleri, satırlarını ve durum geçmişini okumak.
orders:writeSiparişler · DeğiştirSipariş açmak, onaylamak, teslim etmek, düzeltmek, iptal etmek; başka kanaldaki satışı bildirmek.
products:readÜrünler · GörÜrün, seçenek, kategori, ürün markası ve marka fiyatlarını okumak.
products:writeÜrünler · DeğiştirÜrün, seçenek, kategori, ürün markası ve marka fiyatı yazmak; toplu fiyat güncellemek.
inventory:readStok · GörDepoları, stok miktarlarını, stok hareketlerini ve belgelerini okumak.
inventory:writeStok · DeğiştirStok girişi, sayım, fire ve depolar arası taşıma; ürün açarken ilk stok; toplu stok sayımı.
customers:readMüşteriler · GörMüşteri kartlarını okumak; ad, telefon, e-posta ve adres için ayrıca personal_data:read gerekir.
customers:writeMüşteriler · DeğiştirMüşteri eklemek, güncellemek, arşivlemek ve geri getirmek.
shipments:readGönderiler · GörGönderileri okumak ve kargo etiketini indirmek.
shipments:writeGönderiler · DeğiştirKargo fiyatı sormak, gönderi açmak ve iptal etmek; iadede ücretli geri gönderim kodu açmak.
returns:readİadeler · GörSiparişin iade ve değişim kayıtlarını okumak.
returns:writeİadeler · Değiştirİade talebini onaylamak veya reddetmek, iadeyi önizlemek ve başlatmak.
invoices:readFaturalar · GörFaturaları okumak ve fatura belgesini indirmek.
invoices:writeFaturalar · DeğiştirFatura kesmek ve iptal etmek.
coupons:readKuponlar · GörKuponları okumak.
coupons:writeKuponlar · DeğiştirKupon eklemek ve güncellemek.
campaigns:readKampanyalar · GörKampanyaları okumak. Bu sürümde bu kapsamı isteyen uç yok.
campaigns:writeKampanyalar · DeğiştirKampanyaları değiştirmek. Bu sürümde bu kapsamı isteyen uç yok.
subscriptions:readAbonelikler · GörAbonelikleri okumak.
subscriptions:writeAbonelikler · DeğiştirAbonelikleri değiştirmek. Bu sürümde bu kapsamı isteyen uç yok.
payments:readÖdemeleri görSiparişin tahsilat ve geri ödemelerini, para özetini okumak.
channels:readKanalları görSatış kanallarını okumak.
events:readOlayları görOlay akışını okumak; olayın kaynağının okuma kapsamı da gerekir (ör. sipariş olayı için orders:read).
webhooks:manageWebhook yönetBu bağlantının webhook adreslerini eklemek, değiştirmek ve kapatmak.
exports:writeDışa aktarDışa aktarma dosyası hazırlamak ve indirmek; kaynağın okuma kapsamı da gerekir.
personal_data:readKişisel verileri görMüşteri adı, telefonu, e-postası ve adresini görmek; e-posta veya telefonla aramak. İşletme sahibi KVKK uyarısını okuyarak seçer.
personal_data:writeKişisel verileri değiştirMüşteri adı, telefonu, e-postası ve adresini yazmak.
costs:readMaliyet ve tedarikçiyi görAlış fiyatını, maliyeti ve tedarikçiyi görmek.
costs:writeAlış fiyatı ve tedarikçiyi yazAlış fiyatı, maliyet, KDV seçimi ve tedarikçi yazmak.
money_out:writePara çıkışıMüşteriye para iadesi doğuran iade, iptal ve düzeltmeler. Hazır şablonlarda kapalıdır.
internal_notes:readİç notları görSipariş, müşteri ve stoktaki iç notları görmek.
internal_notes:writeİç notları değiştirİç not yazmak.
archive:writeArşivle ve geri getirKayıtları arşivlemek ve arşivden geri getirmek.
customers:eraseKVKK anonimleştirmesiMüşteriyi KVKK kapsamında geri alınamaz biçimde anonimleştirmek. Yalnız Özel şablonda seçilir.