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

Veri modelleri

İç içe alanların türü bu modellerden gelir. İzin verilmeyen veya include ile seçilmeyen alan yanıtta bulunmayabilir; null ayrı bir değerdir.

Address
AlanTürZorunluAçıklamaÖrnek
address_linemetin · null olabilirHayırAdres satırı; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
citymetin · null olabilirHayırİl; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
districtmetin · null olabilirHayırİlçe; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
full_namemetin · null olabilirHayırAd soyad; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
neighborhoodmetin · null olabilirHayırMahalle; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
neighborhood_areametin · null olabilirHayırVarsa bağlı köy, semt veya belde; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
phonemetin · null olabilirHayırTelefon; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
postal_codemetin · null olabilirHayırPosta kodu; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
villagetrue/false · null olabilirHayırKöy adresi işareti; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
AnonymizeCustomer
AlanTürZorunluAçıklamaÖrnek
confirmsabit "anonymize"EvetGeri alınamaz anonimleştirme için zorunlu açık onay; tam olarak anonymize yazın."anonymize"
reasonmetin (en çok 1000 karakter) · null olabilirHayırİsteğe bağlı gerekçe; kişisel veri yazmayın. Denetim kaydında maskelenir, yanıtta ve olayda yayımlanmaz."Müşterinin KVKK silme isteği."
ApplicationIdentity
AlanTürZorunluAçıklamaÖrnek
idmetinEvetUygulamanın app_ önekli kimliği."app_1234567890abcdef1234567890abcdef"
installation_idmetinEvetBu işletmedeki kurulumun ins_ önekli kimliği."ins_1234567890abcdef1234567890abcdef"
namemetinEvetUygulama adı."Örnek uygulama"
Attempt
AlanTürZorunluAçıklamaÖrnek
attempted_attarih-saatEvetTeslim denemesi zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
duration_mstam sayıEvetTeslim denemesinin milisaniye cinsinden süresi.120
errormetin · null olabilirEvetDenemenin hata kodu; başarıda null.null
idmetinEvetKaynağın dış kimliği; wha_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."wha_1234567890abcdef1234567890abcdef"
status_codetam sayı · null olabilirEvetAlıcı HTTP durum kodu; ağ hatasında null.200
Billing
AlanTürZorunluAçıklamaÖrnek
company_namemetin · null olabilirHayırFatura unvanı; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
tax_numbermetin · null olabilirHayırVergi/kimlik numarası; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
tax_officemetin · null olabilirHayırVergi dairesi; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
Box
AlanTürZorunluAçıklamaÖrnek
depthsayı (en çok 1000)EvetBir kolinin boyu, cm.20
heightsayı (en çok 1000)EvetBir kolinin yüksekliği, cm.20
weightsayı (en çok 10000)EvetBir kolinin ağırlığı, kg.1
widthsayı (en çok 1000)EvetBir kolinin eni, cm.20
counttam sayı (en az 1; en çok 99)HayırAynı ölçüdeki koli sayısı.1
Brand
AlanTürZorunluAçıklamaÖrnek
idmetinEvetKaynağın dış kimliği; sto_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."sto_1234567890abcdef1234567890abcdef"
namemetinEvetErişilebilen markanın adı."Örnek Marka"
BrandFields
AlanTürZorunluAçıklamaÖrnek
logometin (en çok 2000 karakter) · null olabilirHayırPaneldeki ürün markası logosunun URL adresi; null temizler.null
namemetin (en çok 500 karakter) · null olabilirHayırGörünen ad; aynı ad paneldeki gibi ayrı kayıt açabilir."Mutfak"
sort_ordertam sayı (en az 0; en çok 2147483647) · null olabilirHayırSıra; küçük değer önce gelir.1
statusmetin (seçenekler: active, inactive) · null olabilirHayırVitrinde görünürlük: active açık, inactive kapalı."active"
BulkErrorPage
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (BulkRowError)EvetBu sayfadaki satır hataları.
has_moretrue/falseEvetSonraki sayfa varsa true.false
next_cursormetin · null olabilirEvetSonraki sayfanın yetkiye bağlı imleci.null
BulkInventory
AlanTürZorunluAçıklamaÖrnek
linesliste: nesne (BulkInventoryLine) (en çok 10000 öğe)EvetEn çok 10.000 sayım satırı; her satırda expected zorunludur.
locationmetin (en çok 36 karakter)EvetSayımın loc_ depo kimliği."loc_1234567890abcdef1234567890abcdef"
BulkInventoryLine
AlanTürZorunluAçıklamaÖrnek
expectedsayı (en az -100000000; en çok 100000000) veya metin · null olabilirEvetZorunlu: son okunan depo miktarı; stok sayılmıyorsa null. Değişmişse satır stock_changed ile atlanır."10"
quantitysayı (en az 0; en çok 100000000) veya metinEvetDepoda sayılan miktar; sıfır olabilir, en çok üç ondalık hane."12"
skumetin (en çok 200 karakter) · null olabilirHayırStok kodu; harf ve baş/son boşluk farkı yok sayılır."KUPA-MAVI"
variantmetin (en çok 36 karakter) · null olabilirHayırvar_ seçenek kimliği; variant veya sku alanından yalnız biri gerekir."var_1234567890abcdef1234567890abcdef"
BulkJob
AlanTürZorunluAçıklamaÖrnek
created_attarih-saatEvetİşin açıldığı zaman; RFC 3339 UTC."2026-10-16T09:00:00Z"
error_codemetin · null olabilirEvetİşin tamamını durduran sabit kod; satır hataları ayrı listelenir.null
failedtam sayıEvetHatalı satır sayısı; /jobs/{id}/errors ile okunur.0
finished_attarih-saat · null olabilirEvetİşin bittiği zaman; sürüyorsa null.null
idmetinEvetKalıcı job_ iş kimliği."job_1234567890abcdef1234567890abcdef"
kindmetin (seçenekler: prices, inventory)Evetprices fiyat; inventory depo sayımı."prices"
processedtam sayıEvetSonuçlandırılan satır sayısı; başarısız satırlar dahildir.0
statusmetin (seçenekler: queued, running, succeeded, failed, partially_failed)EvetSırada, çalışıyor, başarılı, başarısız veya kısmen başarısız."queued"
totaltam sayıEvetGönderilen toplam satır sayısı.10000
BulkPriceLine
AlanTürZorunluAçıklamaÖrnek
pricesayı (en az 0; en çok 999999999) veya metinEvetExcel Fiyat sütunu: indirimsiz TRY fiyatı. compare_at_price verilirse price satış fiyatı, compare_at_price indirimsiz fiyat olarak eşlenir."120.00"
compare_at_pricesayı (en az 0; en çok 999999999) veya metin · null olabilirHayırÜstü çizili fiyat için alternatif gösterim; sale_price ile birlikte kullanılamaz. null indirimi kaldırır. Marka fiyat sütunu indirim yazmaz.null
costsayı (en az 0; en çok 999999999) veya metin · null olabilirHayırExcel Maliyet sütunu; costs:write gerekir. KDV hariç, muaf işletmede KDV dahil; null değiştirmez.null
sale_pricesayı (en az 0; en çok 999999999) veya metin · null olabilirHayırExcel İndirimli fiyat sütunu. Atlanırsa paneldeki oran korunur; null indirimi kaldırır. Seçenek indirimi ürünün kuralına uymalıdır.null
skumetin (en çok 200 karakter) · null olabilirHayırStok kodu; harf ve baş/son boşluk farkı yok sayılır."KUPA-MAVI"
storemetin (en çok 36 karakter) · null olabilirHayırsto_ marka fiyat sütunu; atlanırsa katalog fiyatı. Ürün markaya bağlı olmalıdır. Marka sütunu yalnız satış fiyatını değiştirir.null
variantmetin (en çok 36 karakter) · null olabilirHayırvar_ seçenek kimliği; variant veya sku alanından yalnız biri gerekir."var_1234567890abcdef1234567890abcdef"
BulkPrices
AlanTürZorunluAçıklamaÖrnek
linesliste: nesne (BulkPriceLine) (en çok 10000 öğe)EvetEn çok 10.000 fiyat satırı; satır numaraları 1 ile başlar.
BulkRowError
AlanTürZorunluAçıklamaÖrnek
codemetinEvetSabit hata kodu: not_found, invalid_price, invalid_stock_operation, duplicate_row, stock_changed veya row_timeout."not_found"
detailmetinEvetSatırın neden uygulanmadığı."Seçenek bulunamadı."
identifiermetinEvetİstekteki var_ kimliği veya stok kodu."BULUNAMAYAN-KOD"
linetam sayıEvetGönderilen listedeki satır numarası; 1 ile başlar.2
Business
AlanTürZorunluAçıklamaÖrnek
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
currencysabit "TRY"EvetPara birimi; v1 tutarları Türk lirasıdır."TRY"
idmetinEvetKaynağın dış kimliği; bus_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."bus_1234567890abcdef1234567890abcdef"
kindmetin (seçenekler: company, exempt)Evetİşletme türü; company: şirket, exempt: vergi muafiyetli kişi."company"
namemetinEvetKaydın görünen adı."Örnek Ticaret"
tax_statusmetin (seçenekler: standard, exempt)Evetstandard: KDV mükellefi; exempt: vergiden muaf."standard"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
CancelInvoice
AlanTürZorunluAçıklamaÖrnek
portal_donetrue/falseHayırYalnız sağlayıcı portalında iptal gerçekten tamamlandıysa true.false
reasonmetin (en çok 450 karakter) · null olabilirHayırİptal gerekçesi; muhasebe kaydında korunur."Yanlış fatura düzenlendi."
CancelShipment

Alanı olmayan değer.

CatalogAction

Arşiv ve geri getirme boş JSON nesnesi alır.

CatalogOption
AlanTürZorunluAçıklamaÖrnek
namemetin (en çok 100 karakter)EvetSeçenek özelliğinin adı."Renk"
valuemetin (en çok 200 karakter)EvetSeçenek özelliğinin değeri."Mavi"
CatalogReference
AlanTürZorunluAçıklamaÖrnek
idmetin (en çok 200 karakter)EvetKendi sisteminizdeki kimlik; grant ve kaynak türünde tekildir."ERP-001"
namespacemetin · null olabilirHayırKalıcı grt_ kimliği; atlanabilir, başka bağlantının ad alanı seçilemez.null
Category
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseEvetArşivdeki veya kapanmış kaynaksa true. archived=true süzgeci bunları da içerir.false
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
descriptionmetin · null olabilirEvetKaynağın açıklama metni."Seramik kupa, 300 ml."
idmetinEvetKaynağın dış kimliği; cat_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."cat_1234567890abcdef1234567890abcdef"
imagemetin · null olabilirEvetGörselin genel HTTPS adresi."https://example.com/kupa.jpg"
namemetinEvetKaydın görünen adı."Mutfak"
parentmetin · null olabilirEvetÜst kategori kimliği (cat_ ve 32 küçük onaltılık karakter).null
revisiontam sayıEvetKaydın revizyonu; If-Match için ETag ile birlikte kullanılır.1
slugmetin · null olabilirEvetAdreslerde kullanılan kısa ad."ornek-kupa"
sort_ordertam sayıEvetPanel ve vitrindeki sırası; küçük değer önce gelir.0
statusmetinEvetKaynağın işlem durumu."active"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
CategoryFields
AlanTürZorunluAçıklamaÖrnek
descriptionmetin (en çok 50000 karakter) · null olabilirHayırKategori açıklaması; null temizler."Mutfak ürünleri"
imagemetin (en çok 2000 karakter) · null olabilirHayırPaneldeki kategori görselinin URL adresi; null temizler.null
namemetin (en çok 500 karakter) · null olabilirHayırGörünen ad; aynı ad paneldeki gibi ayrı kayıt açabilir."Mutfak"
parentmetin · null olabilirHayırÜst cat_ kategori kimliği; null ana kategori yapar.null
sort_ordertam sayı (en az 0; en çok 2147483647) · null olabilirHayırSıra; küçük değer önce gelir.1
statusmetin (seçenekler: active, inactive) · null olabilirHayırVitrinde görünürlük: active açık, inactive kapalı."active"
ChangeItem
AlanTürZorunluAçıklamaÖrnek
idmetinEvetDeğişen sipariş satırının lin_ kimliği."lin_1234567890abcdef1234567890abcdef"
quantitysayı (en az 0; en çok 100000) veya metinEvetYeni miktar; 0 satırı çıkarır, reason gerekir. Son ürün çıkarılamaz."1"
reasonmetin (en çok 200 karakter)HayırÜrün çıkarılırken zorunlu gerekçe."Müşteri bir adet istedi."
unit_pricesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırYeni TRY birim fiyatı; yalnız panelde fiyat düzeltilebilen siparişte ve orders.price izniyle."120.00"
variantmetin · null olabilirHayırYeni var_ seçeneği; atlanırsa satırın seçeneği korunur."var_1234567890abcdef1234567890abcdef"
CorrectOrderStatus
AlanTürZorunluAçıklamaÖrnek
statusmetin (seçenekler: pending, payment_pending, confirmed, processing, shipped, delivered, cancelled)EvetHedef durum; panelin gerekçeli düzeltme kuralları geçerlidir. refunded desteklenmez; payment_pending eski değerdir, 409 döner (ödeme durum değildir: Ödeme alındı ucunu kullanın)."confirmed"
expected_statusmetin (en çok 30 karakter) · null olabilirHayırGördüğünüz sipariş durumu; kilit altında farklıysa 409 status_mismatch."confirmed"
reasonmetin (en çok 1000 karakter)Hayırİşlemin gerekçesi; correct-status ve başka kanalda bildirilen satışın iptali için zorunlu."Müşteri teslim aldı."
CountLine
AlanTürZorunluAçıklamaÖrnek
expectedsayı (en az -100000000; en çok 100000000) veya metin · null olabilirEvetZorunlu: okuduğunuz depo miktarı. Stok sayılmıyorsa açıkça null gönderin; değişmişse 409 stock_changed."10"
quantitysayı (en az 0; en çok 100000000) veya metinEvetSaydığınız depo miktarı; sıfır olabilir."12"
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"
CountStock
AlanTürZorunluAçıklamaÖrnek
linesliste: nesne (CountLine) (en çok 500 öğe)EvetSayımın miktarı ve her satır için zorunlu expected değeri.
locationmetinEvetİşlemin loc_ depo kimliği; /locations listesinden seçin."loc_1234567890abcdef1234567890abcdef"
notemetin (en çok 300 karakter) · null olabilirHayırİç açıklama; internal_notes:write gerekir, okumak için internal_notes:read gerekir."Depoda kontrol edildi."
reasonmetin (seçenekler: other_channel, gift, loss, count_diff, received, return, other) · null olabilirHayırİsteğe bağlı sayım nedeni; yalnız miktar değişiminin yönüne uygun satırlarda görünür."count_diff"
storemetin · null olabilirHayırsto_ marka kimliği; tek markada veya marka sınırlı anahtarda atlanabilir."sto_1234567890abcdef1234567890abcdef"
Coupon
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseEvetArşivdeyse true; sepette uygulanmaz.false
categoriesliste: metinEvetGörünür cat_ kategori kimlikleri; alt kategoriler dahil. Marka sınırı bazı kimlikleri gizleyebilir; kapsamı category_restricted belirtir.
category_restrictedtrue/falseEvetKupon kategoriyle sınırlıysa true; categories boş görünse de kapsam bütün ürünler olmayabilir.false
codemetinEvetMüşterinin kullanacağı normalleştirilmiş kupon kodu."MERHABA10"
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
currencysabit "TRY"EvetTutarların para birimi."TRY"
customer_restrictedtrue/falseEvetPanelden belirli müşterilere atanmışsa true; müşteri kimlikleri ve kişisel alanlar yayımlanmaz.false
discount_typemetin (seçenekler: percentage, fixed) · null olabilirEvetYüzde veya TRY tutarı; yalnız ücretsiz kargoda boş olabilir."percentage"
discount_valuemetin · null olabilirEvetİndirim oranı veya TRY tutarı; ondalık metin."10.00"
exclude_discountedtrue/falseEvetİndirimli ve kampanyalı ürünleri kapsam dışında tutar.false
first_order_onlytrue/falseEvetYalnız müşterinin ilk siparişinde geçerliyse true.false
free_shippingtrue/falseEvetKupon geçerliyken kargo da ücretsizse true.false
idmetinEvetcpn_ önekli dış kupon kimliği."cpn_1234567890abcdef1234567890abcdef"
max_usestam sayı · null olabilirEvetToplam kullanım sınırı; null sınırsız.100
max_uses_per_customertam sayı · null olabilirEvetAynı müşteri için kullanım sınırı; null sınırsız.1
min_ordermetin · null olabilirEvetKupona uygun ürünlerde en az sepet tutarı, TRY."100.00"
revisiontam sayıEvetKaydın revizyonu; If-Match için ETag ile birlikte kullanılır.1
statusmetin (seçenekler: active, inactive)Evetactive açık, inactive kapalı kupon."active"
storemetinEvetKuponun geçerli olduğu sto_ markası."sto_1234567890abcdef1234567890abcdef"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
used_counttam sayıEvetPanelin siparişlerden hesapladığı kullanım sayısı; iptal ve tam iadeler sayılmaz.0
valid_frommetin · null olabilirEvetMarkanın yerel takvim günü (YYYY-MM-DD) veya dakika dahil saati (YYYY-MM-DDTHH:MM); null sınırsız."2026-10-16"
valid_untilmetin · null olabilirEvetMarkanın yerel bitiş günü veya saati; gün ve son dakika dahildir. null sınırsız."2026-12-31T23:59"
CouponAction

Arşiv eylemlerine boş JSON gönderilir.

CreateBrand
AlanTürZorunluAçıklamaÖrnek
namemetin (en çok 500 karakter)EvetÜrün markası adı; satıcının sto_ markasından ayrıdır."Örnek Üretici"
logometin (en çok 2000 karakter) · null olabilirHayırPaneldeki ürün markası logosunun URL adresi; null temizler.null
sort_ordertam sayı (en az 0; en çok 2147483647) · null olabilirHayırSıra; küçük değer önce gelir.1
statusmetin (seçenekler: active, inactive) · null olabilirHayırVitrinde görünürlük: active açık, inactive kapalı."active"
CreateCategory
AlanTürZorunluAçıklamaÖrnek
namemetin (en çok 500 karakter)EvetKategori adı."Mutfak"
descriptionmetin (en çok 50000 karakter) · null olabilirHayırKategori açıklaması; null temizler."Mutfak ürünleri"
imagemetin (en çok 2000 karakter) · null olabilirHayırPaneldeki kategori görselinin URL adresi; null temizler.null
parentmetin · null olabilirHayırÜst cat_ kategori kimliği; null ana kategori yapar.null
sort_ordertam sayı (en az 0; en çok 2147483647) · null olabilirHayırSıra; küçük değer önce gelir.1
statusmetin (seçenekler: active, inactive) · null olabilirHayırVitrinde görünürlük: active açık, inactive kapalı."active"
CreateCoupon
AlanTürZorunluAçıklamaÖrnek
codemetin (en çok 40 karakter)EvetMüşterinin yazacağı kupon kodu."MERHABA10"
categoriesliste: metin (en çok 100 öğe) · null olabilirHayırcat_ kimlikleri; alt kategoriler dahil. [] bütün ürünlerde geçerli yapar.
discount_typemetin (seçenekler: percentage, fixed) · null olabilirHayırYüzde veya sabit TRY tutarı; null temizler."percentage"
discount_valuesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırYüzde oranı veya TRY tutarı; ondalık metin, null temizler."10.00"
exclude_discountedtrue/false · null olabilirHayırİndirimli/kampanyalı ürünlere uygulanmayacaksa true.false
first_order_onlytrue/false · null olabilirHayırYalnız ilk siparişte geçerliyse true.false
free_shippingtrue/false · null olabilirHayırKargo da ücretsizse true.false
max_usestam sayı (en az 1; en çok 2147483647) · null olabilirHayırToplam kullanım sınırı; null sınırsız.100
max_uses_per_customertam sayı (en az 1; en çok 2147483647) · null olabilirHayırKişi başına kullanım sınırı; null sınırsız.1
min_ordersayı (en az 0; en çok 10000000) veya metin · null olabilirHayırKupona uygun ürünlerin en az TRY tutarı; null kaldırır."100.00"
statusmetin (seçenekler: active, inactive) · null olabilirHayıractive açık, inactive kapalı."active"
storemetin · null olabilirHayırsto_ marka kimliği; tek markada veya marka sınırlı anahtarda atlanabilir.null
valid_frommetin (en çok 35 karakter) · null olabilirHayırPanel gibi markanın yerel günü veya dakikası; YYYY-MM-DD ya da ISO tarih/saat. null sınırı kaldırır."2026-10-16"
valid_untilmetin (en çok 35 karakter) · null olabilirHayırBitiş günü/dakikası dahildir; saat dilimli ISO zaman markanın saatine çevrilir. null sınırsız."2026-12-31T23:59"
CreateCustomer
AlanTürZorunluAçıklamaÖrnek
namemetin (en çok 500 karakter)EvetMüşterinin adı; personal_data:write gerekir."Örnek Müşteri"
addressnesne (CustomerAddress) · null olabilirHayırMüşterinin adresi; null adresi kaldırır. personal_data:write gerekir.
emailmetin (en çok 320 karakter) · null olabilirHayırE-posta; null veya boş metin alanı temizler. personal_data:write gerekir."musteri@example.com"
invoicenesne (CustomerInvoice) · null olabilirHayırFatura bilgisi; null kaldırır. personal_data:write gerekir.
marketing_consenttrue/false · null olabilirHayırPazarlama izni: true var, false yok, null bilinmiyor. personal_data:write gerekir.false
notemetin (en çok 10000 karakter) · null olabilirHayırİç not; null veya boş metin kaldırır. internal_notes:write gerekir."Teslimden önce bilgi verin."
phonemetin (en çok 50 karakter) · null olabilirHayırTelefon; null veya boş metin alanı temizler. personal_data:write gerekir."05000000000"
storemetin · null olabilirHayırsto_ marka kimliği; tek markada veya marka sınırlı anahtarda atlanabilir."sto_1234567890abcdef1234567890abcdef"
CreateExternalOrder
AlanTürZorunluAçıklamaÖrnek
channel_namemetin (en çok 20 karakter)EvetSatış kanalının en çok 20 karakterlik adı. Baş/son boşluklar kaldırılır; büyük/küçük harfler farklı kanal adlarıdır."Etsy"
external_referencemetin (en çok 200 karakter)EvetKanalın sipariş numarası; bu grant ve channel_name içinde kalıcı olarak tekildir."ETSY-2026-001"
itemsliste: nesne (ExternalOrderItem) (en çok 100 öğe)Evetvar_ veya SKU, miktar ve kesinleşmiş birim fiyatıyla satış satırları.
customermetin veya nesne (OrderCustomer) · null olabilirHayırcus_ müşteri kimliği veya müşteri bilgileri; personal_data:write gerekir. E-posta/telefon yoksa yeni müşteri kartı açılmaz.null
fulfillment_statusmetin (seçenekler: pending, shipped, delivered)Hayırpending: sonra siparis.app ile kargolanabilir; shipped/delivered: kanal kargoladı/teslim etti, burada gönderi açılmaz."pending"
ordered_attarih-saat · null olabilirHayırKanalda siparişin verildiği saat dilimli tarih; geçmiş kabul edilir, gelecek reddedilir. Atlanırsa kayıt anı."2026-10-15T09:00:00Z"
paid_attarih-saat · null olabilirHayırKanalın ödemeyi aldığı saat dilimli tarih; gelecek reddedilir. Atlanırsa ordered_at, o da yoksa kayıt anı."2026-10-15T09:01:00Z"
shipping_addressnesne (OrderAddress) · null olabilirHayırTeslimat adresi; personal_data:write gerekir. Adressiz satış kaydedilir; kargo için adres tamamlanır.
shipping_totalsayı (en az 0; en çok 10000000) veya metinHayırKanalda müşteriden alınmış TRY kargo ücreti; toplam tahsilata eklenir."0.00"
storemetin · null olabilirHayırsto_ marka kimliği; tek markada veya marka sınırlı anahtarda atlanabilir.null
CreateOrder
AlanTürZorunluAçıklamaÖrnek
delivery_methodmetin (seçenekler: shipping, hand, pickup, digital)Evetshipping: kargo; hand: elden; pickup: markadan teslim; digital: dijital teslim."hand"
itemsliste: nesne (OrderItem) (en çok 100 öğe)EvetSatılacak seçenekler ve miktarları.
allow_waitingtrue/falseHayırtrue: stokta olmayan adetler mal gelince gönderilir; panelle aynı açık onaydır.false
billing_addressnesne (OrderAddress) · null olabilirHayırDijital üründe zorunlu fatura adresi; personal_data:write gerekir.
cod_typemetin (seçenekler: cash, card) · null olabilirHayırYalnız kargoyla kapıda ödemede: nakit veya kart."cash"
coupon_codemetin (en çok 60 karakter)HayırMüşteriye tanımlı kupon; mevcut kullanım, süre ve ürün koşulları uygulanır."HOSGELDIN"
customermetin veya nesne (OrderCustomer) · null olabilirHayırMevcut cus_ müşteri kimliği veya ad/telefon/e-posta. personal_data:write gerekir. Atlanırsa elden/mağazadan müşterisiz satış."cus_1234567890abcdef1234567890abcdef"
customer_notemetin (en çok 2000 karakter)HayırPaketleme fişine de giren müşteri notu; personal_data:write gerekir."Teslimden önce arayın."
delivery_daytarih · null olabilirHayırMarkanın takvimine göre söz verilen teslim günü; dijitalde uygulanmaz."2026-10-17"
depositnesne (PaymentPart) · null olabilirHayırŞimdi alınan kapora; toplamdan küçük olmalı. paid=false gönderin.
external_referencenesne (ExternalReference) · null olabilirHayırDış sipariş numarasını bu API bağlantısında tekilleştirir; anahtar döndürmek ad alanını değiştirmez.
notemetin (en çok 2000 karakter)Hayırİç not; internal_notes:write gerekir."Paket kontrol edildi."
paidtrue/falseHayırÖdeme gerçekten alındıysa true. Kapıda ödemede false; parçalı ödemede parçalar alınmış sayılır.true
payment_methodmetin (seçenekler: cod, bank_transfer, cash, credit_card, split) · null olabilirHayırPaneldeki elle ödeme yolu; credit_card POS kaydıdır, kart çekimi başlatmaz. 0 TL siparişte atlanabilir."cash"
paymentsliste: nesne (PaymentPart) (en çok 20 öğe) · null olabilirHayırsplit yönteminde alınan ödeme parçaları; toplam sipariş tutarıyla aynı olmalıdır.
shipping_addressnesne (OrderAddress) · null olabilirHayırKargoda zorunlu, elden teslimde isteğe bağlı adres; personal_data:write gerekir.
shipping_feesayı (en az 0; en çok 100000) veya metin · null olabilirHayırTRY teslimat ücreti; atlanırsa panelin marka kuralı, verilirse orders.price izniyle açık tutar."0.00"
storemetin · null olabilirHayırSiparişin sto_ marka kimliği; tek markada veya marka sınırlı anahtarda atlanabilir."sto_1234567890abcdef1234567890abcdef"
CreateProduct
AlanTürZorunluAçıklamaÖrnek
namemetin (en çok 500 karakter)EvetÜrün adı."Seramik Kupa"
barcodemetin (en çok 100 karakter) · null olabilirHayırBarkod; işletmede canlı seçenekler arasında tekil. null temizler."8690000000001"
brandmetin · null olabilirHayırMevcut brd_ ürün markası; null bağı kaldırır. Satıcının sto_ markasıyla karıştırmayın.null
categoriesliste: metin (en çok 100 öğe) · null olabilirHayırMevcut cat_ kategori kimlikleri; [] bağları kaldırır. Yeni kategori açmaz.
compare_pricesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırÜstü çizili fiyat; null kaldırır. Üründe satış fiyatından yüksek olmalıdır."150.00"
costsayı (en az 0; en çok 10000000) veya metin · null olabilirHayırAlış maliyeti; costs:write gerekir. Panel gibi KDV hariç, muaf işletmede KDV dahil saklanır; null kaldırır."80.00"
descriptionmetin (en çok 50000 karakter) · null olabilirHayırÜrün açıklaması; null kaldırır."Seramik kupa, 300 ml."
external_referencenesne (CatalogReference) · null olabilirHayırBu API bağlantısında ürünün dış kimliği.
imagesliste: metin (en çok 2000 karakter) (en çok 12 öğe) · null olabilirHayırEn çok 12 http/https görsel URL’si; [] galeriyi boşaltır. Panelin güvenli kopyalama kuyruğu kullanılır.
made_to_ordertrue/false · null olabilirHayırSipariş üzerine hazırlanırsa true; mevcut stok korunur.false
opening_stocksayı (en az 0; en çok 100000) veya metin · null olabilirHayırSeçeneksiz ürünün ilk stoğu; inventory:write gerekir. Seçenekli üründe her seçeneğe yazın."10"
pricesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırTRY satış fiyatı; ondalık metin. null ürünün fiyatını kaldırır, seçenekte ürün fiyatına döner."120.00"
short_descriptionmetin (en çok 1000 karakter) · null olabilirHayırKısa açıklama; null kaldırır."Seramik kupa"
skumetin (en çok 255 karakter) · null olabilirHayırStok kodu; işletmede canlı seçenekler arasında tekil. null temizler."KUPA-MAVI"
statusmetin (seçenekler: active, draft, inactive) · null olabilirHayırSatış durumu; arşiv için ayrı eylemi kullanın. Fiyatsız ürün satışa açılamaz."active"
storemetin · null olabilirHayırHedef sto_ markası; tek markada veya marka sınırlı anahtarda atlanabilir.null
storesliste: metin (en çok 100 öğe) · null olabilirHayırBirden çok hedef sto_ markası; store ile birlikte gönderilmez.
tax_ratesayı (en az 0; en çok 100) veya metin · null olabilirHayırYüzde KDV oranı; panelin vergi sınıfı doğrulaması kullanılır."20"
unitmetin (en çok 20 karakter) · null olabilirHayırSatış birimi; panelin miktar doğrulaması kullanılır."adet"
variantsliste: nesne (CreateVariant) (en çok 500 öğe) · null olabilirHayırÜrünle aynı işlemde açılacak seçenekler; bir hata tüm kaydı geri alır.
weightsayı (en az 0; en çok 100000) veya metin · null olabilirHayırKilogram cinsinden ağırlık; null kaldırır."0.350"
CreateRefund
AlanTürZorunluAçıklamaÖrnek
expected_amountsayı (en az 0; en çok 10000000) veya metinEvetSon önizlemenin amount değeri, TRY; değişmişse 409 amount_changed döner."120.00"
amountsayı (en az 0; en çok 10000000) veya metin · null olabilirHayırİsteğe bağlı TRY tutarı; boşsa panelin önerisi. Kalan tahsilatı aşamaz."120.00"
itemsliste: nesne (ReturnItem) (en çok 200 öğe)Hayırİade kalemleri; boşsa yalnız para iadesidir ve amount zorunludur.
money_returnedtrue/falseHayırParayı gerçekten elle geri verdiyseniz true. Çevrimiçi kartta false bırakın; sağlayıcı sonucu beklenir.false
notify_customertrue/falseHayırİade e-postasını müşteriye gönder.true
reasonmetin (en çok 200 karakter)Hayırİade nedeni; kişisel bilgi yazmayın."Müşteri ürünü iade etti"
received_conditionmetin (seçenekler: sound, damaged) · null olabilirHayırFiziksel teslim onayı. Fire için damaged ve restock=false birlikte gerekir."sound"
refund_distributionnesne (Distribution-Input) · null olabilirHayırDeğişim/ayrılan siparişte önizlemenin kart ve elle ödeme dağılımı; oluştururken aynen gönderin.
refund_methodmetin (seçenekler: cash, pos, iban) · null olabilirHayırPanelin izin verdiği elle iade yolu; çevrimiçi karta iade otomatik belirlenir.null
refund_partsliste: nesne (RefundPart) (en çok 20 öğe) · null olabilirHayırElle geri verilen parçalar; toplam iade tutarına eşit, money_returned=true olmalı.null
restocktrue/false · null olabilirHayırStoğa geri ekleme seçimi. Boşsa panel/AI varsayılanı: iade edilemez veya hasarlı ürün eklenmez. false tek başına fire yazmaz.null
CreateShipment
AlanTürZorunluAçıklamaÖrnek
carriermetin (en çok 40 karakter)EvetFiyat yanıtındaki açık kargo firmasının code değeri; standart gönderi hizmeti."YURTICI"
merge_ordersliste: metin (en çok 99 öğe)HayırAynı marka, alıcı, adres ve depodaki diğer ord_ siparişleri; birleştirme açık seçimdir.
packagenesne (Package) · null olabilirHayırYalnız bu sorgu için ölçüler; sorgu siparişi değiştirmez. Açarken aynı ölçüleri gönderin.
CreateVariant
AlanTürZorunluAçıklamaÖrnek
barcodemetin (en çok 100 karakter) · null olabilirHayırBarkod; işletmede canlı seçenekler arasında tekil. null temizler."8690000000001"
compare_pricesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırÜstü çizili fiyat; null kaldırır. Üründe satış fiyatından yüksek olmalıdır."150.00"
costsayı (en az 0; en çok 10000000) veya metin · null olabilirHayırAlış maliyeti; costs:write gerekir. Panel gibi KDV hariç, muaf işletmede KDV dahil saklanır; null kaldırır."80.00"
expected_stocksayı (en az 0; en çok 100000) veya metin · null olabilirHayırİlk seçeneğe dönüşen varsayılanın görülen stoğu; yalnız opening_stock ile kullanılır."0"
external_referencenesne (CatalogReference) · null olabilirHayırBu API bağlantısında seçeneğin dış kimliği.
imagesliste: metin (en çok 2000 karakter) (en çok 12 öğe) · null olabilirHayırEn çok 12 http/https görsel URL’si; [] galeriyi boşaltır. Panelin güvenli kopyalama kuyruğu kullanılır.
made_to_ordertrue/false · null olabilirHayırSipariş üzerine hazırlanırsa true; mevcut stok korunur.false
namemetin (en çok 500 karakter) · null olabilirHayırSeçeneğin görünen adı; gönderilmezse korunur."Mavi"
opening_stocksayı (en az 0; en çok 100000) veya metin · null olabilirHayırİlk stok; inventory:write gerekir. İlk seçenek mevcut varsayılanı dönüştürürse stok korunur; farklı sayı için expected_stock gerekir."10"
optionsliste: nesne (CatalogOption) (en çok 20 öğe) · null olabilirHayırSeçeneğin ad/değer çiftleri; gönderilmezse korunur.
pricesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırTRY satış fiyatı; ondalık metin. null ürünün fiyatını kaldırır, seçenekte ürün fiyatına döner."120.00"
price_rulenesne (PriceRule) · null olabilirHayırÜrün fiyatından TL veya yüzde farkı; null ürünle aynı fiyat demektir.
skumetin (en çok 255 karakter) · null olabilirHayırStok kodu; işletmede canlı seçenekler arasında tekil. null temizler."KUPA-MAVI"
weightsayı (en az 0; en çok 100000) veya metin · null olabilirHayırKilogram cinsinden ağırlık; null kaldırır."0.350"
Customer
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseEvetArşivdeki veya kapanmış kaynaksa true. archived=true süzgeci bunları da içerir.false
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
idmetinEvetKaynağın dış kimliği; cus_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."cus_1234567890abcdef1234567890abcdef"
revisiontam sayı (en az 1)EvetMüşteri kartının artan sürümü; ETag ve If-Match ile birlikte kullanılır.1
storemetinEvetMarka kimliği (sto_ ve 32 küçük onaltılık karakter)."sto_1234567890abcdef1234567890abcdef"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
addressnesne (Address) · null olabilirHayırMüşteri adresi; personal_data:read yoksa alan atlanır.
emailmetin · null olabilirHayırE-posta; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
instagrammetin · null olabilirHayırInstagram kullanıcı adı; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
invoicenesne (Billing) · null olabilirHayırFatura alıcı bilgileri; personal_data:read yoksa alan atlanır.
marketing_consenttrue/false · null olabilirHayırPazarlama iletişimi izni; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
namemetin · null olabilirHayırMüşteri adı; personal_data:read yoksa alan atlanır.null
notemetin · null olabilirHayırİç not; internal_notes:read gerekir. Kişisel kaynakta personal_data:read da gerekir."Örnek iç not"
phonemetin · null olabilirHayırTelefon; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
CustomerAction

Arşiv eylemleri boş JSON nesnesi alır; kişisel alan yazmaz.

CustomerAddress
AlanTürZorunluAçıklamaÖrnek
address_linemetin (en çok 1000 karakter)HayırAçık adres."Örnek Sokak No: 1"
citymetin (en çok 100 karakter)Hayırİl."İstanbul"
districtmetin (en çok 100 karakter)Hayırİlçe."Kadıköy"
neighborhoodmetin (en çok 100 karakter)HayırMahalle veya köy adı."Caferağa"
neighborhood_areametin (en çok 100 karakter)HayırVarsa bağlı köy, semt veya belde.""
postal_codemetin (en çok 10 karakter)HayırPosta kodu."34710"
villagetrue/falseHayırKöy adresiyse true.false
CustomerInvoice
AlanTürZorunluAçıklamaÖrnek
company_namemetin (en çok 500 karakter)EvetŞirket faturası için firma unvanı; panelin doğrulaması uygulanır."Örnek Şirket"
tax_numbermetin (en çok 50 karakter)EvetVergi veya kimlik numarası; panelin VKN/TCKN doğrulaması uygulanır."1234567890"
tax_officemetin (en çok 200 karakter)EvetVergi dairesi; şirket faturasında zorunludur."Kadıköy"
CustomersExportFilters
AlanTürZorunluAçıklamaÖrnek
emailmetin (en çok 320 karakter) · null olabilirHayırHam e-posta; sunucu email_key kolonunun normalleştirmesiyle tam eşitlik arar. personal_data:read gerekir."Ornek@Example.com"
email_keymetin (en çok 320 karakter) · null olabilirHayırNormalize edilmiş e-posta; tam eşitlik araması; personal_data:read gerekir."ornek@example.com"
phonemetin (en çok 50 karakter) · null olabilirHayırHam telefon; mevcut müşteri kuralıyla son 10 haneye çevrilir. personal_data:read gerekir."+90 500 000 00 00"
phone_keymetin · null olabilirHayırTelefonun son 10 hanesi; tam eşitlik araması; personal_data:read gerekir."0000000000"
sortmetin (seçenekler: updated_at, -created_at)Hayırupdated_at: son değişiklikten ileri; -created_at: en yeni müşteri önce. Sıra değişirse yeni sayfalama başlatın."-created_at"
CustomersExportInput
AlanTürZorunluAçıklamaÖrnek
formatmetin (seçenekler: jsonl, csv)Evetjsonl: satır başına JSON nesnesi; csv: her hücresi JSON değeri olan CSV."jsonl"
modesabit "consistent_snapshot"Evetconsistent_snapshot: bütün kayıtlar aynı anın tutarlı görünümüdür."consistent_snapshot"
resourcesabit "customers"EvetDışa aktarılacak kaynak; aynı kaynağın okuma kapsamı gerekir."customers"
filtersnesne (CustomersExportFilters)HayırKaynağın liste süzgeçleri; limit, cursor ve include desteklenmez.
Decision
AlanTürZorunluAçıklamaÖrnek
carriermetin (en çok 50 karakter) · null olabilirHayırGelen kargo firması kodu; boşsa panelin varsayılanı.null
notemetin (en çok 300 karakter)HayırMüşteriye gösterilecek onay notu veya ret nedeni."Talebiniz onaylandı"
notify_customertrue/falseHayırKarar e-postasını müşteriye gönder.true
return_codetrue/falseHayırAçık seçimle geri gönderim kodu aç: BasitKargo bakiyenizden ücretlidir, shipments:write gerekir. Varsayılan false: kodsuz teslim.false
DeliverOrder
AlanTürZorunluAçıklamaÖrnek
collection_methodmetin (seçenekler: cash, pos, bank, later) · null olabilirHayırTeslimde kalan ödemenin yöntemi; later panelde açıkken borcu korur."cash"
expected_statusmetin (en çok 30 karakter) · null olabilirHayırGördüğünüz sipariş durumu; kilit altında farklıysa 409 status_mismatch."confirmed"
reasonmetin (en çok 1000 karakter)Hayırİşlemin gerekçesi; correct-status ve başka kanalda bildirilen satışın iptali için zorunlu."Müşteri teslim aldı."
Delivery
AlanTürZorunluAçıklamaÖrnek
attempt_counttam sayıEvetBu teslim için yapılmış deneme sayısı.0
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
eventmetinEvetOlay kimliği (evt_ ve 32 küçük onaltılık karakter)."evt_1234567890abcdef1234567890abcdef"
idmetinEvetKaynağın dış kimliği; whd_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."whd_1234567890abcdef1234567890abcdef"
last_errormetin · null olabilirEvetSon teslim hatasının kararlı kodu; hata yoksa null.null
last_statustam sayı · null olabilirEvetSon teslim denemesinin HTTP durum kodu; ağ hatasında null.null
next_attempt_attarih-saat · null olabilirEvetSonraki teslim denemesi zamanı; RFC 3339 UTC. Değer yoksa null."2026-10-16T09:00:00Z"
statusmetinEvetTeslimin durumu: pending, succeeded, failed veya cancelled."pending"
typemetinEvetİşlem veya olay türü."order.created"
Distribution-Input
AlanTürZorunluAçıklamaÖrnek
cardsayı (en az 0; en çok 10000000) veya metinEvetKaynak karta gönderilecek TRY tutarı."100.00"
manualsayı (en az 0; en çok 10000000) veya metinEvetElle iade edilecek TRY tutarı."20.00"
providermetin (en çok 100 karakter)EvetÖnizlemede görünen ödeme kuruluşu adı; aynen gönderin."PayTR"
Distribution-Output
AlanTürZorunluAçıklamaÖrnek
cardmetinEvetKaynak karta gönderilecek TRY tutarı."100.00"
manualmetinEvetElle iade edilecek TRY tutarı."20.00"
providermetin (en çok 100 karakter)EvetÖnizlemede görünen ödeme kuruluşu adı; aynen gönderin."PayTR"
Document
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"
movementsnesne (Page_Movement_)EvetBu belgeye ait görünür stok hareketleri; limit/cursor ile ilerleyin.
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 (Supplier) · null olabilirHayırTedarikçi kimliği ve adı; costs:read gerekir; iletişim bilgileri yayımlanmaz.
Endpoint
AlanTürZorunluAçıklamaÖrnek
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
event_typesliste: metinEvetDinlenecek olay türleri; jokerler oluşturma anındaki izinli türlere sabitlenir.
grantmetinEvetAPI bağlantısı kimliği (grt_ ve 32 küçük onaltılık karakter)."grt_1234567890abcdef1234567890abcdef"
idmetinEvetKaynağın dış kimliği; whe_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."whe_1234567890abcdef1234567890abcdef"
last_attempt_attarih-saat · null olabilirEvetSon teslim denemesi zamanı; RFC 3339 UTC. Değer yoksa null.null
last_errormetin · null olabilirEvetSon teslim hatasının kararlı kodu; hata yoksa null.null
last_success_attarih-saat · null olabilirEvetSon başarılı teslim zamanı; RFC 3339 UTC. Değer yoksa null.null
previous_secret_untiltarih-saat · null olabilirEvetÖnceki webhook sırrının geçerlilik sonu zamanı; RFC 3339 UTC. Değer yoksa null.null
schema_versiontam sayıEvetOlay yükünün şema sürümü.1
statusmetin (seçenekler: pending_test, active, disabled_auto, disabled_remote, closed)Evetpending_test: deneme bekliyor; active: açık; disabled_auto: hatalarla durdu; disabled_remote: alıcı 410 verdi; closed: kapalı."pending_test"
storemetin · null olabilirEvetMarka kimliği (sto_ ve 32 küçük onaltılık karakter)."sto_1234567890abcdef1234567890abcdef"
store_namemetin · null olabilirEvetWebhook adresinin bağlı olduğu markanın görünen adı."Örnek Marka"
urlmetinEvetGenel internete açık, kullanıcı bilgisi içermeyen HTTPS webhook adresi; port 443."https://example.com/webhooks/siparis"
EndpointInput
AlanTürZorunluAçıklamaÖrnek
event_typesliste: metin (en çok 100 öğe)EvetDinlenecek olay türleri; jokerler oluşturma anındaki izinli türlere sabitlenir.
urlmetin (en çok 2000 karakter)EvetGenel internete açık, kullanıcı bilgisi içermeyen HTTPS webhook adresi; port 443."https://example.com/webhooks/siparis"
grantmetin · null olabilirHayırAPI bağlantısı kimliği (grt_ ve 32 küçük onaltılık karakter)."grt_1234567890abcdef1234567890abcdef"
schema_versionsabit 1HayırOlay yükünün şema sürümü.1
storemetin · null olabilirHayırMarka kimliği (sto_ ve 32 küçük onaltılık karakter)."sto_1234567890abcdef1234567890abcdef"
EndpointPatch
AlanTürZorunluAçıklamaÖrnek
event_typesliste: metin (en çok 100 öğe) · null olabilirHayırDinlenecek olay türleri; jokerler oluşturma anındaki izinli türlere sabitlenir.
schema_versionsabit 1 · null olabilirHayırOlay yükünün şema sürümü.1
storemetin · null olabilirHayırMarka kimliği (sto_ ve 32 küçük onaltılık karakter)."sto_1234567890abcdef1234567890abcdef"
urlmetin (en çok 2000 karakter) · null olabilirHayırGenel internete açık, kullanıcı bilgisi içermeyen HTTPS webhook adresi; port 443."https://example.com/webhooks/siparis"
EndpointResult
AlanTürZorunluAçıklamaÖrnek
endpointnesne (Endpoint)EvetWebhook adresinin güncel durumu.
secretmetin · null olabilirHayırYalnız oluşturma/döndürmenin ilk yanıtında bir kez gösterilen whsec_ imza sırrı; Idempotent-Replayed yanıtında alan yoktur. Güvenli ortam değişkeninde saklayın."whsec_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="
Event
AlanTürZorunluAçıklamaÖrnek
actornesne (EventActor)Evetİşlemi yapanın türü; kişi veya ekip üyesi kimliği verilmez.
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
datanesne (EventData)EvetOlayın kişisel veri içermeyen kaynak kimliği ve değişiklik özeti.
idmetinEvetKaynağın dış kimliği; evt_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."evt_1234567890abcdef1234567890abcdef"
livemodetrue/falseEvetGerçek ortamda oluşan olay için true.true
schema_versionsabit 1EvetOlay yükünün şema sürümü.1
storemetin · null olabilirEvetMarka kimliği (sto_ ve 32 küçük onaltılık karakter)."sto_1234567890abcdef1234567890abcdef"
typemetin (seçenekler: job.completed, order.created, order.updated, order.status_changed, collection.recorded, collection.reversed, refund.succeeded, payment.failed, return.requested, return.approved, return.rejected, return.received, return.closed, invoice.issued, invoice.failed, invoice.cancelled, shipment.created, shipment.status_changed, shipment.cod_changed, inventory.level_changed, inventory.low, inventory.document_created, inventory.document_reversed, product.created, product.updated, product.archived, product.restored, variant.created, variant.updated, variant.archived, variant.restored, store_product.linked, store_product.unlinked, store_price.updated, customer.created, customer.updated, customer.archived, customer.restored, customer.anonymized, subscription.created, subscription.renewed, subscription.payment_issue, subscription.paused, subscription.resumed, subscription.cancelled, coupon.created, coupon.updated, coupon.archived, coupon.restored, channel.order_imported, channel.problem, channel.recovered, webhook.test)Evetİşlem veya olay türü."order.created"
EventActor
AlanTürZorunluAçıklamaÖrnek
typemetinEvetİşlemi yapanın türü; user, api veya system gibi; kişi kimliği yoktur."user"
EventChanges
AlanTürZorunluAçıklamaÖrnek
currentnesne (EventState)EvetOlaydan sonraki değişen alanlar; güncel kaydı kaynak ucundan okuyun.
previousnesne (EventState)EvetOlaydan önceki değişen alanlar; tüm kaynağın kopyası değildir.
EventData
AlanTürZorunluAçıklamaÖrnek
changesnesne (EventChanges)EvetDeğişen alanların önceki ve sonraki değerleri.
objectnesne (EventObject)EvetDeğişen kaynağın dış kimliği ve ilişkileri; kişisel veri içermez.
EventItem
AlanTürZorunluAçıklamaÖrnek
productmetinEvetAbonelikteki ürünün prd_ kimliği."prd_1234567890abcdef1234567890abcdef"
variantmetin · null olabilirHayırSeçilen seçeneğin var_ kimliği; seçeneksiz üründe null."var_1234567890abcdef1234567890abcdef"
EventObject
AlanTürZorunluAçıklamaÖrnek
idmetinEvetKaynağın dış kimliği; ord_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."ord_1234567890abcdef1234567890abcdef"
channelmetin · null olabilirHayırSatış kanalının türü: trendyol, hepsiburada, ikas, wix, woocommerce, ticimax veya ideasoft; kanaldan gelen siparişin source değeriyle aynıdır."trendyol"
codemetin · null olabilirHayırKuponun olay anındaki kodu."MERHABA10"
customermetin · null olabilirHayırAboneliğin müşteri kartının cus_ kimliği; misafir aboneliğinde alan yoktur. Ad ve iletişim bilgisi olayda yoktur."cus_1234567890abcdef1234567890abcdef"
itemsliste: nesne (EventItem) · null olabilirHayırAboneliğin olay anındaki ürün satırları (sırayla, en çok 50); adet ve kişiselleştirme metni yoktur.
kindmetin · null olabilirHayırStok belgesinin türü: receipt, count, loss veya transfer."receipt"
locationmetin · null olabilirHayırDepo kimliği (loc_ ve 32 küçük onaltılık karakter)."loc_1234567890abcdef1234567890abcdef"
numbertam sayı · null olabilirHayırSiparişin görünen numarası; kimlik değildir.48273910
ordermetin · null olabilirHayırSipariş kimliği (ord_ ve 32 küçük onaltılık karakter)."ord_1234567890abcdef1234567890abcdef"
productmetin · null olabilirHayırSeçeneğin bağlı olduğu ürünün prd_ kimliği."prd_1234567890abcdef1234567890abcdef"
reversesmetin · null olabilirHayırTers kayıt olayında özgün doc_ belge kimliği."doc_1234567890abcdef1234567890abcdef"
variantmetin · null olabilirHayırSeçenek kimliği (var_ ve 32 küçük onaltılık karakter)."var_1234567890abcdef1234567890abcdef"
EventPage
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Event)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_cursormetinEvetHer yanıtta döner; boş/son sayfada da kaydedin. has_more=false olunca bekleyip bu imleçle yeniden okuyun."SUNUCUDAN_DONEN_IMLEC"
EventState
AlanTürZorunluAçıklamaÖrnek
amountmetin · null olabilirHayırİşlem tutarı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
anonymizedtrue/false · null olabilirHayırKişisel alanlar anonimleştirildiyse true.false
archivedtrue/false · null olabilirHayırArşivdeki veya kapanmış kaynaksa true. archived=true süzgeci bunları da içerir.false
cod_amountmetin · null olabilirHayırKapıda tahsil edilecek sipariş payı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
cod_collectedmetin · null olabilirHayırKapıda tahsil edilmiş tutar; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
cod_releasemetin · null olabilirHayırKargo firmasından aktarılmış tutar; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
cod_statemetin · null olabilirHayırKapıda ödeme tahsilatının kargo firmasından bağımsız ortak durumu; tanınmayan kodda null."collected"
cod_statusmetin · null olabilirHayırKargo firmasının kapıda ödeme tahsilat kodu (ör. BasitKargo’nun COLLECTED kodu); firmadan bağımsız değer cod_state alanındadır."COLLECTED"
compare_pricemetin · null olabilirHayırKarşılaştırma fiyatı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."150.00"
currencymetin · null olabilirHayırÖdeme tutarının ISO 4217 para birimi."TRY"
customer_counttam sayı · null olabilirHayırKuponun tanımlı olduğu müşteri sayısı; 0 herkese açık. Müşteri kimlikleri olayda yoktur.0
discount_typemetin · null olabilirHayırKupon indirimi: percentage yüzde, fixed TRY tutarı; yalnız ücretsiz kargo kuponunda null."percentage"
discount_valuemetin · null olabilirHayırKupon indirim oranı veya TRY tutarı; ondalık metin."10.00"
interval_weekstam sayı · null olabilirHayırAboneliğin teslimat sıklığı, hafta.2
item_counttam sayı · null olabilirHayırİade/değişim kaydındaki ürün satırı sayısı; ürün adedi değildir.2
linkedtrue/false · null olabilirHayırÜrün markaya bağlıysa true.true
methodmetin · null olabilirHayırBaşarısız denemenin ödeme yöntemi."card"
min_ordermetin · null olabilirHayırKupona uygun ürünlerde en az sepet tutarı, TRY; null sınırsız."100.00"
next_datemetin · null olabilirHayırAboneliğin sonraki teslimat günü; markanın takvim günü (YYYY-MM-DD)."2026-11-06"
periodmetin · null olabilirHayırYenileme siparişinin teslimat günü (YYYY-MM-DD); yalnız subscription.renewed olayında."2026-10-23"
pricemetin · null olabilirHayırSatış fiyatı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
problemmetin · null olabilirHayırKanal bağlantısının sorunu: authorization (anahtar veya yetki geçersiz; stok gitmez, sipariş gelmez) veya app_removed (Wix uygulaması kaldırıldı); sorun yoksa null. Kanalın hata metni gönderilmez."authorization"
providermetin · null olabilirHayırKart ödemesinin sağlayıcısı."iyzico"
provider_codemetin · null olabilirHayırGüvenli ret anlamı: declined veya insufficient_funds. Ham sağlayıcı metni ve kart bilgisi yoktur."declined"
quantitymetin · null olabilirHayırMiktar; birimi ilgili ürün/depo alanında verilen ondalık metin."1.000"
refund_amountmetin · null olabilirHayırİade kaynağındaki tutar olgusu, TRY; para ödendiği anlamına gelmez. Ödeme refund.succeeded olayıdır."120.00"
statemetin · null olabilirHayırGönderide kargo firmasından bağımsız ortak durum; status firmanın kodudur. Açılış beklerken, başarısızlıkta ve tanınmayan kodda null."delivered"
statusmetin · null olabilirHayırKaynağın işlem durumu."active"
thresholdmetin · null olabilirHayırDüşük stok uyarısının dışlayıcı eşiği; ürünün stok biriminde ondalık metin. Miktar bu değerin altına indiğinde uyarır."3.000"
totalmetin · null olabilirHayırFaturanın KDV dahil toplamı, TRY cinsinden iki ondalıklı metin."120.00"
valid_frommetin · null olabilirHayırKuponun markanın yerel takvimindeki başlangıç günü (YYYY-MM-DD) veya dakikası (YYYY-MM-DDTHH:MM); null sınırsız."2026-10-16"
valid_untilmetin · null olabilirHayırKuponun markanın yerel takvimindeki bitiş günü veya dakikası; gün ve son dakika dahildir. null sınırsız."2026-12-31T23:59"
EventType

Alanı olmayan değer.

Export
AlanTürZorunluAçıklamaÖrnek
completed_attarih-saat · null olabilirEvetTamamlanma zamanı; RFC 3339 UTC. Hazır değilse null.null
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
error_codemetin · null olabilirEvetHazırlama başarısızsa kod: export_too_large (süzgeçle daraltın), snapshot_timeout (daha küçük dosya isteyin), export_access_changed (güncel izinlerle yeniden başlatın); diğer hatalarda destek alın. Başarıda null.null
filenesne (ExportFile) · null olabilirEvetTamamlanmış dosya bilgisi; hazırlama sürerken null.null
formatmetin (seçenekler: jsonl, csv)Evetjsonl: satır başına JSON nesnesi; csv: her hücresi JSON değeri olan CSV."jsonl"
idmetinEvetKaynağın dış kimliği; exp_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."exp_1234567890abcdef1234567890abcdef"
resourcemetin (seçenekler: orders, customers, products, variants, inventory_levels)EvetDışa aktarılacak kaynak; aynı kaynağın okuma kapsamı da gerekir."orders"
resume_cursormetin · null olabilirEvetDosya tamamen uygulandıktan sonra /events cursor parametresine verilir; types eklenmez. Hazır değilse null.null
row_counttam sayıEvetDosyaya yazılmış nesne sayısı.0
statusmetin (seçenekler: queued, running, completed, failed)Evetqueued: sırada; running: hazırlanıyor; completed: hazır; failed: başarısız."queued"
modesabit "consistent_snapshot"Hayırconsistent_snapshot: bütün kayıtlar aynı anın tutarlı görünümüdür."consistent_snapshot"
ExportFile
AlanTürZorunluAçıklamaÖrnek
bytestam sayıEvetDosyanın bayt cinsinden boyutu.2048
content_typemetinEvetİndirilecek dosyanın içerik türü."application/x-ndjson"
download_pathmetinEvetAPI kökenine eklenecek /v1/files/fil_… yolu; Bearer anahtarı gerekir."/v1/files/fil_1234567890abcdef1234567890abcdef"
expires_attarih-saatEvetDışa aktarmanın created_at zamanından tam 7 gün sonrası; bu anda indirme 410 file_expired döner."2026-10-23T09:00:00Z"
idmetinEvetKaynağın dış kimliği; fil_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."fil_1234567890abcdef1234567890abcdef"
ExternalOrderItem
AlanTürZorunluAçıklamaÖrnek
quantitysayı (en çok 100000) veya metinEvetMiktar; en çok üç ondalık hane. Adetle satılan üründe tam sayı gerekir."2"
unit_pricesayı (en az 0; en çok 10000000) veya metinEvetKanalda kesinleşmiş KDV dahil TRY birim satış fiyatı; zorunludur. Kampanya uygulanmaz."120.00"
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_ dış kimliği; variant veya sku alanından tam biri gerekir."var_1234567890abcdef1234567890abcdef"
ExternalReference
AlanTürZorunluAçıklamaÖrnek
idmetin (en çok 200 karakter)EvetKendi sisteminizdeki sipariş numarası; bu API bağlantısında tekildir."WEB-2026-001"
namespacemetin · null olabilirHayırAd alanı kalıcı grant kimliğidir (grt_). Atlayabilirsiniz; başka ad alanı seçilemez.null
FieldError
AlanTürZorunluAçıklamaÖrnek
codemetinEvetAlan doğrulamasının kararlı kodu."less_than_equal"
detailmetinEvetHatanın Türkçe açıklaması."İstek alanlarını kontrol edin."
fieldmetinEvetHatalı alanın noktayla ayrılmış yolu."query.limit"
History
AlanTürZorunluAçıklamaÖrnek
actor_typemetin · null olabilirEvetİşlemi yapanın türü; kişi kimliği yayımlanmaz."user"
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
previous_statusmetin · null olabilirEvetDeğişiklik öncesindeki durum."pending"
statusmetin · null olabilirEvetKaynağın işlem durumu."active"
typemetinEvetİşlem veya olay türü."order.created"
Identity
AlanTürZorunluAçıklamaÖrnek
api_urlmetinEvetBu ortamın /v1 içeren temel adresi."https://api.siparis.app/v1"
api_versionmetinEvetAPI ana sürümü."v1"
environmentmetinEvetBağlantının ortamı: live veya test."live"
idmetinEvetKaynağın dış kimliği; grt_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."grt_1234567890abcdef1234567890abcdef"
scopesliste: metinEvetBu API bağlantısına açık kapsamlar; yazma kapsamı okuma vermez.
storesliste: nesne (Brand)EvetAnahtarın okuyabildiği etkin markalar.
actor_typemetinHayırAPI anahtarı için api, OAuth kurulumu için app."app"
applicationnesne (ApplicationIdentity) · null olabilirHayırOAuth uygulaması ve kurulumu; API anahtarında boş.null
InventoryLevelsExportFilters
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseHayırtrue arşivdeki ve kapalı kayıtları da içerir; varsayılan false.false
locationmetin · null olabilirHayırDepo dış kimliği (loc_ ve 32 küçük onaltılık karakter)."loc_1234567890abcdef1234567890abcdef"
productmetin · null olabilirHayırÜrün dış kimliği (prd_ ve 32 küçük onaltılık karakter)."prd_1234567890abcdef1234567890abcdef"
updated_aftertarih-saat · null olabilirHayırBaşlangıç dahil; saat dilimli RFC 3339 zamanı."2026-10-16T09:00:00Z"
updated_beforetarih-saat · null olabilirHayırBitiş hariç; saat dilimli RFC 3339 zamanı."2026-10-17T09:00:00Z"
variantmetin · null olabilirHayırSeçenek dış kimliği (var_ ve 32 küçük onaltılık karakter)."var_1234567890abcdef1234567890abcdef"
InventoryLevelsExportInput
AlanTürZorunluAçıklamaÖrnek
formatmetin (seçenekler: jsonl, csv)Evetjsonl: satır başına JSON nesnesi; csv: her hücresi JSON değeri olan CSV."jsonl"
modesabit "consistent_snapshot"Evetconsistent_snapshot: bütün kayıtlar aynı anın tutarlı görünümüdür."consistent_snapshot"
resourcesabit "inventory_levels"EvetDışa aktarılacak kaynak; aynı kaynağın okuma kapsamı gerekir."inventory_levels"
filtersnesne (InventoryLevelsExportFilters)HayırKaynağın liste süzgeçleri; limit, cursor ve include desteklenmez.
Invoice
AlanTürZorunluAçıklamaÖrnek
cancelled_attarih-saat · null olabilirEvetİptal zamanı; RFC 3339 UTC. Değer yoksa null."2026-10-16T09:00:00Z"
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
idmetinEvetKaynağın dış kimliği; inv_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."inv_1234567890abcdef1234567890abcdef"
issued_attarih-saatEvetFatura düzenleme zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
kindmetinEvetFatura türü."e_arsiv"
statusmetinEvetFaturanın düzenlenme/iptal durumu. Değerler: pending, issued, failed, cancelled. Türkçe karşılıkları: https://developer.siparis.app/referans#fatura-durumlari."issued"
tax_totalmetinEvetToplam vergi; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."20.00"
totalmetinEvetToplam tutar; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
buyer_namemetin · null olabilirHayırAlıcı adı; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
buyer_tax_numbermetin · null olabilirHayırAlıcı vergi/kimlik numarası; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
cancellation_statusmetin · null olabilirHayırİptal isteğinin durumu; iptal istenmediyse alan atlanır. Değerler: pending, unknown, failed, succeeded. Türkçe karşılıkları: https://developer.siparis.app/referans#fatura-iptal-durumlari.null
currencysabit "TRY"HayırPara birimi; v1 tutarları Türk lirasıdır."TRY"
error_codemetin · null olabilirHayırKesim veya iptalin sabit hata kodu; sağlayıcının serbest metni yayımlanmaz.null
numbermetin · null olabilirHayırFatura numarası; personal_data:read gerekir.null
InvoiceBuyer
AlanTürZorunluAçıklamaÖrnek
addressmetinEvetFatura adresinin açık adresi."Örnek adres"
citymetinEvetFatura adresinin ili."İstanbul"
corporatetrue/falseEvetŞirket adına faturada true.false
districtmetinEvetFatura adresinin ilçesi."Kadıköy"
emailmetinEvetSipariş verenin e-posta adresi."ornek@example.com"
namemetinEvetPanelin seçtiği alıcı adı veya unvanı."Örnek Alıcı"
phonemetinEvetSipariş verenin telefonu.""
tax_numbermetinEvetVKN/TCKN; bireyselde panelin nihai tüketici numarası."11111111111"
tax_officemetinEvetVergi dairesi; bireyselde boş.""
InvoiceCancelPreview
AlanTürZorunluAçıklamaÖrnek
codemetin · null olabilirEvetPortal gerektiğinde invoice_portal_required; aksi halde null.null
detailmetin · null olabilirEvetPaneldeki sağlayıcı iptal açıklaması.null
invoicemetinEvetİptali incelenen inv_ kimliği."inv_1234567890abcdef1234567890abcdef"
portal_requiredtrue/falseEvetÖnce portalda iptal gerekiyorsa true.false
via_apitrue/falseEvetSağlayıcı API ile iptali destekliyorsa true.true
InvoiceInput

Alanı olmayan değer.

InvoiceLine
AlanTürZorunluAçıklamaÖrnek
discountmetinEvetSatırın KDV hariç indirimi, TRY."0.00"
namemetinEvetPanelin fatura satırı açıklaması."Örnek ürün"
netmetinEvetİndirimden sonra KDV hariç tutar, TRY."100.00"
quantitymetinEvetSatır miktarı; ondalık metin."2"
tax_amountmetinEvetSatırın KDV tutarı, TRY."20.00"
tax_ratemetinEvetKDV oranı, yüzde."20"
totalmetinEvetSatırın KDV dahil tutarı, TRY."120.00"
unitmetinEvetMiktarın birimi."adet"
unit_pricemetinEvetKDV hariç birim fiyat, TRY; dört ondalık haneye kadar."50.0000"
InvoicePreview
AlanTürZorunluAçıklamaÖrnek
kindmetin (seçenekler: e_fatura, e_arsiv) · null olabilirEvetMükellef sorgusu sonucu; sağlayıcı yanıt vermediyse null."e_arsiv"
linesliste: nesne (InvoiceLine)EvetPanelin faturaya yazacağı ürün ve hizmet satırları.
ordermetinEvetÖnizlenen siparişin ord_ kimliği."ord_1234567890abcdef1234567890abcdef"
tax_totalmetinEvetFatura KDV toplamı, TRY."20.00"
totalmetinEvetFatura toplamı, TRY."120.00"
warningsliste: nesne (InvoiceWarning)EvetMükellef sorgusu ve alıcı unvanı uyarıları.
buyernesne (InvoiceBuyer) · null olabilirHayırAlıcı; personal_data:read yoksa alan atlanır.
currencysabit "TRY"HayırTutarların para birimi."TRY"
registered_titlemetin · null olabilirHayırSağlayıcıdaki unvan; personal_data:read yoksa atlanır.null
InvoiceWarning
AlanTürZorunluAçıklamaÖrnek
codemetinEvetUyarının sabit kodu."invoice_kind_unknown"
detailmetinEvetUyarının Türkçe açıklaması."Belge türü sağlayıcı yanıt verdiğinde kesinleşir."
Level
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseEvetArşivdeki veya kapanmış kaynaksa true. archived=true süzgeci bunları da içerir.false
idmetinEvetKaynağın dış kimliği; lvl_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."lvl_1234567890abcdef1234567890abcdef"
locationmetinEvetDepo kimliği (loc_ ve 32 küçük onaltılık karakter)."loc_1234567890abcdef1234567890abcdef"
made_to_ordertrue/falseEvetSipariş üzerine hazırlanırsa true; sayılmayan stoktan önceliklidir.false
productmetinEvetÜrün kimliği (prd_ ve 32 küçük onaltılık karakter)."prd_1234567890abcdef1234567890abcdef"
quantitymetin · null olabilirEvetDepodaki fiziksel bakiye; sipariş verilebilir miktar değildir. Sayılmayan veya sipariş üzerine stokta null."12.000"
quantity_unitmetinEvetBakiyenin birimi; ortak stokta havuz birimidir."adet"
revisiontam sayı (en az 1)EvetBu depo ve seçeneğin stok sürümü; miktar değiştiğinde artar, ürün sürümünden bağımsızdır.1
stock_statemetin (seçenekler: counted, uncounted, made_to_order)Evetcounted: sayılan; uncounted: sayılmayan; made_to_order: sipariş üzerine."counted"
stock_uncountedtrue/falseEvetStok sayılmıyorsa true; stok miktarı null sunulur.false
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
variantmetinEvetSeçenek kimliği (var_ ve 32 küçük onaltılık karakter)."var_1234567890abcdef1234567890abcdef"
Line
AlanTürZorunluAçıklamaÖrnek
discountmetin · null olabilirEvetSatır indirimi; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
idmetinEvetKaynağın dış kimliği; lin_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."lin_1234567890abcdef1234567890abcdef"
namemetinEvetKaydın görünen adı."Örnek Kupa"
productmetin · null olabilirEvetÜrün kimliği (prd_ ve 32 küçük onaltılık karakter)."prd_1234567890abcdef1234567890abcdef"
quantitymetinEvetMiktar; birimi ilgili ürün/depo alanında verilen ondalık metin."1.000"
refunded_quantitymetinEvetİade edilen miktar; birimi ilgili ürün/depo alanında verilen ondalık metin."0.000"
tax_amountmetin · null olabilirEvetVergi tutarı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."20.00"
tax_ratemetin · null olabilirEvetYüzde cinsinden vergi oranı; ondalık metin."20.00"
totalmetinEvetToplam tutar; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
unitmetinEvetÜrünün satış miktarı birimi."adet"
unit_pricemetinEvetSatırın birim satış fiyatı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
variantmetin · null olabilirEvetSeçenek kimliği (var_ ve 32 küçük onaltılık karakter)."var_1234567890abcdef1234567890abcdef"
variant_namemetin · null olabilirEvetSatırdaki seçeneğin sipariş anındaki adı."Mavi"
currencysabit "TRY"HayırPara birimi; v1 tutarları Türk lirasıdır."TRY"
unit_costmetin · null olabilirHayırBirim maliyet; yalnız costs:read ile görünür; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."80.00"
Location
AlanTürZorunluAçıklamaÖrnek
activetrue/falseEvetKayıt etkinse true.true
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
idmetinEvetKaynağın dış kimliği; loc_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."loc_1234567890abcdef1234567890abcdef"
is_defaulttrue/falseEvetVarsayılan seçenek veya depo ise true.true
namemetinEvetKaydın görünen adı."Ana depo"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
MoneyReturned
AlanTürZorunluAçıklamaÖrnek
expected_amountsayı (en az 0; en çok 10000000) veya metinEvetBu iadede kalan, gerçekten geri verilen TRY tutarı; değişirse 409 amount_changed."120.00"
methodmetin (seçenekler: cash, bank, pos) · null olabilirHayırElle ödeme yöntemi: cash nakit, bank havale, pos kart. Boşsa ortak servis belirler."bank"
MoneySummary
AlanTürZorunluAçıklamaÖrnek
carriedmetinEvetBaşka siparişe devreden hak (+), başka siparişten gelen mahsup (−); TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
collect_duemetinEvetHenüz tahsil edilmesi gereken; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
collectedmetinEvetTahsil edilen toplam; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
has_collectiontrue/falseEvetEn az bir tahsilat kaydı varsa true.true
keptmetinEvetTahsilatlardan geri ödemeler çıktıktan sonra kalan; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
legacytrue/falseEvetEski kayıt biçiminden gelen özetse true.false
refund_duemetinEvetHenüz müşteriye dönmesi gereken; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
reservedmetinEvetDevam eden geri ödemeler için ayrılan; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
returnedmetinEvetGeri ödenen toplam; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
testtrue/falseEvetDeneme işlemi ise true; gerçek para hareketiyle karıştırmayın.false
currencysabit "TRY"HayırPara birimi; v1 tutarları Türk lirasıdır."TRY"
Movement
AlanTürZorunluAçıklamaÖrnek
count_reasonmetin · null olabilirEvetSayım farkının nedeni; sayım değilse null.null
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
currencysabit "TRY"EvetPara birimi; v1 tutarları Türk lirasıdır."TRY"
documentmetin · null olabilirEvetStok belgesi kimliği (doc_ ve 32 küçük onaltılık karakter)."doc_1234567890abcdef1234567890abcdef"
idmetinEvetKaynağın dış kimliği; mov_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."mov_1234567890abcdef1234567890abcdef"
locationmetinEvetDepo kimliği (loc_ ve 32 küçük onaltılık karakter)."loc_1234567890abcdef1234567890abcdef"
ordermetin · null olabilirEvetSipariş kimliği (ord_ ve 32 küçük onaltılık karakter)."ord_1234567890abcdef1234567890abcdef"
productmetinEvetÜrün kimliği (prd_ ve 32 küçük onaltılık karakter)."prd_1234567890abcdef1234567890abcdef"
quantity_changemetinEvetStok hareketinin işaretli miktar değişimi; birimi ilgili ürün/depo alanında verilen ondalık metin."-1.000"
reasonmetinEvetİşlemin nedeni."sale"
variantmetinEvetSeçenek kimliği (var_ ve 32 küçük onaltılık karakter)."var_1234567890abcdef1234567890abcdef"
variant_balance_aftermetin · null olabilirEvetHareketten sonraki seçenek toplamı; depo bakiyesi değildir; birimi ilgili ürün/depo alanında verilen ondalık metin."12.000"
notemetin · null olabilirHayırİç not; internal_notes:read gerekir. Kişisel kaynakta personal_data:read da gerekir."Örnek iç not"
unit_costmetin · null olabilirHayırBirim maliyet; yalnız costs:read ile görünür; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."80.00"
Option
AlanTürZorunluAçıklamaÖrnek
namemetinEvetSeçenek özelliğinin adı."Renk"
valuemetinEvetSeçenek özelliğinin değeri."Mavi"
Order
AlanTürZorunluAçıklamaÖrnek
channelmetin · null olabilirEvetSiparişin satış kanalı; api_external kaynağında bildirilen channel_name."whatsapp"
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
customermetin · null olabilirEvetMüşteri kimliği (cus_ ve 32 küçük onaltılık karakter)."cus_1234567890abcdef1234567890abcdef"
delivery_daytarih · null olabilirEvetTeslim günü; YYYY-MM-DD."2026-10-17"
delivery_methodmetin · null olabilirEvetTeslim yöntemi. Değerler: shipping, hand, pickup, digital. Türkçe karşılıkları: https://developer.siparis.app/referans#teslim-yontemleri."shipping"
discount_totalmetin · null olabilirEvetToplam indirim; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
gift_wrap_feemetin · null olabilirEvetHediye paketi ücreti; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
idmetinEvetKaynağın dış kimliği; ord_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."ord_1234567890abcdef1234567890abcdef"
numbermetin · null olabilirEvetSiparişin görünen sekiz haneli numarası; kaynak kimliği değildir."48273910"
payment_feemetin · null olabilirEvetÖdeme yöntemi ücreti; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
payment_methodmetin · null olabilirEvetÖdeme yöntemi. Değerler: cod, bank_transfer, credit_card, split, cash, marketplace. Türkçe karşılıkları: https://developer.siparis.app/referans#odeme-yontemleri."bank_transfer"
payment_statemetin · null olabilirEvetÖdeme durumu; alınan ve iade edilen paradan hesaplanır, sipariş durumundan ayrıdır. Değerler: none, awaiting, partial, paid, refund_due, refunded, test. Türkçe karşılıkları: https://developer.siparis.app/referans#odeme-durumlari."paid"
preorder_fromtarih · null olabilirEvetÖn siparişin başlangıç günü; YYYY-MM-DD.null
shipping_totalmetin · null olabilirEvetToplam kargo ücreti; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
sourcemetin · null olabilirEvetKaydın kaynağı; api: yeni satış, api_external: başka kanalda kesinleşmiş satış, import: eski siteden bilgi amaçlı aktarım. Panel/AI ve bağlı kanal kaynakları da korunur."panel"
statusmetinEvetSiparişin iş akışındaki durumu; ödeme durumu ayrıca payment_state alanındadır. Değerler: pending, payment_pending, confirmed, processing, shipped, delivered, cancelled, refunded. Türkçe karşılıkları: https://developer.siparis.app/referans#siparis-durumlari."confirmed"
storemetinEvetMarka kimliği (sto_ ve 32 küçük onaltılık karakter)."sto_1234567890abcdef1234567890abcdef"
subtotalmetin · null olabilirEvetÜrünlerin ara toplamı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
tax_statusmetin (seçenekler: exempt, standard)Evetstandard: KDV mükellefi; exempt: vergiden muaf."standard"
tax_totalmetin · null olabilirEvetToplam vergi; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."20.00"
totalmetinEvetToplam tutar; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
billing_addressnesne (Address) · null olabilirHayırFatura adresi; personal_data:read yoksa alan atlanır.
currencysabit "TRY"HayırPara birimi; v1 tutarları Türk lirasıdır."TRY"
customer_emailmetin · null olabilirHayırMüşteri e-postası; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
customer_namemetin · null olabilirHayırMüşteri adı; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
customer_notemetin · null olabilirHayırMüşterinin sipariş notu; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
customer_phonemetin · null olabilirHayırMüşteri telefonu; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez.null
invoicenesne (Billing) · null olabilirHayırFatura alıcı bilgileri; personal_data:read yoksa alan atlanır.
linesnesne (Page_Line_) · null olabilirHayırinclude=lines ile ilk 50 sipariş satırı; devamı /orders/{id}/lines ile alınır.
notemetin · null olabilirHayırİç not; internal_notes:read gerekir. Kişisel kaynakta personal_data:read da gerekir."Örnek iç not"
paymentsnesne (Payments) · null olabilirHayırinclude=payments ile ilk 50 tahsilat/iade ve bütün siparişin para özeti; payments:read gerekir.
returnsnesne (Page_Return_) · null olabilirHayırinclude=returns ile ilk 50 iade; returns:read gerekir.
shipmentsnesne (Page_Shipment_) · null olabilirHayırinclude=shipments ile ilk 50 gönderi; shipments:read gerekir.
shipping_addressnesne (Address) · null olabilirHayırTeslimat adresi; personal_data:read yoksa alan atlanır.
OrderAction
AlanTürZorunluAçıklamaÖrnek
expected_statusmetin (en çok 30 karakter) · null olabilirHayırGördüğünüz sipariş durumu; kilit altında farklıysa 409 status_mismatch."confirmed"
reasonmetin (en çok 1000 karakter)Hayırİşlemin gerekçesi; correct-status ve başka kanalda bildirilen satışın iptali için zorunlu."Müşteri teslim aldı."
OrderAddress
AlanTürZorunluAçıklamaÖrnek
address_linemetin (en çok 500 karakter)EvetAçık teslimat adresi."Örnek Sokak No: 1"
citymetin (en çok 100 karakter)EvetAdresin ili."İstanbul"
districtmetin (en çok 100 karakter)EvetAdresin ilçesi."Kadıköy"
full_namemetin (en çok 200 karakter)HayırAlıcının adı; boşsa sipariş verenin adı kullanılır."Örnek Alıcı"
neighborhoodmetin (en çok 100 karakter)HayırKargoda resmî listedeki mahalle veya köy adı gerekir."Caferağa"
neighborhood_areametin (en çok 100 karakter)HayırVarsa bağlı köy, semt veya belde.""
phonemetin (en çok 30 karakter)HayırAlıcının telefonu; kargoda zorunludur. Başka alıcıya müşterinin telefonu taşınmaz."05000000000"
postal_codemetin (en çok 10 karakter) · null olabilirHayırİsteğe bağlı posta kodu."34710"
villagetrue/falseHayırAdres köydeyse true.false
OrderCustomer
AlanTürZorunluAçıklamaÖrnek
namemetin (en çok 200 karakter)EvetMüşterinin adı."Örnek Müşteri"
emailmetin (en çok 200 karakter)HayırMüşterinin e-postası; mevcut müşteri eşleştirmesinde kullanılır."musteri@example.com"
phonemetin (en çok 30 karakter)HayırMüşterinin telefonu; mevcut müşteri eşleştirmesinde kullanılır."05000000000"
OrderItem
AlanTürZorunluAçıklamaÖrnek
quantitysayı (en çok 100000) veya metinEvetMiktar; en çok üç ondalık hane. Adetle satılan üründe tam sayı gerekir."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"
unit_pricesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırİsteğe bağlı TRY birim fiyatı; orders.price eylem izni gerekir. Yoksa markanın kampanya dahil fiyatı kullanılır."120.00"
variantmetin · null olabilirHayırvar_ dış kimliği; variant veya sku alanından tam biri gerekir."var_1234567890abcdef1234567890abcdef"
OrdersExportFilters
AlanTürZorunluAçıklamaÖrnek
created_at_fromtarih-saat · null olabilirHayırBaşlangıç zamanı dahil; saat dilimli RFC 3339 gönderin."2026-10-16T09:00:00Z"
created_at_totarih-saat · null olabilirHayırBitiş zamanı hariç; saat dilimli RFC 3339 gönderin."2026-10-17T09:00:00Z"
customermetin · null olabilirHayırSiparişin bağlı olduğu cus_ müşteri kimliği; yalnız sort=-created_at ile kullanılabilir. Başka markanın müşterisi marka sınırlı anahtara görünmez."cus_1234567890abcdef1234567890abcdef"
numbermetin · null olabilirHayırSiparişin görünen sekiz haneli numarası; kaynak kimliği değildir."48273910"
sortmetin (seçenekler: updated_at, -created_at)Hayırupdated_at: son değişiklikten ileri; -created_at: en yeni sipariş önce. Sıra değişirse yeni sayfalama başlatın."-created_at"
statusmetin (seçenekler: pending, payment_pending, confirmed, processing, shipped, delivered, cancelled, refunded) · null olabilirHayırSipariş durumu eşitlik süzgeci. payment_pending eski değerdir: 19 Ekim 2026'dan beri hiçbir sipariş bu durumda açılmaz, süzgeç boş sonuç verir; ödemesi beklenen sipariş payment_state=awaiting ya da partial taşır."confirmed"
storemetin · null olabilirHayırMarka kimliği (sto_ ve 32 küçük onaltılık karakter)."sto_1234567890abcdef1234567890abcdef"
updated_at_fromtarih-saat · null olabilirHayırBaşlangıç zamanı dahil; saat dilimli RFC 3339 gönderin."2026-10-16T09:00:00Z"
updated_at_totarih-saat · null olabilirHayırBitiş zamanı hariç; saat dilimli RFC 3339 gönderin."2026-10-17T09:00:00Z"
OrdersExportInput
AlanTürZorunluAçıklamaÖrnek
formatmetin (seçenekler: jsonl, csv)Evetjsonl: satır başına JSON nesnesi; csv: her hücresi JSON değeri olan CSV."jsonl"
modesabit "consistent_snapshot"Evetconsistent_snapshot: bütün kayıtlar aynı anın tutarlı görünümüdür."consistent_snapshot"
resourcesabit "orders"EvetDışa aktarılacak kaynak; aynı kaynağın okuma kapsamı gerekir."orders"
filtersnesne (OrdersExportFilters)HayırKaynağın liste süzgeçleri; limit, cursor ve include desteklenmez.
Package
AlanTürZorunluAçıklamaÖrnek
boxesliste: nesne (Box) (en çok 99 öğe)EvetGerçek ölçülmüş koliler; toplam en çok 99 koli.
versionmetin (en çok 32 karakter) · null olabilirHayırFiyat yanıtındaki package_version; verilirse değişen koli bilgisi reddedilir."0123456789abcdef"
Page_Attempt_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Attempt)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
Page_Category_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Category)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
Page_Coupon_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Coupon)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
Page_Customer_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Customer)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
Page_Delivery_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Delivery)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
Page_Endpoint_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Endpoint)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
Page_History_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (History)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
Page_Invoice_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Invoice)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
Page_Level_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Level)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
Page_Line_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Line)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
Page_Location_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Location)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
Page_Movement_
AlanTürZorunluAçıklamaÖrnek
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
Page_Order_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Order)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
Page_ProductBrand_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (ProductBrand)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
Page_Product_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Product)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
Page_Return_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Return)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
Page_Shipment_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Shipment)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
Page_StorePrice_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (StorePrice)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
Page_Store_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Store)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
Page_Variant_
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Variant)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
PatchCoupon
AlanTürZorunluAçıklamaÖrnek
categoriesliste: metin (en çok 100 öğe) · null olabilirHayırcat_ kimlikleri; alt kategoriler dahil. [] bütün ürünlerde geçerli yapar.
codemetin (en çok 40 karakter) · null olabilirHayırKupon kodu; panelin Türkçe harf ve boşluk normalleştirmesi uygulanır."MERHABA10"
discount_typemetin (seçenekler: percentage, fixed) · null olabilirHayırYüzde veya sabit TRY tutarı; null temizler."percentage"
discount_valuesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırYüzde oranı veya TRY tutarı; ondalık metin, null temizler."10.00"
exclude_discountedtrue/false · null olabilirHayırİndirimli/kampanyalı ürünlere uygulanmayacaksa true.false
first_order_onlytrue/false · null olabilirHayırYalnız ilk siparişte geçerliyse true.false
free_shippingtrue/false · null olabilirHayırKargo da ücretsizse true.false
max_usestam sayı (en az 1; en çok 2147483647) · null olabilirHayırToplam kullanım sınırı; null sınırsız.100
max_uses_per_customertam sayı (en az 1; en çok 2147483647) · null olabilirHayırKişi başına kullanım sınırı; null sınırsız.1
min_ordersayı (en az 0; en çok 10000000) veya metin · null olabilirHayırKupona uygun ürünlerin en az TRY tutarı; null kaldırır."100.00"
statusmetin (seçenekler: active, inactive) · null olabilirHayıractive açık, inactive kapalı."active"
valid_frommetin (en çok 35 karakter) · null olabilirHayırPanel gibi markanın yerel günü veya dakikası; YYYY-MM-DD ya da ISO tarih/saat. null sınırı kaldırır."2026-10-16"
valid_untilmetin (en çok 35 karakter) · null olabilirHayırBitiş günü/dakikası dahildir; saat dilimli ISO zaman markanın saatine çevrilir. null sınırsız."2026-12-31T23:59"
PatchCustomer
AlanTürZorunluAçıklamaÖrnek
addressnesne (CustomerAddress) · null olabilirHayırMüşterinin adresi; null adresi kaldırır. personal_data:write gerekir.
emailmetin (en çok 320 karakter) · null olabilirHayırE-posta; null veya boş metin alanı temizler. personal_data:write gerekir."musteri@example.com"
invoicenesne (CustomerInvoice) · null olabilirHayırFatura bilgisi; null kaldırır. personal_data:write gerekir.
marketing_consenttrue/false · null olabilirHayırPazarlama izni: true var, false yok, null bilinmiyor. personal_data:write gerekir.false
namemetin (en çok 500 karakter) · null olabilirHayırYeni müşteri adı; null olamaz. Gönderilmeyen alan korunur. personal_data:write gerekir."Örnek Müşteri Yeni"
notemetin (en çok 10000 karakter) · null olabilirHayırİç not; null veya boş metin kaldırır. internal_notes:write gerekir."Teslimden önce bilgi verin."
phonemetin (en çok 50 karakter) · null olabilirHayırTelefon; null veya boş metin alanı temizler. personal_data:write gerekir."05000000000"
PatchOrder
AlanTürZorunluAçıklamaÖrnek
add_itemsliste: nesne (OrderItem) (en çok 50 öğe) · null olabilirHayırMarka fiyatıyla eklenecek kalemler; burada unit_price desteklenmez.
allow_waitingtrue/falseHayırEklenen kalemin eksik adedi mal gelince gönderilsin.false
customer_notemetin (en çok 2000 karakter) · null olabilirHayırMüşteri notu; boş metin kaldırır, personal_data:write gerekir."Teslimden önce arayın."
delivery_daytarih · null olabilirHayırYeni teslim günü; null günü kaldırır. Gönderilmeyen alan değişmez."2026-10-17"
itemsliste: nesne (ChangeItem) (en çok 100 öğe) · null olabilirHayırYalnız değişen satırlar; panelin kargo/fatura/ödeme ve stok kilitleri geçerlidir.
notemetin (en çok 2000 karakter) · null olabilirHayırİç not; boş metin kaldırır, internal_notes:write gerekir."Paket kontrol edildi."
refund_amountsayı (en az 0; en çok 10000000) veya metin · null olabilirHayırPara dönen düzeltmede gördüğünüz iade tutarı; money_out:write gerekir. Kart iadesi panelin mevcut yoluyla yürür."120.00"
restore_itemsliste: metin (en çok 100 öğe) · null olabilirHayırÇıkarılmış lin_ satırlarını kayıtlı adet/fiyatla geri ekler.
shipping_addressnesne (OrderAddress) · null olabilirHayırYeni teslimat adresi; personal_data:write gerekir. Müşteri kartının adresi değiştirilmez.
PatchProduct
AlanTürZorunluAçıklamaÖrnek
barcodemetin (en çok 100 karakter) · null olabilirHayırBarkod; işletmede canlı seçenekler arasında tekil. null temizler."8690000000001"
brandmetin · null olabilirHayırMevcut brd_ ürün markası; null bağı kaldırır. Satıcının sto_ markasıyla karıştırmayın.null
categoriesliste: metin (en çok 100 öğe) · null olabilirHayırMevcut cat_ kategori kimlikleri; [] bağları kaldırır. Yeni kategori açmaz.
compare_pricesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırÜstü çizili fiyat; null kaldırır. Üründe satış fiyatından yüksek olmalıdır."150.00"
costsayı (en az 0; en çok 10000000) veya metin · null olabilirHayırAlış maliyeti; costs:write gerekir. Panel gibi KDV hariç, muaf işletmede KDV dahil saklanır; null kaldırır."80.00"
descriptionmetin (en çok 50000 karakter) · null olabilirHayırÜrün açıklaması; null kaldırır."Seramik kupa, 300 ml."
imagesliste: metin (en çok 2000 karakter) (en çok 12 öğe) · null olabilirHayırEn çok 12 http/https görsel URL’si; [] galeriyi boşaltır. Panelin güvenli kopyalama kuyruğu kullanılır.
made_to_ordertrue/false · null olabilirHayırSipariş üzerine hazırlanırsa true; mevcut stok korunur.false
namemetin (en çok 500 karakter) · null olabilirHayırÜrün adı; gönderilmezse korunur, null olamaz."Seramik Kupa"
pricesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırTRY satış fiyatı; ondalık metin. null ürünün fiyatını kaldırır, seçenekte ürün fiyatına döner."120.00"
short_descriptionmetin (en çok 1000 karakter) · null olabilirHayırKısa açıklama; null kaldırır."Seramik kupa"
skumetin (en çok 255 karakter) · null olabilirHayırStok kodu; işletmede canlı seçenekler arasında tekil. null temizler."KUPA-MAVI"
statusmetin (seçenekler: active, draft, inactive) · null olabilirHayırSatış durumu; arşiv için ayrı eylemi kullanın. Fiyatsız ürün satışa açılamaz."active"
tax_ratesayı (en az 0; en çok 100) veya metin · null olabilirHayırYüzde KDV oranı; panelin vergi sınıfı doğrulaması kullanılır."20"
unitmetin (en çok 20 karakter) · null olabilirHayırSatış birimi; panelin miktar doğrulaması kullanılır."adet"
weightsayı (en az 0; en çok 100000) veya metin · null olabilirHayırKilogram cinsinden ağırlık; null kaldırır."0.350"
PatchVariant
AlanTürZorunluAçıklamaÖrnek
barcodemetin (en çok 100 karakter) · null olabilirHayırBarkod; işletmede canlı seçenekler arasında tekil. null temizler."8690000000001"
compare_pricesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırÜstü çizili fiyat; null kaldırır. Üründe satış fiyatından yüksek olmalıdır."150.00"
costsayı (en az 0; en çok 10000000) veya metin · null olabilirHayırAlış maliyeti; costs:write gerekir. Panel gibi KDV hariç, muaf işletmede KDV dahil saklanır; null kaldırır."80.00"
imagesliste: metin (en çok 2000 karakter) (en çok 12 öğe) · null olabilirHayırEn çok 12 http/https görsel URL’si; [] galeriyi boşaltır. Panelin güvenli kopyalama kuyruğu kullanılır.
made_to_ordertrue/false · null olabilirHayırSipariş üzerine hazırlanırsa true; mevcut stok korunur.false
namemetin (en çok 500 karakter) · null olabilirHayırSeçeneğin görünen adı; gönderilmezse korunur."Mavi"
optionsliste: nesne (CatalogOption) (en çok 20 öğe) · null olabilirHayırSeçeneğin ad/değer çiftleri; gönderilmezse korunur.
pricesayı (en az 0; en çok 10000000) veya metin · null olabilirHayırTRY satış fiyatı; ondalık metin. null ürünün fiyatını kaldırır, seçenekte ürün fiyatına döner."120.00"
price_rulenesne (PriceRule) · null olabilirHayırÜrün fiyatından TL veya yüzde farkı; null ürünle aynı fiyat demektir.
skumetin (en çok 255 karakter) · null olabilirHayırStok kodu; işletmede canlı seçenekler arasında tekil. null temizler."KUPA-MAVI"
weightsayı (en az 0; en çok 100000) veya metin · null olabilirHayırKilogram cinsinden ağırlık; null kaldırır."0.350"
Payment
AlanTürZorunluAçıklamaÖrnek
amountmetinEvetİşlem tutarı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
channelmetinEvetSatış veya tahsilat kanalı."bank"
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
idmetinEvetKaynağın dış kimliği; col_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."col_1234567890abcdef1234567890abcdef"
kindmetinEvetTahsilat veya iade işlem türü."payment"
settled_attarih-saat · null olabilirEvetKesinleşme zamanı; RFC 3339 UTC. Değer yoksa null."2026-10-16T09:00:00Z"
statusmetinEvetTahsilat/geri ödeme durumu."succeeded"
testtrue/falseEvetDeneme işlemi ise true; gerçek para hareketiyle karıştırmayın.false
typemetin (seçenekler: collection, refund)Evetcollection: tahsilat; refund: geri ödeme."collection"
currencysabit "TRY"HayırPara birimi; v1 tutarları Türk lirasıdır."TRY"
PaymentPart
AlanTürZorunluAçıklamaÖrnek
amountsayı (en az 0; en çok 10000000) veya metinEvetGerçekten alınan tutar, TRY; ondalık metin."120.00"
methodmetin (seçenekler: cash, pos, bank)Evetcash: nakit; pos: elle alınan kart; bank: havale."cash"
Payments
AlanTürZorunluAçıklamaÖrnek
dataliste: nesne (Payment)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
summarynesne (MoneySummary)EvetSiparişin bütün tahsilat ve iadelerinden hesaplanan para özeti; yalnız bu sayfanın toplamı değildir.
PreviewItem
AlanTürZorunluAçıklamaÖrnek
itemmetinEvetİade edilecek lin_ kalemi."lin_1234567890abcdef1234567890abcdef"
quantitymetinEvetİade miktarı; kalemin biriminde ondalık metin."1.000"
unitmetinEvetMiktarın birimi."adet"
PriceRule
AlanTürZorunluAçıklamaÖrnek
kindmetin (seçenekler: tl, percent)EvetÜrün fiyatına eklenecek farkın birimi."tl"
valuesayı (en az -10000000; en çok 10000000) veya metinEvetFiyat farkı; negatif değer indirimdir. Son fiyat ortak fiyat kuralıyla doğrulanır."20.00"
ProblemDetail
AlanTürZorunluAçıklamaÖrnek
codemetinEvetProgramatik karar için kararlı hata kodu; metni ayrıştırmayın."validation_error"
detailmetinEvetHatanın Türkçe açıklaması."İstek alanlarını kontrol edin."
errorsliste: nesne (FieldError)EvetAlan düzeyindeki doğrulama sorunları; genel hatada boş liste.
request_idmetinEvetDestek için X-Request-ID ile aynı istek takip kimliği."req_ornek_20261016"
statustam sayı (en az 400; en çok 599)EvetHTTP yanıt durum kodu.422
titlemetinEvetHTTP durumunun kısa standart adı."Unprocessable Entity"
typemetinEvetKararlı hata türü URI değeri."urn:siparis:problem:validation_error"
current_amountmetin · null olabilirHayıramount_changed hatasında güncel TRY iade tutarı."120.00"
current_quantitymetin · null olabilirHayırYalnız stock_changed hatasında kilit altında okunan güncel depo miktarı; sayılmayan stokta null."9.000"
existing_customermetin · null olabilirHayırYalnız customer_exists hatasında eşleşen mevcut cus_ müşteri kimliği."cus_1234567890abcdef1234567890abcdef"
existing_ordermetin · null olabilirHayırYalnız duplicate_external_reference hatasında daha önce açılan ord_ siparişi."ord_1234567890abcdef1234567890abcdef"
existing_productmetin · null olabilirHayırcode_taken veya external_reference_conflict hatasında görünür mevcut prd_ kaydı."prd_1234567890abcdef1234567890abcdef"
existing_variantmetin · null olabilirHayırcode_taken veya external_reference_conflict hatasında görünür mevcut var_ kaydı."var_1234567890abcdef1234567890abcdef"
refund_amountmetin · null olabilirHayırYalnız refund_confirm hatasında teyit edilmesi gereken TRY iade tutarı."100.00"
Product
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseEvetArşivdeki veya kapanmış kaynaksa true. archived=true süzgeci bunları da içerir.false
brandmetin · null olabilirEvetÜrün markası kimliği (brd_ ve 32 küçük onaltılık karakter)."brd_1234567890abcdef1234567890abcdef"
codemetin · null olabilirEvetÜrün kodu."KUPA-001"
compare_pricemetin · null olabilirEvetKarşılaştırma fiyatı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."150.00"
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
currencysabit "TRY"EvetPara birimi; v1 tutarları Türk lirasıdır."TRY"
descriptionmetin · null olabilirEvetKaynağın açıklama metni."Seramik kupa, 300 ml."
idmetinEvetKaynağın dış kimliği; prd_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."prd_1234567890abcdef1234567890abcdef"
imagesliste: metinEvetÜrün görsellerinin sıralı HTTPS adresleri.
kindmetinEvetÜrün türü; ör. standard: tek ürün, bundle: paket."standard"
made_to_ordertrue/falseEvetSipariş üzerine hazırlanırsa true; sayılmayan stoktan önceliklidir.false
maximum_quantitymetin · null olabilirEvetEn çok sipariş miktarı; birimi ilgili ürün/depo alanında verilen ondalık metin."100.000"
minimum_quantitymetin · null olabilirEvetEn az sipariş miktarı; birimi ilgili ürün/depo alanında verilen ondalık metin."1.000"
namemetinEvetKaydın görünen adı."Seramik Kupa"
pool_unitmetin · null olabilirEvetOrtak stok havuzunun birimi."adet"
preparationmetin · null olabilirEvetSipariş üzerine hazırlama süresinin açıklaması."3 iş günü"
pricemetin · null olabilirEvetSatış fiyatı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
quantity_stepmetin · null olabilirEvetSipariş miktarının artış adımı; birimi ilgili ürün/depo alanında verilen ondalık metin."1.000"
short_descriptionmetin · null olabilirEvetÜrünün kısa açıklaması."Seramik kupa"
slugmetin · null olabilirEvetAdreslerde kullanılan kısa ad."ornek-kupa"
statusmetinEvetKaynağın işlem durumu."active"
tax_ratemetin · null olabilirEvetYüzde cinsinden vergi oranı; ondalık metin."20.00"
tax_statusmetin (seçenekler: standard, exempt)Evetstandard: KDV mükellefi; exempt: vergiden muaf."standard"
unitmetinEvetÜrünün satış miktarı birimi."adet"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
categoriesliste: nesne (Category) · null olabilirHayırinclude=categories ile eklenen görünür kategoriler.
costmetin · null olabilirHayırMaliyet; yalnız costs:read ile görünür; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."80.00"
store_pricesliste: nesne (StorePrice) · null olabilirHayırinclude=store_prices ile eklenen kayıtlı marka fiyatları; kampanya fiyatı değildir.
variantsliste: nesne (Variant) · null olabilirHayırinclude=variants ile eklenen seçenekler.
ProductBrand
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseEvetArşivdeki veya kapanmış kaynaksa true. archived=true süzgeci bunları da içerir.false
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
idmetinEvetKaynağın dış kimliği; brd_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."brd_1234567890abcdef1234567890abcdef"
logometin · null olabilirEvetÜrün markasının logo adresi."https://example.com/logo.png"
namemetinEvetKaydın görünen adı."Örnek Üretici"
revisiontam sayıEvetKaydın revizyonu; If-Match için ETag ile birlikte kullanılır.1
slugmetin · null olabilirEvetAdreslerde kullanılan kısa ad."ornek-kupa"
sort_ordertam sayıEvetPanel ve vitrindeki sırası; küçük değer önce gelir.0
statusmetinEvetKaynağın işlem durumu."active"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
ProductsExportFilters
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseHayırtrue arşivdeki ve kapalı kayıtları da içerir; varsayılan false.false
statusmetin (seçenekler: active, draft, inactive) · null olabilirHayırDurum eşitlik süzgeci; desteklenen değerler şemada listelenir."active"
storemetin · null olabilirHayırMarka dış kimliği (sto_ ve 32 küçük onaltılık karakter)."sto_1234567890abcdef1234567890abcdef"
updated_aftertarih-saat · null olabilirHayırBaşlangıç dahil; saat dilimli RFC 3339 zamanı."2026-10-16T09:00:00Z"
updated_beforetarih-saat · null olabilirHayırBitiş hariç; saat dilimli RFC 3339 zamanı."2026-10-17T09:00:00Z"
ProductsExportInput
AlanTürZorunluAçıklamaÖrnek
formatmetin (seçenekler: jsonl, csv)Evetjsonl: satır başına JSON nesnesi; csv: her hücresi JSON değeri olan CSV."jsonl"
modesabit "consistent_snapshot"Evetconsistent_snapshot: bütün kayıtlar aynı anın tutarlı görünümüdür."consistent_snapshot"
resourcesabit "products"EvetDışa aktarılacak kaynak; aynı kaynağın okuma kapsamı gerekir."products"
filtersnesne (ProductsExportFilters)HayırKaynağın liste süzgeçleri; limit, cursor ve include desteklenmez.
QuoteCarrier
AlanTürZorunluAçıklamaÖrnek
availabletrue/falseEvetÜcret, adres ve bakiye yönünden gönderim uygunsa true; açılışta yeniden denetlenir.true
cod_feemetin · null olabilirEvetÜcrete dahil kapıda tahsilat bedeli, TRY; bilinmiyorsa null."29.90"
codemetinEvetGönderi açarken carrier alanına gönderilecek firma kodu."YURTICI"
detailmetin · null olabilirEvetEngelin Türkçe açıklaması; yoksa null.null
feemetin · null olabilirEvetBu fiziksel gönderinin TRY ücreti; bilinen kapıda tahsilat bedeli dahil. null ise açılamaz."124.80"
namemetinEvetKargo firmasının adı."Yurtiçi Kargo"
notemetin · null olabilirEvetVarsa kapıda ödeme bedeli uyarısı.null
problem_codemetin · null olabilirEvetGönderim engelinin kararlı kodu; yoksa null.null
QuoteInput
AlanTürZorunluAçıklamaÖrnek
merge_ordersliste: metin (en çok 99 öğe)HayırAynı marka, alıcı, adres ve depodaki diğer ord_ siparişleri; birleştirme açık seçimdir.
packagenesne (Package) · null olabilirHayırYalnız bu sorgu için ölçüler; sorgu siparişi değiştirmez. Açarken aynı ölçüleri gönderin.
ReadyOrder
AlanTürZorunluAçıklamaÖrnek
notifiedsabit trueEvetMüşteriye hazır olduğu bildirildiyse true; bu uç bildirim göndermez.true
expected_statusmetin (en çok 30 karakter) · null olabilirHayırGördüğünüz sipariş durumu; kilit altında farklıysa 409 status_mismatch."confirmed"
reasonmetin (en çok 1000 karakter)Hayırİşlemin gerekçesi; correct-status ve başka kanalda bildirilen satışın iptali için zorunlu."Müşteri teslim aldı."
ReceiptLine
AlanTürZorunluAçıklamaÖrnek
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"
unit_pricesayı (en az 0; en çok 999999999) veya metin · null olabilirHayırTRY birim alış fiyatı; costs:write gerekir. KDV dahil/hariç seçimi belge üzerindedir; ürünün KDV oranı kullanılır."120.00"
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"
ReceiveOrderPayment
AlanTürZorunluAçıklamaÖrnek
expected_duesayı (en az 0; en çok 10000000) veya metinEvetİşlemden önce gördüğünüz kalan tutar; değişmişse işlem yapılmaz."120.00"
partsliste: nesne (PaymentPart) (en çok 20 öğe)EvetAlınan gerçek ödemeler; panelin aynı tahsilat servisine yazılır.
expected_statusmetin (en çok 30 karakter) · null olabilirHayırGördüğünüz sipariş durumu; kilit altında farklıysa 409 status_mismatch."confirmed"
reasonmetin (en çok 1000 karakter)Hayırİşlemin gerekçesi; correct-status ve başka kanalda bildirilen satışın iptali için zorunlu."Müşteri teslim aldı."
ReceiveStock
AlanTürZorunluAçıklamaÖrnek
linesliste: nesne (ReceiptLine) (en çok 500 öğe)EvetGelen seçenekler, miktarları ve isteğe bağlı alış fiyatları.
locationmetinEvetİşlemin loc_ depo kimliği; /locations listesinden seçin."loc_1234567890abcdef1234567890abcdef"
external_referencenesne (StockReference) · null olabilirHayırDış belge numarasını grant ad alanında tekilleştirir; çakışma 409 external_reference_conflict.
invoice_datetarih · null olabilirHayırFatura tarihi; gelecekte olamaz, numara varsa ve tarih yoksa markanın bugünü. costs:write gerekir."2026-10-16"
invoice_numbermetin (en çok 50 karakter) · null olabilirHayırTedarikçi fatura numarası; costs:write gerekir."TEST2026000000001"
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"
suppliermetin · null olabilirHayırMevcut sup_ tedarikçi kimliği; costs:write gerekir. Atlanırsa kendi stoğunuzdur; yeni tedarikçi panelden açılır."sup_1234567890abcdef1234567890abcdef"
vat_includedtrue/false · null olabilirHayırAlış fiyatı KDV dahilse true; costs:write gerekir. Atlanırsa işletmenin panel varsayılanı kullanılır.false
RefundInput
AlanTürZorunluAçıklamaÖrnek
amountsayı (en az 0; en çok 10000000) veya metin · null olabilirHayırİsteğe bağlı TRY tutarı; boşsa panelin önerisi. Kalan tahsilatı aşamaz."120.00"
itemsliste: nesne (ReturnItem) (en çok 200 öğe)Hayırİade kalemleri; boşsa yalnız para iadesidir ve amount zorunludur.
money_returnedtrue/falseHayırParayı gerçekten elle geri verdiyseniz true. Çevrimiçi kartta false bırakın; sağlayıcı sonucu beklenir.false
notify_customertrue/falseHayırİade e-postasını müşteriye gönder.true
reasonmetin (en çok 200 karakter)Hayırİade nedeni; kişisel bilgi yazmayın."Müşteri ürünü iade etti"
received_conditionmetin (seçenekler: sound, damaged) · null olabilirHayırFiziksel teslim onayı. Fire için damaged ve restock=false birlikte gerekir."sound"
refund_distributionnesne (Distribution-Input) · null olabilirHayırDeğişim/ayrılan siparişte önizlemenin kart ve elle ödeme dağılımı; oluştururken aynen gönderin.
refund_methodmetin (seçenekler: cash, pos, iban) · null olabilirHayırPanelin izin verdiği elle iade yolu; çevrimiçi karta iade otomatik belirlenir.null
refund_partsliste: nesne (RefundPart) (en çok 20 öğe) · null olabilirHayırElle geri verilen parçalar; toplam iade tutarına eşit, money_returned=true olmalı.null
restocktrue/false · null olabilirHayırStoğa geri ekleme seçimi. Boşsa panel/AI varsayılanı: iade edilemez veya hasarlı ürün eklenmez. false tek başına fire yazmaz.null
RefundPart
AlanTürZorunluAçıklamaÖrnek
amountsayı (en az 0; en çok 10000000) veya metinEvetGerçekten geri verilen tutar, TRY; ondalık metin."120.00"
methodmetin (seçenekler: cash, pos, bank)Evetcash: nakit; pos: POS cihazından kart iadesi; bank: havale."cash"
RefundPreview
AlanTürZorunluAçıklamaÖrnek
amountmetinEvetİade edilecek TRY tutarı; expected_amount olarak gönderin."120.00"
completestrue/falseEvetBu işlem siparişi tam iade durumuna geçirecekse true.true
itemsliste: nesne (RefundPreviewItem)EvetDoğrulanmış iade kalemleri ve uygulanacak stok seçimi.
ordermetinEvetİadesi önizlenen ord_ siparişi."ord_1234567890abcdef1234567890abcdef"
refund_distributionnesne (Distribution-Output) · null olabilirEvetDeğişim/ayrılan siparişte onaylanması gereken kart ve elle ödeme tutarları.
refund_methodmetin · null olabilirEvetParanın yolu: card, cash, iban, pos veya split; belirlenmemişse null."iban"
remainingmetinEvetİade edilebilecek kalan TRY tutarı."120.00"
shipping_includedtrue/falseEvetPanel hesabı kalan kargo bedelini içeriyorsa true.true
suggested_amountmetinEvetPanelin önerdiği TRY tutarı."120.00"
warningsliste: metinEvetPanelin kart bekleme ve stoğa geri almama uyarıları.
currencysabit "TRY"HayırTutarların para birimi."TRY"
RefundPreviewItem
AlanTürZorunluAçıklamaÖrnek
itemmetinEvetİade edilecek lin_ kalemi."lin_1234567890abcdef1234567890abcdef"
quantitymetinEvetİade miktarı; kalemin biriminde ondalık metin."1.000"
restocktrue/falseEvetBu kalem iade edildiğinde satılabilir stoğa geri eklenecekse true.true
unitmetinEvetMiktarın birimi."adet"
RefundResult
AlanTürZorunluAçıklamaÖrnek
amountmetinEvetİadenin TRY tutarı; tamamı ödenmiş anlamına gelmez."120.00"
card_statusmetin (seçenekler: pending, blocked, unknown, failed) · null olabilirEvetKart iadesinin bekleyen/belirsiz/hatalı durumu; sorun yoksa null."pending"
idmetinEvetİade işleminin ret_ kimliği; ödeme hareketinin rfd_ kimliğinden ayrıdır."ret_1234567890abcdef1234567890abcdef"
itemsliste: nesne (PreviewItem)Evetİade kalemleri; yalnız para iadesinde boş.
money_returnedtrue/falseEvetBu iadenin parası geri verilmişse true.false
ordermetinEvetÜrünlerin ait olduğu ord_ siparişi."ord_1234567890abcdef1234567890abcdef"
remaining_amountmetinEvetBu iadenin henüz geri verilmemiş TRY tutarı; kart bekliyorsa elle ödeme yapmayın."120.00"
restocktrue/falseEvetBu iadede stoğa geri ekleme seçilmişse true.true
currencysabit "TRY"Hayırİadenin para birimi."TRY"
paymentsnesne (Payments) · null olabilirHayırÖdeme listesi ve güncel para özeti; yalnız payments:read ile görünür. Değişimden devreden bedel ortak hesaba dahildir.
Replay
AlanTürZorunluAçıklamaÖrnek
eventmetinEvetOlay kimliği (evt_ ve 32 küçük onaltılık karakter)."evt_1234567890abcdef1234567890abcdef"
Return
AlanTürZorunluAçıklamaÖrnek
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
idmetinEvetKaynağın dış kimliği; ret_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."ret_1234567890abcdef1234567890abcdef"
kindmetinEvetİade veya değişim türü. Değerler: return, exchange, money. Türkçe karşılıkları: https://developer.siparis.app/referans#iade-turleri."return"
refund_amountmetin · null olabilirEvetİade tutarı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
requested_attarih-saatEvetTalep zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
sourcemetinEvetKaydın oluşturulduğu kanal veya uygulama."panel"
statusmetinEvetİade/değişim talebinin durumu. Değerler: requested, approved, declined, code_sent, arrived, refund_pending, refunded, exchanged, closed, exchange_cancelled. Türkçe karşılıkları: https://developer.siparis.app/referans#iade-durumlari."requested"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
currencysabit "TRY"HayırPara birimi; v1 tutarları Türk lirasıdır."TRY"
reasonmetin · null olabilirHayırİşlemin nedeni."sale"
ReturnDetail
AlanTürZorunluAçıklamaÖrnek
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
idmetinEvetKaynağın dış kimliği; ret_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."ret_1234567890abcdef1234567890abcdef"
itemsliste: nesne (PreviewItem)EvetTalep edilen kalemler ve miktarlar.
kindmetinEvetİade veya değişim türü."return"
ordermetinEvetTalebin ord_ siparişi."ord_1234567890abcdef1234567890abcdef"
refund_amountmetin · null olabilirEvetİade tutarı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
requested_attarih-saatEvetTalep zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
sourcemetinEvetKaydın oluşturulduğu kanal veya uygulama."panel"
statusmetinEvetİade/değişim talebinin durumu."requested"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
currencysabit "TRY"HayırPara birimi; v1 tutarları Türk lirasıdır."TRY"
decision_notemetin · null olabilirHayırKarar notu; personal_data:read gerekir.null
notemetin · null olabilirHayırMüşteri notu; personal_data:read gerekir.null
reasonmetin · null olabilirHayırİşlemin nedeni."sale"
wantmetin · null olabilirHayırDeğişimde istenen; personal_data:read gerekir.null
ReturnItem
AlanTürZorunluAçıklamaÖrnek
itemmetinEvetSipariş kaleminin lin_ dış kimliği."lin_1234567890abcdef1234567890abcdef"
quantitysayı (en çok 100000) veya metinEvetİade miktarı; kalemin biriminde, en çok üç ondalık hane."1"
ReverseStock
AlanTürZorunluAçıklamaÖrnek
storemetin · null olabilirHayırsto_ marka kimliği; API belgesinde özgün marka kullanılır, diğer belgelerde çok marka varsa seçin.null
Rotation
AlanTürZorunluAçıklamaÖrnek
overlap_hourstam sayı (en az 1; en çok 168)HayırEski webhook sırrının da geçerli kalacağı saat sayısı; varsayılan 24, 1–168 saat.24
Shipment
AlanTürZorunluAçıklamaÖrnek
carriermetin · null olabilirEvetKargo firmasının kodu."YURTICI"
cod_amountmetin · null olabilirEvetKapıda tahsil edilecek tutar; sipariş alt kaynağında siparişin payı, tek gönderi okumasında fiziksel toplam; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
collected_amountmetin · null olabilirEvetKargoda tahsil edilen tutar; sipariş alt kaynağında siparişin payı, tek gönderi okumasında fiziksel toplam; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
combinedtrue/falseEvetGönderi birden fazla sipariş içeriyorsa true; sipariş alt kaynağı payı, tek gönderi okuması toplamı verir.false
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
delivered_attarih-saat · null olabilirEvetTeslim zamanı; RFC 3339 UTC. Değer yoksa null."2026-10-16T09:00:00Z"
idmetinEvetKaynağın dış kimliği; shp_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."shp_1234567890abcdef1234567890abcdef"
shipping_feemetin · null olabilirEvetMüşteriden alınan kargo ücreti; sipariş alt kaynağında siparişin payı, tek gönderi okumasında fiziksel toplam; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
statusmetin · null olabilirEvetKargo firmasının gönderi durumu; pending açılış sonucu bekleniyor, failed gönderi açılamadı. Firmadan bağımsız okumak için state. Değerler: pending, failed, created, NEW, READY_TO_SHIP, SHIPPED, OUT_FOR_DELIVERY, DELIVERED, COMPLETED, NEEDS_SUPPORT, DELAYED, RETURNING, RETURNED, LOST, DELETED, cancelled. Türkçe karşılıkları: https://developer.siparis.app/referans#gonderi-durumlari."created"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
barcodemetin · null olabilirHayırGönderi barkodu; personal_data:read gerekir.null
cancellation_statusmetin · null olabilirHayırİptal isteğinin pending, unknown, succeeded veya failed durumu; kargonun durumu kesin sonuçtan sonra değişir."pending"
cod_costmetin · null olabilirHayırKapıda ödeme maliyeti; costs:read gerekir; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."5.00"
cod_statemetin · null olabilirHayırKapıda ödeme tahsilatının kargo firmasından bağımsız ortak durumu; kapıda ödemesiz gönderide ve tanınmayan kodda null. Değerler: pending, collected, settled, settled_direct, not_collected. Türkçe karşılıkları: https://developer.siparis.app/referans#kapida-odeme-durumlari."collected"
cod_statusmetin · null olabilirHayırKapıda ödeme tahsilat durumu; cod_state ile aynı değer (önceki ad)."collected"
currencysabit "TRY"HayırPara birimi; v1 tutarları Türk lirasıdır."TRY"
error_codemetin · null olabilirHayırGönderi açılamadıysa kararlı hata kodu; yeni gönderi öncesi hatayı giderin.null
return_costmetin · null olabilirHayırDönüş kargo maliyeti; costs:read gerekir; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."0.00"
shipping_costmetin · null olabilirHayırKargo maliyeti; costs:read gerekir; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."40.00"
statemetin · null olabilirHayırGönderinin kargo firmasından bağımsız ortak durumu; açılış beklerken (status pending), açılamadıysa (failed) ve firmanın tanınmayan kodunda null. Değerler: draft, ready, in_transit, delivered, returning, returned, lost, cancelled. Türkçe karşılıkları: https://developer.siparis.app/referans#gonderi-ortak-durumlari."ready"
tracking_codemetin · null olabilirHayırKargo takip kodu; personal_data:read gerekir."TEST-TAKIP-001"
ShipmentQuote
AlanTürZorunluAçıklamaÖrnek
boxesliste: nesne (Box)EvetHesapta kullanılan koliler; ağırlık kg, ölçüler cm.
carriersliste: nesne (QuoteCarrier)EvetPanelin açık firma seçenekleri ve ücretleri.
cod_amountmetin · null olabilirEvetKurye tarafından tahsil edilecek TRY tutarı; kapora düşülür, ortak gönderide üyelerin kalanları toplanır."120.00"
cod_typemetin (seçenekler: cash, card) · null olabilirEvetKapıda nakit veya kart; kapıda ödeme yoksa null."cash"
default_carriermetin · null olabilirEvetPanelin varsayılan firma kodu."YURTICI"
ordermetinEvetFiyat sorulan ord_ siparişi."ord_1234567890abcdef1234567890abcdef"
package_versionmetinEvetKalıcı koli düzeltmesinde kullanılabilecek görülen sürüm."0123456789abcdef"
package_warningmetin · null olabilirEvetÖlçüsü eksik ürünler için panelin uyarısı.null
payment_warningmetin · null olabilirEvetKapıda ödeme dışındaki kalan ödeme uyarısı.null
currencysabit "TRY"HayırÜcretlerin para birimi."TRY"
StockLine
AlanTürZorunluAçıklamaÖrnek
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"
StockReference
AlanTürZorunluAçıklamaÖrnek
idmetin (en çok 200 karakter)EvetKendi sisteminizdeki belge numarası; bu API bağlantısında tekildir."MAL-2026-001"
namespacemetin · null olabilirHayırAd alanı kalıcı grt_ bağlantı kimliğidir; atlanabilir, başka ad alanı seçilemez.null
Store
AlanTürZorunluAçıklamaÖrnek
activetrue/falseEvetKayıt etkinse true.true
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
idmetinEvetKaynağın dış kimliği; sto_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."sto_1234567890abcdef1234567890abcdef"
namemetinEvetKaydın görünen adı."Örnek Marka"
slugmetinEvetAdreslerde kullanılan kısa ad."ornek-kupa"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
StorePrice
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseEvetArşivdeki veya kapanmış kaynaksa true. archived=true süzgeci bunları da içerir.false
compare_pricemetin · null olabilirEvetKarşılaştırma fiyatı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."150.00"
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
currencysabit "TRY"EvetPara birimi; v1 tutarları Türk lirasıdır."TRY"
pricemetin · null olabilirEvetSatış fiyatı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
productmetinEvetÜrün kimliği (prd_ ve 32 küçük onaltılık karakter)."prd_1234567890abcdef1234567890abcdef"
storemetinEvetMarka kimliği (sto_ ve 32 küçük onaltılık karakter)."sto_1234567890abcdef1234567890abcdef"
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
variantmetin · null olabilirEvetSeçenek kimliği (var_ ve 32 küçük onaltılık karakter)."var_1234567890abcdef1234567890abcdef"
StorePriceInput
AlanTürZorunluAçıklamaÖrnek
compare_pricesayı (en az 0; en çok 10000000) veya metin · null olabilirEvetMarkanın üstü çizili fiyatı; null katalog değerini devralır. İki fiyat da null ise marka fiyat satırı kalkar."140.00"
pricesayı (en az 0; en çok 10000000) veya metin · null olabilirEvetMarkanın TRY satış fiyatı; null katalog fiyatını devralır."110.00"
variantmetin · null olabilirHayırİsteğe bağlı var_ kimliği; null veya atlanırsa ürünün marka fiyatı. Tekrar anahtarının gövde özetine dahildir.null
Supplier
AlanTürZorunluAçıklamaÖrnek
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"
TaxonomyAction

Arşiv eylemlerine boş JSON gönderilir.

TransferStock
AlanTürZorunluAçıklamaÖrnek
linesliste: nesne (StockLine) (en çok 500 öğe)EvetTaşınacak seçenekler ve pozitif miktarları; kaynak depo bakiyesini aşamaz.
locationmetinEvetİşlemin loc_ depo kimliği; /locations listesinden seçin."loc_1234567890abcdef1234567890abcdef"
to_locationmetinEvetHedef loc_ depo kimliği; kaynak location alanından farklı olmalıdır."loc_abcdef1234567890abcdef1234567890"
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"
UnchangedCount
AlanTürZorunluAçıklamaÖrnek
changedsabit falseEvetGüncel miktar sayımla aynı; ortak servis belge açmadı.false
Variant
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseEvetArşivdeki veya kapanmış kaynaksa true. archived=true süzgeci bunları da içerir.false
barcodemetin · null olabilirEvetÜrünün veya seçeneğin barkodu."8690000000001"
compare_pricemetin · null olabilirEvetKarşılaştırma fiyatı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."150.00"
created_attarih-saatEvetOluşturulma zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
currencysabit "TRY"EvetPara birimi; v1 tutarları Türk lirasıdır."TRY"
expiredtrue/falseEvetSeçenek emekli edilmişse true.false
idmetinEvetKaynağın dış kimliği; var_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz."var_1234567890abcdef1234567890abcdef"
is_defaulttrue/falseEvetVarsayılan seçenek veya depo ise true.true
made_to_ordertrue/falseEvetSipariş üzerine hazırlanırsa true; sayılmayan stoktan önceliklidir.false
namemetinEvetKaydın görünen adı."Mavi"
optionsliste: nesne (Option)EvetSeçeneğin ad/değer özellikleri.
pool_quantitymetin · null olabilirEvetSeçeneğin ortak stoktan kullandığı miktar; birimi ilgili ürün/depo alanında verilen ondalık metin."1.000"
pricemetin · null olabilirEvetSatış fiyatı; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."120.00"
productmetinEvetÜrün kimliği (prd_ ve 32 küçük onaltılık karakter)."prd_1234567890abcdef1234567890abcdef"
skumetin · null olabilirEvetStok takip kodu; eşitlik araması normalize edilerek yapılır."KUPA-MAVI"
stock_uncountedtrue/falseEvetStok sayılmıyorsa true; stok miktarı null sunulur.false
updated_attarih-saatEvetSon değişiklik zamanı; RFC 3339 UTC."2026-10-16T09:00:00Z"
costmetin · null olabilirHayırMaliyet; yalnız costs:read ile görünür; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin."80.00"
VariantsExportFilters
AlanTürZorunluAçıklamaÖrnek
archivedtrue/falseHayırtrue arşivdeki ve kapalı kayıtları da içerir; varsayılan false.false
barcodemetin · null olabilirHayırNormalize edilmiş barkodla tam eşitlik; sku da verilirse ikisi eşleşir."8690000000001"
productmetin · null olabilirHayırÜrün dış kimliği (prd_ ve 32 küçük onaltılık karakter)."prd_1234567890abcdef1234567890abcdef"
skumetin · null olabilirHayırNormalize edilmiş stok koduyla tam eşitlik; barcode da verilirse ikisi eşleşir."KUPA-MAVI"
VariantsExportInput
AlanTürZorunluAçıklamaÖrnek
formatmetin (seçenekler: jsonl, csv)Evetjsonl: satır başına JSON nesnesi; csv: her hücresi JSON değeri olan CSV."jsonl"
modesabit "consistent_snapshot"Evetconsistent_snapshot: bütün kayıtlar aynı anın tutarlı görünümüdür."consistent_snapshot"
resourcesabit "variants"EvetDışa aktarılacak kaynak; aynı kaynağın okuma kapsamı gerekir."variants"
filtersnesne (VariantsExportFilters)HayırKaynağın liste süzgeçleri; limit, cursor ve include desteklenmez.
WriteOffStock
AlanTürZorunluAçıklamaÖrnek
linesliste: nesne (StockLine) (en çok 500 öğe)EvetAzalan seçenekler ve pozitif miktarları.
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"