Schemas
User
emailKullanıcının sisteme giriş ve bildirimler için kullandığı e-posta adresi.
usernameSistemde kullanıcı adı olarak kullanılan benzersiz değer.
statusKullanıcının aktiflik durumu. Seçenekler: | 0: Pasif kullanıcı; giriş yapamaz. | 1: Aktif kullanıcı; sisteme giriş yapabilir ve işlemler gerçekleştirebilir. | 2: Askıya alınmış kullanıcı; geçici olarak giriş ve işlemler engellenmiş.
idKullanıcı nesnesinin benzersiz kimlik değeri.
firstnameKullanıcının adı.
surnameKullanıcının soyadı.
phoneNumbercreatedAtKullanıcı hesabının oluşturulma zamanı.
updatedAtKullanıcı hesabında yapılan son güncellemenin zamanı.
isOwnermfaSecretmfaResetKeymfaMethodmfaOtpCodemfaOtpCodeSentAtuserRoleTownGroup
nameİlçe grubu nesnesinin adı.
idİlçe grubu nesnesinin benzersiz kimlik değeri.
statusİlçe grubunun aktiflik durumu. true = Aktif, false = Pasif
Town
nameİlçe adı.
idİlçe nesnesine ait benzersiz kimlik numarası.
statusİlçenin aktiflik durumu (0 = Pasif, 1 = Aktif).
Theme
platformTemanın kullanılacağı platform türünü belirtir. Seçenekler: | desktop: asaüstü platformu için kullanılacak tema.. | mobile: Mobil platformu için kullanılacak tema..
nameTemanın ismi.
statusTemanın aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif). Seçenekler: | 0: 0 | 1: 1
idTema nesnesine ait benzersiz kimlik (ID) değeri.
typeTema tipini belirtir. Seçenekler: | self: Kişisel olarak oluşturulan özel tema. | standard: Sistem tarafından sağlanan standart tema.
presetTemaya ait varsayılan renk
directoryNameTemanın bulunduğu dizin adı.
revisionversionTema versiyon numarasını belirtir. Seçenekler: | 1: 1 | 2: 2
assetJsonrenderJsoncreatedAtTema nesnesinin oluşturulma tarihi.
updatedAtTema nesnesinin güncellenme tarihi.
attachmentTemaya ait dosya ekini ifade eder.
packageGroupisCopyrightTag
idSEO+ etiketi nesnesine ait benzersiz kimlik numarası
nameSEO+ etiketi nesnesi adı.
slugcountSEO+ etiketinin kaç kez kullanıldığı bilgisi.
pageTitleSEO+ etiketi nesnesinin etiket başlığı.
metaDescriptionArama motorları tarafından tespit edilebilecek açıklama yazısı.
metaKeywordsArama motorları tarafından tespit edilebilecek anahtar kelimeler.
Subscription
idAbonelik nesnesi kimlik değeri
periodsAbonelik periyodu
periodFrequencyAbonelik periyodu sıklığı Seçenekler: | daily: Günlük | weekly: Haftalık | monthly: Aylık
dispatchCountsPeriyot içindeki sevk sayısı. Örneğin 30 günde bir en fazla 1, 2, 3 veya 4 defa abone olunabilir
continuousSendingSürekli gönderim. Kullanıcı abonelikten çıkmadığı sürece gönderim devam eder Seçenekler: | 0: Pasif | 1: Aktif
nameAbonelik nesnesi adı
descriptionAçıklama
statusAbonelik nesnesi aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif
discountİndirim
shippingAmountKargo ücreti
createdAtAbonelik nesnesinin oluşturulma zamanı
updatedAtAbonelik nesnesinin güncellenme zamanı
SpecValue
nameÖzelliğe ait görünen ad.
idÜrün özelliği değeri nesnesinin benzersiz kimlik (ID) değeri.
slugÖzellik için oluşturulmuş URL uyumlu kısa ad (slug).
sortOrderÖzellik değerinin listeleme sırası (artan olarak sıralanır).
logoÖzellik değerine ait logo dosyasının adı veya yolu.
statusÖzellik değerinin aktiflik durumu. Seçenekler: | 0: Devre dışı (özellik değeri sistemde kullanılmaz). | 1: Etkin (özellik değeri aktif olarak kullanılabilir).
attachmentÖzellik değerine ait görsel dosyası (upload edilen ham dosya bilgisi).
sizeÖzellik görseli/logosu için kullanılan boyut değeri (px). Seçenekler: | 16: 16px | 24: 24px | 32: 32px
Ürün özellik grubu objesi
Ürün özelliği nesnesi
updatedAtÖzellik değerinin son güncellenme tarihi (ISO 8601 formatında).
createdAtÖzellik değerinin oluşturulma tarihi (ISO 8601 formatında).
SpecToProduct
Ürün özellik grubu objesi
Ürün özelliği nesnesi
idÜrün özellik ürün bağı nesnesine ait benzersiz kimlik (ID) değeri.
Ürün detay objesi
SpecName
nameÜrün özelliği adı.
idÜrün özelliğine ait benzersiz kimlik numarası.
slugURL’de kullanılan özellik slug değeri.
choiceTypeÖzellik tipini belirtir.
sortOrderÜrün özelliği sıralaması.
statusÜrün özelliği aktiflik durumunu belirtir (0 = Pasif, 1 = Aktif).
Ürün özellik grubu objesi
SpecGroup
nameÖzellik grubu adı
idÖzellik grubu için benzersiz kimlik
sortOrderGörüntüleme sırası
statusGrup aktiflik durumu
ShippingRate
volumetricWeightStartİlgili kargo firması, ilgili bölge ve ilgili orana ait minimum desi değeri.
volumetricWeightEndİlgili kargo firması, ilgili bölge ve ilgili orana ait maximum desi değeri.
rateSeçili bölge ve kargo firması için kargo oranı.
idKargo oranı nesnesi kimlik değeri.
Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
ShippingProviderSetting
varKeyAyar değişkeninin anahtar değeri
varValueAyar değişkeninin değeri
idTeslimat sağlayıcısı ayarı nesnesi kimlik değeri
Kargo sağlayıcısı nesnesi
ShippingProvider
codeKargo sağlayıcısı kodu. Benzersiz olmalıdır.
nameKargo sağlayıcısının görünen adı.
idKargo sağlayıcısının benzersiz kimlik numarası.
trackingUrlKargo takip url.
trackingFormMethodKargo takibi için kullanılan HTTP metodu (GET veya POST).
payloadKargo takip kodunun gönderildiği sorgu veya form şablonu.
settingsKargo sağlayıcısına özel ek yapılandırma ayarları.
createdAtupdatedAtShippingCompany
nameKargo firması nesnesi adı.
idKargo firması nesnesine ait benzersiz kimlik numarası.
statusKargo firmasının aktiflik durumu. Pasif firmalar sistemde görünmez.
extraPriceKargo firması için sabit ücret. Sabit bir kargo ücreti uygulayacaksanız her sipariş için sabit kargo ücreti girebilirsiniz. Desi bilgilerini kaydetmeniz durumunda desi toplamlarının üzerine sabit ücret eklenecektir.
extraVolumetricWeightPriceKargo firması için girmiş olduğunuz desi bilgileri 50 Desiye kadar girilebilmektedir. 50'nin üzeri veya girmiş olduğunuz desi miktarının üzerine her +1 desi için eklenecek olan kargo ücreti.
freeShipmentOrderPriceAlışveriş sepeti toplamı belirlediğiniz Ücretsiz kargo limitini geçtiğinde müşterileriniz ücretsiz kargo hizmetinden faydalanabilirler.(Örn: X Lira üzeri ücretsiz Kargo!)
freeShipmentVolumetricWeightLimitÜcretsiz kargo miktarı için maksimum ücretsiz desi miktarıdır. Alışveriş sırasındaki desi miktarı ücretsiz desi miktarından fazlaysa, + Desi miktarını sipariş sırasında sistem müşteriden tahsil eder.(Örn: X TL üzeri ücretsiz kargo! Fakat X desiye kadar)Üzeri müşteriden tahsil edilir.
sortOrderKargo firmalarının listelenme sırasını belirler.
companyCodeAPI tarafından otomatik oluşturulan kargo firması kodu.
paymentTypeKargo ödemesinin tipini belirtir.
Kargo sağlayıcısı nesnesi
Ülkeler nesnesi listesi
createdAtKargo firması nesnesinin oluşturulma zamanı.
updatedAtKargo firması nesnesinin son güncellenme zamanı.
ShippingAddress
firstnameAlıcı adı
surnameAlıcı soyadı
countryÜlke adı
locationŞehir adı
addressDetaylı adres bilgisi
mobilePhoneNumberCep telefonu numarası
idAdres için benzersiz kimlik
subLocationİlçe adı
phoneNumberSabit telefon numarası
zipCodecreatedAtupdatedAtShipmentItem
amountGönderilen miktar (stok tipi cinsinden)
priceBirim fiyat
currencyPara birimi kodu
dm3Desi (hacimsel ağırlık)
statusSevkiyat kalemi aktiflik durumu
idSevkiyat kalemi için benzersiz kimlik
rootProductIdAna ürün kimliği (varyantlar için)
productLabelÜrün adı/başlığı
taxKDV oranı (%)
createdAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
Ürün detay objesi
Shipment
idTeslimat nesnesi kimlik değeri.
barcodeTeslimat barkodu.
waybillNoTeslimat fatura numarası.
invoiceKeyTeslimat irsaliye makbuzu numarası.
cargoOfficeTeslimatın kargo şubesi
codeTeslimat kodu. Kargo takip kodu.
deliveryTypeTeslimat tipi
invoiceIncludedFaturanın pakete dahillik durumunu belirtir.
payAtDoorAmountKapıda ödeme hizmeti bedeli.
createdAtTeslimat nesnesinin oluşturulma zamanı.
statusTeslimat nesnesinin aktiflik durumunu belirten değer.
barcodeImageBarkod resmi.
trackingUrlTakip linki.
SelectionToProduct
Ürün detay objesi
idEk özellik ürün bağı nesnesine ait benzersiz kimlik (ID) değeri.
SelectionGroup
titleEk özellik grubu ismi.
sortOrderEk özellik grubu sırası.
idEk özellik grubu nesnesi kimlik değeri.
Selection
titleEk özelliğin başlığı veya adı; ürün sayfasında kullanıcıya gösterilir.
sortOrderEk özelliğin sıralama önceliği; küçük değerler önce, büyük değerler sonra listelenir.
idEk özellik nesnesinin benzersiz kimlik değeri.
ScriptTag
srcScript tag değişkeni kaynağının URL veya dosya yolu.
idScript tag değişkeni nesnesine ait benzersiz kimlik (ID) değeri.
createdAtScript tag değişkeni nesnesinin oluşturulma zamanı.
updatedAtScript tag değişkeni nesnesinin güncellenme zamanı.
clientRegion
nameTeslimat bölgesi ismi.
idTeslimat bölgesi kimlik değeri.
Teslimat bölgesine ait ülkeler listesi.
createdAtupdatedAtQuickCart
nameSepet adı
urlBenzersiz URL tanımlayıcısı
idHızlı sepet için benzersiz kimlik
shortUrlcreatedAtOluşturulma tarihi
updatedAtSon güncellenme tarihi
PurchaseLimitationItem
idLimit kalemi için benzersiz kimlik
Marka objesi
Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
Ürün detay objesi
createdAtSatın alma limiti kalemi nesnesinin oluşturulma zamanı.
updatedAtSatın alma limiti kalemi nesnesinin güncellenme zamanı.
PurchaseLimitation
nameSatın alma limiti nesnesine ait isim.
typeSatın alma limitinin türünü belirtir. Seçenekler: | product: Ürüne göre limit.. | category: Kategoriye göre limit.. | brand: Markaya göre limit..
idSatın alma limiti nesnesine ait benzersiz kimlik (ID) değeri.
minimumLimitBelirlenen en düşük satın alma limiti.
maximumLimitBelirlenen en yüksek satın alma limiti.
statusSatın alma limitinin aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.
createdAtSatın alma limiti nesnesinin oluşturulma tarihi.
updatedAtSatın alma limiti nesnesinin güncellenme tarihi.
PromotionToCategory
Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
idPromotionToBrand
Marka objesi
idPromotionPriceRange
idfromQtyBaşlangıç adeti
toQtyBitiş adeti (fromQty'den büyük olmalı)
discountAmountİndirim miktarı (₺ veya %)
statuscreatedAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
Promotion
namePromosyon adı.
idPromosyon nesnesi kimlik değeri.
startDatePromosyon başlangıç tarihi.
endDateuseDateFilterTarih aralığı özelliği kullanılsın mı?
usageLimittimesUsedconditionsfreeShippingÜcretsiz kargo durumu.
applyToDiscountProductİndirimli ürünlerde geçerli olsun mu?
minimumCheckoutLimitKullanım alışveriş sınırı.
baseCategoryIdbaseCategoryTreebaseBrandIdbaseProductspromotionValidityControlPromosyon geçerlilik kontrolü.
minimumPurchaseQuantitymembersIdmemberGroupIddescriptionPromosyon açıklaması.
urlurlBlankStatusimageFileattachmentpromotionFeatureTypePromosyon özelliği tipi.
promotionFeatureValuePromosyon özelliğine ait promosyon miktarı.
promotionalProductsPromosyonlu ürün nesnesi listesi
promotionalProductQuantityPromosyonlu ürün miktarı.
useLabelstatusPromosyon aktiflik durumu.
campaignPageStatussortOrdercreatedAtPromosyon nesnesinin oluşturulma zamanı.
updatedAtPromosyon nesnesinin güncellenme zamanı.
ProductToTag
Ürün detay objesi
SEO+ etiket nesnesi
idÜrün SEO+ etiketi bağı nesnesine ait benzersiz kimlik (ID) değeridir.
ProductToCountDown
useCountDownGeri sayımın aktiflik durumu bilgisini belirtir. ( 0=Pasif, 1=Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.
idÜrün geri sayım bağı nesnesine ait benzersiz kimlik (ID) değeridir.
startDateGeri sayımın başlangıç tarihi.
endDateGeri sayımın bitiş tarihi.
expireDateGeri sayımın ürün için geçersiz olma tarihi.
Ürün detay objesi
ProductToCollection
idsortOrderÜrün detay objesi
ProductToCategory
Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
idÜrün kategori bağı nesnesine ait benzersiz kimlik (ID) değeri.
sortOrderÜrün kategori bağının sıralama değeri. Bu değer, ürünün kategori içindeki görüntülenme sırasını belirler. Eğer vitrin sırası belirlenmek istenmiyorsa null atanabilir.
Ürün detay objesi
ProductSpecialInfo
titleÖzel bilgi alanı başlığı.
contentÖzel bilgi alanı içeriği.
statusÖzel bilgi alanı aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.
Ürün detay objesi
idÖzel bilgi alanı kaydının benzersiz kimlik değeri.
ProductProtection
isPriceProtectedÜrün fiyatının koruma durumu. Seçenekler: | 0: Korumasız | 1: Korumalı
isStockProtectedÜrün stokunun koruma durumu. Seçenekler: | 0: Korumasız | 1: Korumalı
Ürün detay objesi
idÜrün koruma nesnesi kimlik değeri.
ProductPrice
valueÜrünün fiyat değeri
typeFiyat tipi (alternatif fiyat seçenekleri)
idÜrün fiyatı için benzersiz kimlik
Ürün detay objesi
ProductImage
filename^[a-z0-9-]+$ · requiredDosya adı (uzantısız)
extensionDosya uzantısı
sortOrderGörsel sırası (1-8 arası, 1 ana görsel)
idGörsel için benzersiz kimlik
directoryNamerevisionÜrün detay objesi
attachment^data:image\/(jpeg|j…Base64 encoded görsel verisi (sadece POST işlemlerinde kullanılır)
altProductExtraField
varKeyidÜrün detay objesi
varValueProductDetail
detailsDetay bilgisi.
idÜrün detayı nesnesi kimlik değeri.
skuÜrünün stok kodu.
extraDetailsÜrün ekstra detaylı bilgi.
Ürün detay objesi
ProductCommentImage
filenameextensioniddirectoryNameattachmentProductComment
titleÜrün yorumu başlığı.
contentÜrün yorumu içeriği.
statusÜrün yorumu durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
rankÜrün yorumunda ürüne verilen puan. Seçenekler: | 1: 1 puan. | 2: 2 puan. | 3: 3 puan. | 4: 4 puan. | 5: 5 puan.
isAnonymousÜrün yorumu yapan kişinin anonim olup olmadığı bilgisi. Seçenekler: | 0: Anonim değil. | 1: Anonim.
Üye hesap bilgilerini içeren obje
Ürün detay objesi
Ürün detay objesi
idÜrün yorumu nesnesi kimlik değeri.
createdAtÜrün yorumu nesnesinin oluşturulma zamanı.
updatedAtÜrün yorumu nesnesinin güncellenme zamanı.
ProductButton
Ürün detay objesi
idButon ayarları için benzersiz kimlik
fastShippingHızlı gönderi rozeti
sameDayShippingAynı gün kargo rozeti
threeDaysDelivery3 günde teslimat rozeti
fiveDaysDelivery5 günde teslimat rozeti
sevenDaysDelivery7 günde teslimat rozeti
freeShippingÜcretsiz kargo butonu
deliveryFromStockStoktan teslim rozeti
preOrderedProductÖn siparişli ürün rozeti
limitedStockSınırlı stok rozeti
askStockStok sorunuz rozeti
campaignedProductKampanyalı ürün rozeti
Product
idÜrün için benzersiz kimlik
nameÜrün adı
slug^[a-z0-9-]+$URL dostu benzersiz tanımlayıcı
fullNameTam ürün adı (varyantlar için ana ürün + varyant adı)
skuStok kodu (benzersiz)
barcode^[0-9]{8,14}$Ürün barkodu
price1Ana satış fiyatı (Fiyat 1)
warrantyGaranti süresi (ay)
taxKDV oranı (%)
stockAmountMevcut stok miktarı
volumetricWeightDesi (hacimsel ağırlık)
buyingPriceAlış fiyatı
stockTypeLabelStok birim tipi
discountİndirim değeri (tip'e göre ₺ veya %)
discountTypeİndirim tipi
moneyOrderDiscountHavale/EFT indirim yüzdesi
statusÜrün aktiflik durumu
taxIncludedFiyatlara KDV dahil mi?
distributorTedarikçi adı
isGiftedgiftHediye açıklaması
customShippingDisabledÖzel kargo ücreti kullanılsın mı?
customShippingCostÖzel kargo ücreti (customShippingDisabled=0 ise)
marketPriceDetailPiyasa fiyatı açıklaması
createdAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
midblockSortOrderVitrin blokları sırası
metaKeywordsSEO meta anahtar kelimeler
metaDescriptionSEO meta açıklama
pageTitleSEO sayfa başlığı
hasOptionVaryant var mı? (sistem otomatik atar)
shortDetailsKısa ürün açıklaması
searchKeywordsArama anahtar kelimeleri (virgülle ayrılmış)
installmentThresholdMaksimum taksit sayısı ('-' = limit yok)
homeSortOrderAnasayfa vitrini sırası (null = vitrin dışı)
popularSortOrderPopüler ürünler vitrini sırası
brandSortOrderMarka vitrini sırası
featuredSortOrderSponsor ürünler vitrini sırası
campaignedSortOrderKampanyalı ürünler vitrini sırası
newSortOrderYeni ürünler vitrini sırası
discountedSortOrderİndirimli ürünler vitrini sırası
Marka objesi
Vitrin bloğu objesi
Ana ürün objesi (varyantlar için)
Alternatif fiyatlar listesi
Ürün görselleri listesi
targetKeywordPreference
idTanımlama nesnesinin benzersiz kimlik değeri.
varKeyTanımlamanın anahtar değeri. Sistem içi konfigürasyonlarda kullanılan sabit tanım anahtarıdır.
varValueTanımlamanın değer kısmı. Belirtilen anahtarın mağazada gözükecek karşılık değeri.
PreOrderInfo
sessionIdÜyenin son oturumunun benzersiz kimlik değeri
customerFirstnameMüşterinin adı
customerSurnameMüşterinin soyadı
customerEmailMüşterinin e-posta adresi
shippingFirstnameTeslimat yapılacak kişinin adı
shippingSurnameTeslimat yapılacak kişinin soyadı
shippingAddressTeslimat adresi detayları
shippingPhoneNumberTeslimat yapılacak kişinin telefon numarası
shippingMobilePhoneNumberTeslimat yapılacak kişinin mobil telefon numarası
shippingLocationNameTeslimat şehri
shippingTownTeslimat ilçesi
billingFirstnameFatura kesilecek kişinin adı
billingSurnameFatura kesilecek kişinin soyadı
billingAddressFatura adresi detayları
billingPhoneNumberFatura kesilecek kişinin telefon numarası
billingMobilePhoneNumberFatura kesilecek kişinin mobil telefon numarası
billingLocationNameFatura adresi şehri
billingTownFatura adresi ilçesi
billingInvoiceTypeFatura tipi Seçenekler: | individual: Bireysel | corporate: Kurumsal
Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
idSipariş öncesi bilgisi nesnesinin kimlik değeri
differentBillingAddressTeslimat adresinden farklı bir fatura adresi var mı Seçenekler: | 0: Yok | 1: Var
billingIdentityRegistrationNumberTC kimlik numarası (bireysel faturalarda)
billingTaxOfficeFatura kesilen kişi/kurumun vergi dairesi
billingZipCodebillingTaxNoFatura kesilen kişi/kurum vergi numarası
isEinvoiceUserYöneticinin e-fatura kullanıp kullanmadığı Seçenekler: | 0: Hayır | 1: Evet
useGiftPackageMüşteri hediye paketi isteyip istemediği Seçenekler: | 0: Hayır | 1: Evet
giftNoteHediye notu
imageFileSipariş öncesi görsel dosya adı (jpg, jpeg, png, gif)
deliveryDateMüşterinin talep ettiği teslimat tarihi
deliveryTimeAPI tarafından oluşturulan teslimat saati aralığı
shippingZipCodecreatedAtSipariş öncesi bilgisi nesnesinin oluşturulma zamanı
updatedAtSipariş öncesi bilgisi nesnesinin güncellenme zamanı
Üye adresi objesi
Üye adresi objesi
PaymentType
nameÖdeme tipinin adı.
idÖdeme tipi nesnesi kimlik değeri.
sortOrderÖdeme tipinin sıralama değeri.
PaymentProviderSetting
varKeyÖdeme altyapısı sağlayıcısı ayarı nesnesi için değişken anahtarı.
varValueÖdeme altyapısı sağlayıcısı ayarı nesnesi için değişken değeri.
idÖdeme sağlayıcı ayarına ait benzersiz kimlik numarası.
PaymentProvider
idÖdeme altyapısı sağlayıcısı nesnesine ait benzersiz kimlik (ID) değeri.
codeÖdeme altyapısı sağlayıcısı için ön tanımlanmış kod değeri.
nameÖdeme altyapısı sağlayıcısı için isim değeri.
statusÖdeme altyapısı sağlayıcısının aktif veya pasif olup olmadığı bilgisini tutar.(0 = pasif, 1 = aktif)
Ödeme altyapısı sağlayıcısına ait ayarların listesi
PaymentGatewaySetting
varKeyvarValueidÖdeme kanalı ayarı nesnesi kimlik değeri.
PaymentGateway
codeÖdeme kanalı için sistemde ön tanımlı kod değeri.
nameÖdeme kanalı ismi.
idÖdeme kanalı nesnesinin benzersiz kimlik değeri.
statusÖdeme kanalının aktiflik durumu. Seçenekler: | active: Ödeme kanalı aktif. | passive: Ödeme kanalı pasif.
sortOrderÖdeme kanalının listelerdeki sıralama değeri.
createdAtÖdeme kanalı nesnesinin oluşturulma zamanı.
updatedAtÖdeme kanalı nesnesinin güncellenme zamanı.
legacyTableNamelegacyTableIdÖdeme kanalına ait konfigürasyon ve ayarlar.
PaymentBddkCategory
bddkCategoryNameidinstallmentextraFieldPayment
memberFirstnameÖdeme yapan üyenin adı
memberSurnameÖdeme yapan üyenin soyadı
memberEmailÖdeme yapan üyenin e-posta adresi
paymentTypeNameÖdeme yöntemi adı
paymentProviderCodeÖdeme sağlayıcı kodu
paymentProviderNameÖdeme sağlayıcı adı
paymentGatewayNameÖdeme gateway adı
paymentGatewayCodeÖdeme gateway kodu
deviceTypeÖdemenin yapıldığı cihaz tipi
clientIpMüşterinin IP adresi
currencyRatesİşlem anındaki döviz kurları (JSON string)
amountÖdeme tutarı (vergi ve indirimler hariç)
finalAmountToplam ödeme tutarı (tüm hesaplamalarla birlikte)
installmentTaksit sayısı
installmentRateTaksit oranı (faiz oranı)
currency^[A-Z]{3}$ · requiredPara birimi kodu
statusSipariş durumu
idÖdeme için benzersiz kimlik
memberPhoneÖdeme yapan üyenin telefon numarası
bankNameİşlem yapılan banka adı
cardHolderNameKart sahibinin adı
sumOfGainedPointsBu ödemeden kazanılan toplam puan
extraInstallmentEkstra kampanya taksit sayısı
transactionIdİşlem numarası
memberNoteMüşteri tarafından eklenen sipariş notu
userNoteYönetici tarafından eklenen sipariş notu
errorMessageHatalı ödeme işlemlerinde hata mesajı
cardSavingSystemKullanılan kart saklama sistemi
createdAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
Üye hesap bilgilerini içeren obje
Orders
idSiparişe ait benzersiz kimlik (ID) değeridir.
customerFirstnameMüşterinin adı.
customerSurnameMüşterinin soyadı.
customerEmailMüşterinin e-mail adresi.
customerPhoneMüşterinin telefon numarası.
paymentTypeNameSiparişin ödeme tipi.
paymentProviderCodeSiparişin ödeme altyapısı sağlayıcısının sistemdeki kod değeri. Ön tanımlıdır. API otomatik oluşturur.
paymentProviderNameSiparişin ödeme altyapısı sağlayıcısının adı. Ön tanımlıdır. API otomatik oluşturur.
paymentGatewayCodeSiparişin ödeme kanalının kodu. Ön tanımlıdır. API otomatik oluşturur.
paymentGatewayNameSiparişin ödeme kanalının adı. Ön tanımlıdır. API otomatik oluşturur.
bankNameSipariş sırasında seçilen veya kullanılan banka adı. Ön tanımlıdır. API otomatik oluşturur.
cardHolderNameclientIpSiparişi oluşturan müşterinin IP adresi.
userAgentSiparişin oluşturulduğu cihaz/tarayıcı bilgisi.
currencySiparişte kullanılan kur(para birimi) kodu.
currencyRatesİlgili para birimleri ve alış/satış oranlarını içeren nesne, kur oranları.
amountSiparişin vergi hariç ara toplam tutarı.
couponDiscountSiparişte kullanılan hediye çeki indirimi tutarı.
taxAmountSiparişin için hesaplanan toplam vergi tutarı.
promotionDiscountSiparişte kullanılan promosyon indirimi tutarı.
generalAmountSiparişin genel toplam fiyat tutarı. orderAmount, couponDiscount, taxAmount, promotionDiscount, shippingAmount, additionalServiceAmount tutarlarının toplamı.
shippingAmountSipariş için tahsil edilen kargo/teslimat ücreti.
additionalServiceAmountSiparişe ait ek hizmet ücretlerinin toplamı.
finalAmountSiparişin son ödeme tutarı. (generalAmount üzerine taksit/vade farkı eklendiyse dahil edilmiş hali).
sumOfGainedPointsSiparişten müşterinin kazanacağı toplam puan miktarı.
installmentSipariş için seçilen taksit sayısı.
installmentRateSiparişin taksit oranı.
extraInstallmentSipariş için seçilen ek taksit sayısı.
transactionIdSipariş numarası.
hasUserNoteSiparişin müşteri notu içerip içermediğini belirtir. (0 = Yok, 1 = Var) Seçenekler: | 0: Sipariş müşteri notuna sahip değil. | 1: Sipariş müşteri notuna sahip.
statusSiparişin genel durumu. Seçenekler: | deleted: Silindi | waiting_for_approval: Onay Bekliyor | approved: Onaylandı | fulfilled: Kargoya Verildi | cancelled: İptal Edildi | delivered: Teslim Edildi | on_accumulation: Tedarik Sürecinde | waiting_for_payment: Ödeme Bekleniyor | being_prepared: Hazırlanıyor | refunded: İade Edildi | personal_status_1: Kişisel Sipariş Durumu 1 | personal_status_2: Kişisel Sipariş Durumu 2 | personal_status_3: Kişisel Sipariş Durumu 3
paymentStatusÖdeme işleminin sonucu/durumu. Seçenekler: | in_transaction: Sonuçlanmamış Ödemeler | failed: Hatalı Ödemeler | success: Başarılı
errorMessageSipariş ile ilgili hata mesajı (varsa).
sessionIddeviceTypeSiparişin gerçekleştiği cihaz bilgisi. Seçenekler: | desktop: Masaüstü | mobile: Mobil | tablet: Tablet
referrerSiparişe yönlendiren web sitesinin tam URL bilgisi. API otomatik oluşturur.
invoicePrintCountSipariş için alınan fatura çıktısı adedi.
useGiftPackageHediye paketi talebi durumu. (0 = İstemiyorum, 1 = İstiyorum) Seçenekler: | 0: Hediye paketi istemiyorum | 1: Hediye paketi istiyorum
giftNoteMüşterinin bıraktığı hediye notu (varsa).
giftAmountmemberGroupNameSipariş veren müşterinin üye grubunun adı.
usePromotionSiparişte promosyon kullanılıp kullanılmadığını belirtir. (0 = Hayır, 1 = Evet) Seçenekler: | 0: Promosyon kullanma | 1: Promosyon kullan
shippingProviderCodeSiparişin teslimat hizmeti sağlayıcısının kodu. Ön tanımlıdır. API otomatik oluşturur.
shippingProviderNameSiparişin teslimat hizmeti sağlayıcısının adı. Ön tanımlıdır.
shippingCompanyNameSiparişin kargo firmasının adı. Ön tanımlıdır.
shippingPaymentTypeSiparişin kargo ödemesinin tipi. Seçenekler: | cash_on_delivery: Alıcı Ödemeli | standart_delivery: Gönderici Ödemeli | not_applicable: Bu alan için geçerli değil.
shippingTrackingCodeSiparişin kargo takip kodu.
nebimTransferStatuspaidFromCurrentAccountsourceSiparişin geldiği kaynak bilgisi. Siparişin kaynak yazılımını belirtir.
createdAtSipariş kaydının oluşturulma tarihi.
updatedAtSipariş kaydının güncellenme tarihi.
orderDayÜye hesap bilgilerini içeren obje
Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
Kargo sağlayıcısı nesnesi
Sipariş detaylarının bilgisi..
Sipariş kalemlerinin listesi.
Teslimat adresi objesi
autoPaybackOrderUserNote
userEmailNot ekleyen yöneticinin e-posta adresi
noteNot içeriği
createdAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
idNot için benzersiz kimlik
userFirstnameYöneticinin adı
userSurnameYöneticinin soyadı
OrderRefundRequestItem
amountTalep edilen ürün miktarı.
reasonSipariş iptal talebi sebebi. Tanımlı dört seçenekten biri seçilmelidir.
detailsTalebin detaylı açıklaması.
idSipariş iptal talebi kalemi nesnesi kimlik değeri.
paybackStatusGeri ödeme durumu Seçenekler: | 0: Hayır | 1: Evet
createdAtSipariş iptal talebi kalemi nesnesinin oluşturulma zamanı.
updatedAtSipariş iptal talebi kalemi nesnesinin güncellenme zamanı.
OrderRefundRequest
idSipariş iptal talebi nesnesi kimlik değeri.
codeSipariş iptal talebi için oluşturulan benzersiz kod değeri.
statusSipariş iptal talebinin durumu. Seçenekler: | approved: Onaylandı. | waiting_for_approval: Onay bekliyor. | cancelled: İptal edildi.
feeMüşteriye ödenecek tutar bilgisi.
shippingFeeKargo tutarı.
autoPaybackOtomatik geri ödeme durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
cancellationReasonSipariş iptal talebinin sebebine dair detaylı açıklama.
createdAtSipariş iptal talebi nesnesinin oluşturulma zamanı.
updatedAtSipariş iptal talebi nesnesinin güncellenme zamanı.
Üye hesap bilgilerini içeren obje
OrderItemSubscription
idSipariş kalemi aboneliğine ait benzersiz kimlik numarası.
chosenPeriodchosenDispatchCountOrderItemCustomization
idÖzelleştirme için benzersiz kimlik
productCustomizationGroupIdÜrün özelleştirme grubu kimliği
productCustomizationGroupNameÖzelleştirme grup adı
productCustomizationGroupSortOrderGrup sıralama değeri
productCustomizationFieldIdÖzelleştirme alanı kimliği
productCustomizationFieldTypeAlan tipi
productCustomizationFieldNameAlan adı
productCustomizationFieldSortOrderproductCustomizationFieldValueMüşterinin girdiği değer
cartItemAttributeIdİlişkili sepet kalemi özellik kimliği
isCloudFileDosyanın bulut depolama kullanıp kullanmadığı
cloudContentUrlBulut depolama dosya URL'i
createdAtupdatedAtOrderItem
idSipariş kaleminin benzersiz kimlik (ID) değeri.
productNameSiparişteki ürünün adı.
productSkuÜrünün stok kodu (SKU).
productBarcodeÜrünün barkod numarası.
productPriceÜrünün birim fiyatı.
productCurrencyÜrünün fiyatının para birimi. Seçenekler: | USD: Amerikan Doları | EUR: Euro | TL: Türk Lirası | GBP: İngiliz Sterlini | JPY: Japon Yeni | CNY: Çin Yuanı | GR: Yunan Drahmisi (tarihi kullanım) | CHF: İsviçre Frangı
productQuantitySiparişteki ürün adedi (stok tipi cinsinden).
productTaxÜrünün vergi oranı (yüzde cinsinden).
productDiscountÜrüne uygulanan standart indirim miktarı.
productMoneyOrderDiscountHavale/EFT ile ödemede uygulanan indirim miktarı.
productWeightÜrünün ağırlığı (kg veya ilgili stok tipi birimi).
productStockTypeLabelÜrünün stok tipi etiketi (ör. adet, kg, paket).
isProductPromotionedÜrünün promosyon olup olmadığını belirten değer. Seçenekler: | 0: Ürün promosyon değil | 1: Ürün promosyon
discountÜrüne uygulanan hediye çeki indirim değeri.
maxInstallmentpriceRatiocreatedAtupdatedAtÜrün detay objesi
Sipariş kalemine uygulanan özelleştirmeler (OrderItemCustomization şeması ile ilişkili).
Sipariş kalemi ile ilişkili abonelik bilgilerini temsil eder.
OrderDetail
varKeySipariş detayı için değişken anahtarı (örn. ödeme veya teslimat bilgisi)
varValueDeğişkene ait değer, genellikle JSON formatında detaylı bilgi içerir
idSipariş detayı nesnesinin kimlik değeri
Options
titleVaryant değeri adı (Kırmızı, L, 42 vb.)
idVaryant seçeneği için benzersiz kimlik
slugsortOrderGörüntüleme sırası
logo^[a-zA-Z0-9-_]+\.(jp…Varyant görseli dosya adı (uzantı ile birlikte)
Varyant grubu objesi (renk, beden vb.)
attachment^data:image\/(jpeg|j…Base64 encoded görsel verisi (POST/PUT için)
sizeupdatedAtcreatedAtOptionToProduct
parentProductIdAna ürüne ait benzersiz kimlik (ID) değeridir.
Varyant grubu objesi (renk, beden vb.)
Varyant seçenek objesi (renk değeri, beden değeri vb.)
Ürün detay objesi
idVaryant ürün bağı nesnesine ait benzersiz kimlik (ID) değeridir.
sortOrderOptionGroup
titleVaryant grubu başlığı
idVaryant grubu için benzersiz kimlik
slugURL dostu benzersiz tanımlayıcı
sortOrderGörüntüleme sırası
predefinedSistem öntanımlı mı?
filterStatusFiltre menüsünde göster
aggregatorFiltre menüde gruplanma durumu
Midblock
nameVitrin bloğu adı
statusBlok aktiflik durumu
sortOrderGörüntüleme sırası
productCountPerRowSatırda gösterilecek ürün sayısı
idVitrin bloğu için benzersiz kimlik
MemberGroup
nameÜye grubu ismi
idÜye grubu nesnesinin kimlik değeri
priceIndexÜye grubunun fiyat indeksi (örn. Fiyat 2 için 1)
priceRatioÜye grubunun fiyat indeksi ile çarpanı
allowedPaymentGatewaysMemberDetail
varKeyvarValueidÜye hesap bilgilerini içeren obje
createdAtupdatedAtMemberAddress
idAdres için benzersiz kimlik
nameAdres tanımlayıcı adı
typeAdres tipi
firstnameAdı
surnameSoyadı
addressDetaylı adres bilgisi
locationNameŞehir adı
subLocationNameİlçe adı
phoneNumberSabit telefon numarası
mobilePhoneNumberCep telefonu numarası
tcId^[0-9]{11}$TC kimlik numarası
taxNumber^[0-9]{10}$Vergi numarası (kurumsal faturalar için)
taxOfficeVergi dairesi (kurumsal faturalar için)
invoiceTypeFatura tipi
isEinvoiceUserE-fatura kullanıcısı mı?
zipCodecreatedAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
Üye hesap bilgilerini içeren obje
İlçe nesnesi
Member
idÜye için benzersiz kimlik
firstnameÜyenin adı
surnameÜyenin soyadı
emailÜyenin e-posta adresi
genderCinsiyet bilgisi
birthDateDoğum tarihi
phoneNumberSabit telefon numarası
mobilePhoneNumberCep telefonu numarası
otherLocationAlternatif şehir bilgisi
addressAdres bilgisi
taxNumberVergi numarası
tcId^[0-9]{11}$TC kimlik numarası
passwordÜye hesap şifresi (şifrelenmiş)
activationCodestatusÜye hesap durumu
lastLoginDateSon giriş yapılan tarih ve zaman
createdAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
zipCodePosta kodu
commercialNameKurumsal üyelik için şirket adı
taxOfficeVergi dairesi
lastMailSentDateSon e-posta gönderim tarihi
lastIpSon giriş yapılan IP adresi
gainedPointAmountspentPointAmountallowedToPhoneTelefon ile iletişim izni
allowedToCampaignsKampanya bildirimleri için izin
allowedToSmsSMS bildirimleri için izin
allowedToPhoneUpdatedAtTelefon izni son güncellenme zamanı
allowedToCampaignsUpdatedAtKampanya izni son güncellenme zamanı
allowedToSmsUpdatedAtSMS izni son güncellenme zamanı
referredMemberGainedPointAmountdistrictİlçe bilgisi
deviceTypeÜyelik oluştururken kullanılan cihaz tipi
deviceInfoDetaylı cihaz bilgisi (user agent)
locationNameŞehir adı
Üye hesap bilgilerini içeren obje
kvkkStatusKVKK (kişisel verilerin korunması) onay durumu
kvkkConfirmationDateconfirmationTokenconfirmationTokenExpirationDateMaillistGroup
nameMail listesi grubunun adı.
idMail listesi grubunun benzersiz kimlik değeri.
Maillist
nameMail listesi nesnesinin adı.
emailMail adresi.
idMail listesi nesnesinin benzersiz kimlik değeri.
lastMailSentDateSon gönderim tarihi.
creatorIpAddressMail listesini oluşturan kullanıcının IP adresi.
createdAtMail listesi nesnesinin oluşturulma zamanı.
updatedAtMail listesi nesnesinin güncellenme zamanı.
Location
idŞehir nesnesine ait benzersiz kimlik numarası.
nameŞehir nesnesi için isim değeri.
statusŞehir nesnesinin aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.
predefinedcreatedAtupdatedAtLabelToProduct
Kişisel etiket nesnesi
Ürün detay objesi
idİlişki için benzersiz kimlik
Label
idKişisel etiket nesnesine ait benzersiz kimlik numarası.
nameKişisel etiket Adı
sortOrderKişisel etiket nesnesi için sıralama değeri.
hasChildrenKişisel etiket nesnesinin alt etiket barındırma durumu. Bu değer otomatik oluşturulur.
slugEtiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.
metaTitlemetaKeywordsArama motorları tarafından tespit edilebilecek anahtar kelimeler.
metaDescriptionstatusEtiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.
rootlevelleftIndexrightIndexKişisel etiket nesnesi
createdAtKişisel etiket nesnesinin oluşturulma zamanı.
updatedAtKişisel etiket nesnesinin son güncellenme zamanı.
InstallmentRate
installmentTaksit oranına ait taksit sayısı.
rateTaksit oranı değeri. Ödeme tutarı bu oranla çarpılır.
idTaksit oranı nesnesinin benzersiz kimlik değeri.
FavouritedProduct
Üye hesap bilgilerini içeren obje
Ürün detay objesi
idFavori ürün nesnesine ait benzersiz kimlik (ID) değeridir.
createdAtExtraInfoToProduct
valueEk bilgi ürün bağı değeridir. Ek bilgi "renk" ise bu değer kırmızı olabilir.
Ek bilgi alanı tanımı objesi
Ürün detay objesi
idEk bilgi ürün bağı nesnesine ait benzersiz kimlik (ID) değeri.
ExtraInfo
idEk bilgi için benzersiz kimlik
nameEk bilgi alanı adı
sortOrderGörüntüleme sırası (küçükten büyüğe)
DistributorToProduct
Tedarikçi bilgileri objesi
Ürün detay objesi
idİlişki için benzersiz kimlik
createdAtupdatedAtDistributor
nameTedarikçi şirket adı
idTedarikçi için benzersiz kimlik
emailTedarikçi iletişim e-posta adresi
phoneTedarikçi telefon numarası
contactPersonYetkili kişi adı soyadı
createdAtupdatedAtDigitalProduct
idÜrün detay objesi
deletedAtCurrentAccount
titleCari hesap başlığı.
Üye hesap bilgilerini içeren obje
idCari hesap nesnesi kimlik değeri.
codeCari hesap için düzenlenebilir kod değeri.
balanceCari hesap bakiyesi.
riskLimitCari hesap için risk limiti.
createdAtCari hesap nesnesinin oluşturulma zamanı.
updatedAtCari hesap nesnesinin güncellenme zamanı.
Currency
idKur kimlik değeri.
labelKur etiketi.
buyingPriceKur alış fiyatı.
sellingPriceKur satış fiyatı.
abbrKur kısaltması.
updatedAtKurun güncellenme zamanı.
statusKur aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
permissionStatusKur kullanım izni durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
isPrimaryKurun birincil kur olup olmadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
isEffectiveKurun efektif kur olarak kullanılıp kullanılmadığı. Seçenekler: | 0: Pasif. | 1: Aktif.
isExtraCoupon
idHediye çeki nesnesinin benzersiz kimlik değeri.
codeHediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.
maxUsageHediye çekinin toplam kullanım limiti.
currentUsageHediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.
maxUsagePerMemberBir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.
memberGroupIdstartDateHediye çekinin geçerli olmaya başladığı tarih.
expireDateminimumUsageLimitcreatedAtHediye çekinin oluşturulma zamanı.
createrTypecreaterIdvalueTypevalueEffectproductsKuponun geçerli olduğu ürün nesneleri.
categoriesKuponun geçerli olduğu kategori nesneleri.
statusHediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
cargoFreeKuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
useDiscountProductsbrandsKuponun geçerli olduğu marka nesneleri.
membersKuponun geçerli olduğu üye nesneleri.
isEffectiveSpecialTokentaxIncludedminimumUsageLimitTaxIncludedupdatedAtHediye çekinin son güncellenme zamanı.
Country
idÜlke nesnesinin benzersiz kimlik (ID) değeri.
nameÜlkenin adı.
codeISO 3166-1 alpha-2 ülke kodu (2 harfli).
statusÜlkenin aktiflik durumu. Seçenekler: | 0: Devre dışı (ülke kullanılmaz) | 1: Etkin (ülke kullanılabilir)
exportStatusextraShippingPriceselectedLanguageselectedCurrencyphoneCodeCombineProduct
Ürün detay objesi
Ürün detay objesi
idİlişki için benzersiz kimlik
Collection
nameidslugstatussortOrderdisplayShowcaseContentshowcaseContentshowcaseContentDisplayTypedisplayShowcaseFooterContentshowcaseFooterContentshowcaseFooterContentDisplayTypepageTitlemetaKeywordsmetaDescriptioncanonicalUrlcreatedAtupdatedAtCategory
idKategoriye ait benzersiz kimlik numarası. Sistem tarafından otomatik oluşturulur.
nameKategori nesnesi için isim değeri.
slugSlug değeri ilgili nesnenin Url değeridir.
sortOrderKategori nesnesi için sıralama değeri.
statusKategorinin aktiflik durumunu belirtir. Seçenekler: | 0: Pasif — kategori yayınlanmaz. | 1: Aktif — kategori mağazada görünür.
distributorCodeHer zaman null değer alır. Pratikte kullanımı yoktur.
percentKategori nesnesinin fiyat katsayısı.
imageFileKategori nesnesinin görselinin dosya adı. Geçerli dosya tipleri: .JPG, .PNG, .GIF
distributorHer zaman null değer alır. Pratikte kullanımı yoktur.
displayShowcaseContentKategori üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.
showcaseContentKategori nesnesinin üst içeriği. Admin paneli üzerinden düzenlenebilir.
showcaseContentDisplayTypeKategori nesnesinin üst içerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve üst kategorilere ait içerik. | 3: Bu kategori ve tüm üst kategorilere ait içerik.
displayShowcaseFooterContentKategori Alt İçerik nesnesinin üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.
showcaseFooterContentKategori nesnesinin alt içeriği. Admin paneli üzerinden düzenlenebilir.
showcaseFooterContentDisplayTypeKategori Alt İçerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve alt kategorilere ait içerik. | 3: Bu kategori ve tüm alt kategorilere ait içerik.
hasChildrenKategorinin alt kategorilere sahip olup olmadığını belirtir. Seçenekler: | 0: Var | 1: Yok
metaKeywordsArama motorları tarafından tespit edilebilecek anahtar kelimeler.
metaDescriptionArama motorları tarafından tespit edilebilecek açıklama yazısı.
canonicalUrlİlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-değeri" /> HTML etiketinin girdiginiz-canonical-url alanı yazan yere gelmesini istediğiniz değer. Mağaza domaininizin olduğu kısım değiştirilemez, sistem tarafından otomatik eklenir..
pageTitleSayfanın arama motorları tarafından tespit edilebilecek başlık yazısı.
leftIndexlevelrightIndexrootÜrünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
attachmentattachment
isCombineKategori nesnesi kombin kategori durumu.Bu kategori kombin kategorisi olarak işaretlendiğinde kategori altındaki ürünler kombin detay sayfasına yönlendirilecektir. Seçenekler: | 0: Kombin Kategori | 1: Kombin Kategori değil
isSearchablecreatedAtKategorinin oluşturulma zamanı (ISO 8601 formatında).
updatedAtKategorinin son güncellenme zamanı (ISO 8601 formatında).
targetKeywordCartItemSubscription
idAbonelik için benzersiz kimlik
chosenPeriodSeçilen abonelik periyodu
chosenDispatchCountSeçilen gönderim sayısı
CartItem
quantityBu ürünün sepetteki adedi.
Ürün detay objesi
idSepet kaleminin benzersiz kimlik değeri.
parentProductIdcategoryIdisDigitalProductcreatedAtSepet kaleminin oluşturulma zamanı.
updatedAtSepet kaleminin son güncellenme zamanı.
Sepet kalemi abonelik bilgisi objesi
Cart
idSepet kimlik değeri
sessionIdSepet oturum kimliği
lockedlockedAtcreatedAtupdatedAtÜye hesap bilgilerini içeren obje
Sepet kalemi nesnelerini barındıran liste.
Brand
nameMarka adı
idMarka için benzersiz kimlik
slugsortOrderGörüntüleme sırası
statusMarka aktiflik durumu
distributorCodeTedarikçi kodu
distributorTedarikçi adı
imageFileMarka logo dosya adı (JPG, PNG, GIF)
showcaseContentMarka sayfası üst içerik metni (HTML)
displayShowcaseContentÜst içerik gösterim durumu
showcaseFooterContentdisplayShowcaseFooterContentmetaKeywordsSEO meta anahtar kelimeler
metaDescriptionSEO meta açıklama
canonicalUrl^[a-z0-9-/]+$Canonical URL (domain hariç)
pageTitleSEO sayfa başlığı
attachment^data:image\/(jpeg|j…Base64 encoded logo verisi (POST/PUT için)
isSearchablecreatedAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
targetKeywordBillingAddress
firstnameMüşterinin ismi.
surnameMüşterinin soy ismi.
countryMüşterinin ülke bilgisi.
locationMüşterinin şehir bilgisi.
addressMüşterinin adres bilgisi.
mobilePhoneNumberMüşterinin mobil telefon numarası.
idFatura adresi nesnesi kimlik değeri.
subLocationMüşterinin ilçe bilgisi.
phoneNumberMüşterinin telefon numarası.
zipCodecreatedAtupdatedAtinvoiceTypeFatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.
taxNoFatura için vergi numarası.
taxOfficeFatura için vergi dairesi.
identityRegistrationNumberMüşterinin T.C. Kimlik numarası.
Error
codeHTTP durum kodu.
errorMessageHata mesajı. x-ideasoft-locale istek başlığına göre çevrilir.
errorCodeUygulamaya özgü hata kodu. Doğrulama hatalarında 300001, tanımsız hatalarda 0.
errorsDoğrulama hataları. Admin API alan adı → mesaj nesnesi, Store API {alan adı: mesaj} nesnelerinden oluşan dizi döner.
redirectUriYalnız OAuth yönlendirme hatalarında dönen yönlendirme adresi.
OAuthError
errorOAuth hata kodu (örn. access_denied, invalid_grant).
error_descriptionHata açıklaması.
TownGroupSummary
nameİlçe grubu nesnesinin adı.
idİlçe grubu nesnesinin benzersiz kimlik değeri.
statusİlçe grubunun aktiflik durumu. true = Aktif, false = Pasif
TownSummary
nameİlçe adı.
idİlçe nesnesine ait benzersiz kimlik numarası.
statusİlçenin aktiflik durumu (0 = Pasif, 1 = Aktif).
Location nesnesi (özet). Tüm alanlar için Location şemasına bakın.
TownGroup nesnesi (özet). Tüm alanlar için TownGroup şemasına bakın.
TagSummary
idSEO+ etiketi nesnesine ait benzersiz kimlik numarası
nameSEO+ etiketi nesnesi adı.
slugcountSEO+ etiketinin kaç kez kullanıldığı bilgisi.
pageTitleSEO+ etiketi nesnesinin etiket başlığı.
metaDescriptionArama motorları tarafından tespit edilebilecek açıklama yazısı.
metaKeywordsArama motorları tarafından tespit edilebilecek anahtar kelimeler.
SubscriptionSummary
idAbonelik nesnesi kimlik değeri
periodsAbonelik periyodu
periodFrequencyAbonelik periyodu sıklığı Seçenekler: | daily: Günlük | weekly: Haftalık | monthly: Aylık
dispatchCountsPeriyot içindeki sevk sayısı. Örneğin 30 günde bir en fazla 1, 2, 3 veya 4 defa abone olunabilir
continuousSendingSürekli gönderim. Kullanıcı abonelikten çıkmadığı sürece gönderim devam eder Seçenekler: | 0: Pasif | 1: Aktif
nameAbonelik nesnesi adı
descriptionAçıklama
statusAbonelik nesnesi aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif
discountİndirim
shippingAmountKargo ücreti
createdAtAbonelik nesnesinin oluşturulma zamanı
updatedAtAbonelik nesnesinin güncellenme zamanı
SpecValueSummary
nameÖzelliğe ait görünen ad.
idÜrün özelliği değeri nesnesinin benzersiz kimlik (ID) değeri.
slugÖzellik için oluşturulmuş URL uyumlu kısa ad (slug).
sortOrderÖzellik değerinin listeleme sırası (artan olarak sıralanır).
logoÖzellik değerine ait logo dosyasının adı veya yolu.
statusÖzellik değerinin aktiflik durumu. Seçenekler: | 0: Devre dışı (özellik değeri sistemde kullanılmaz). | 1: Etkin (özellik değeri aktif olarak kullanılabilir).
attachmentÖzellik değerine ait görsel dosyası (upload edilen ham dosya bilgisi).
sizeÖzellik görseli/logosu için kullanılan boyut değeri (px). Seçenekler: | 16: 16px | 24: 24px | 32: 32px
SpecGroup nesnesi (özet). Tüm alanlar için SpecGroup şemasına bakın.
SpecName nesnesi (özet). Tüm alanlar için SpecName şemasına bakın.
updatedAtÖzellik değerinin son güncellenme tarihi (ISO 8601 formatında).
createdAtÖzellik değerinin oluşturulma tarihi (ISO 8601 formatında).
SpecNameSummary
nameÜrün özelliği adı.
idÜrün özelliğine ait benzersiz kimlik numarası.
slugURL’de kullanılan özellik slug değeri.
choiceTypeÖzellik tipini belirtir.
sortOrderÜrün özelliği sıralaması.
statusÜrün özelliği aktiflik durumunu belirtir (0 = Pasif, 1 = Aktif).
SpecGroup nesnesi (özet). Tüm alanlar için SpecGroup şemasına bakın.
SpecGroupSummary
nameÖzellik grubu adı
idÖzellik grubu için benzersiz kimlik
sortOrderGörüntüleme sırası
statusGrup aktiflik durumu
ShippingProviderSummary
codeKargo sağlayıcısı kodu. Benzersiz olmalıdır.
nameKargo sağlayıcısının görünen adı.
idKargo sağlayıcısının benzersiz kimlik numarası.
trackingUrlKargo takip url.
trackingFormMethodKargo takibi için kullanılan HTTP metodu (GET veya POST).
payloadKargo takip kodunun gönderildiği sorgu veya form şablonu.
settingsKargo sağlayıcısına özel ek yapılandırma ayarları.
createdAtupdatedAtShippingCompanySummary
nameKargo firması nesnesi adı.
idKargo firması nesnesine ait benzersiz kimlik numarası.
statusKargo firmasının aktiflik durumu. Pasif firmalar sistemde görünmez.
extraPriceKargo firması için sabit ücret. Sabit bir kargo ücreti uygulayacaksanız her sipariş için sabit kargo ücreti girebilirsiniz. Desi bilgilerini kaydetmeniz durumunda desi toplamlarının üzerine sabit ücret eklenecektir.
extraVolumetricWeightPriceKargo firması için girmiş olduğunuz desi bilgileri 50 Desiye kadar girilebilmektedir. 50'nin üzeri veya girmiş olduğunuz desi miktarının üzerine her +1 desi için eklenecek olan kargo ücreti.
freeShipmentOrderPriceAlışveriş sepeti toplamı belirlediğiniz Ücretsiz kargo limitini geçtiğinde müşterileriniz ücretsiz kargo hizmetinden faydalanabilirler.(Örn: X Lira üzeri ücretsiz Kargo!)
freeShipmentVolumetricWeightLimitÜcretsiz kargo miktarı için maksimum ücretsiz desi miktarıdır. Alışveriş sırasındaki desi miktarı ücretsiz desi miktarından fazlaysa, + Desi miktarını sipariş sırasında sistem müşteriden tahsil eder.(Örn: X TL üzeri ücretsiz kargo! Fakat X desiye kadar)Üzeri müşteriden tahsil edilir.
sortOrderKargo firmalarının listelenme sırasını belirler.
companyCodeAPI tarafından otomatik oluşturulan kargo firması kodu.
paymentTypeKargo ödemesinin tipini belirtir.
ShippingProvider nesnesi (özet). Tüm alanlar için ShippingProvider şemasına bakın.
createdAtKargo firması nesnesinin oluşturulma zamanı.
updatedAtKargo firması nesnesinin son güncellenme zamanı.
ShippingAddressSummary
firstnameAlıcı adı
surnameAlıcı soyadı
countryÜlke adı
locationŞehir adı
addressDetaylı adres bilgisi
mobilePhoneNumberCep telefonu numarası
idAdres için benzersiz kimlik
subLocationİlçe adı
phoneNumberSabit telefon numarası
zipCodecreatedAtupdatedAtOrders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.
ShipmentSummary
idTeslimat nesnesi kimlik değeri.
barcodeTeslimat barkodu.
waybillNoTeslimat fatura numarası.
invoiceKeyTeslimat irsaliye makbuzu numarası.
cargoOfficeTeslimatın kargo şubesi
codeTeslimat kodu. Kargo takip kodu.
deliveryTypeTeslimat tipi
invoiceIncludedFaturanın pakete dahillik durumunu belirtir.
payAtDoorAmountKapıda ödeme hizmeti bedeli.
createdAtTeslimat nesnesinin oluşturulma zamanı.
statusTeslimat nesnesinin aktiflik durumunu belirten değer.
Orders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.
barcodeImageBarkod resmi.
trackingUrlTakip linki.
SelectionGroupSummary
titleEk özellik grubu ismi.
sortOrderEk özellik grubu sırası.
idEk özellik grubu nesnesi kimlik değeri.
SelectionSummary
titleEk özelliğin başlığı veya adı; ürün sayfasında kullanıcıya gösterilir.
sortOrderEk özelliğin sıralama önceliği; küçük değerler önce, büyük değerler sonra listelenir.
idEk özellik nesnesinin benzersiz kimlik değeri.
SelectionGroup nesnesi (özet). Tüm alanlar için SelectionGroup şemasına bakın.
RegionSummary
nameTeslimat bölgesi ismi.
idTeslimat bölgesi kimlik değeri.
createdAtupdatedAtPurchaseLimitationSummary
nameSatın alma limiti nesnesine ait isim.
typeSatın alma limitinin türünü belirtir. Seçenekler: | product: Ürüne göre limit.. | category: Kategoriye göre limit.. | brand: Markaya göre limit..
idSatın alma limiti nesnesine ait benzersiz kimlik (ID) değeri.
minimumLimitBelirlenen en düşük satın alma limiti.
maximumLimitBelirlenen en yüksek satın alma limiti.
statusSatın alma limitinin aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.
createdAtSatın alma limiti nesnesinin oluşturulma tarihi.
updatedAtSatın alma limiti nesnesinin güncellenme tarihi.
PromotionToCategorySummary
Promotion nesnesi (özet). Tüm alanlar için Promotion şemasına bakın.
Category nesnesi (özet). Tüm alanlar için Category şemasına bakın.
idPromotionToBrandSummary
Promotion nesnesi (özet). Tüm alanlar için Promotion şemasına bakın.
Brand nesnesi (özet). Tüm alanlar için Brand şemasına bakın.
idPromotionPriceRangeSummary
idPromotion nesnesi (özet). Tüm alanlar için Promotion şemasına bakın.
fromQtyBaşlangıç adeti
toQtyBitiş adeti (fromQty'den büyük olmalı)
discountAmountİndirim miktarı (₺ veya %)
statuscreatedAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
PromotionSummary
namePromosyon adı.
idPromosyon nesnesi kimlik değeri.
startDatePromosyon başlangıç tarihi.
endDateuseDateFilterTarih aralığı özelliği kullanılsın mı?
usageLimittimesUsedconditionsfreeShippingÜcretsiz kargo durumu.
applyToDiscountProductİndirimli ürünlerde geçerli olsun mu?
minimumCheckoutLimitKullanım alışveriş sınırı.
baseCategoryIdbaseCategoryTreebaseBrandIdbaseProductspromotionValidityControlPromosyon geçerlilik kontrolü.
minimumPurchaseQuantitymembersIdmemberGroupIddescriptionPromosyon açıklaması.
urlurlBlankStatusimageFileattachmentpromotionFeatureTypePromosyon özelliği tipi.
promotionFeatureValuePromosyon özelliğine ait promosyon miktarı.
promotionalProductsPromosyonlu ürün nesnesi listesi
promotionalProductQuantityPromosyonlu ürün miktarı.
useLabelstatusPromosyon aktiflik durumu.
campaignPageStatussortOrdercreatedAtPromosyon nesnesinin oluşturulma zamanı.
updatedAtPromosyon nesnesinin güncellenme zamanı.
ProductToCountDownSummary
useCountDownGeri sayımın aktiflik durumu bilgisini belirtir. ( 0=Pasif, 1=Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.
idÜrün geri sayım bağı nesnesine ait benzersiz kimlik (ID) değeridir.
startDateGeri sayımın başlangıç tarihi.
endDateGeri sayımın bitiş tarihi.
expireDateGeri sayımın ürün için geçersiz olma tarihi.
Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.
ProductToCollectionSummary
Collection nesnesi (özet). Tüm alanlar için Collection şemasına bakın.
idsortOrderÜrün detay objesi — product nesnesi (özet). Tüm alanlar için product şemasına bakın.
ProductToCategorySummary
Category nesnesi (özet). Tüm alanlar için Category şemasına bakın.
idÜrün kategori bağı nesnesine ait benzersiz kimlik (ID) değeri.
sortOrderÜrün kategori bağının sıralama değeri. Bu değer, ürünün kategori içindeki görüntülenme sırasını belirler. Eğer vitrin sırası belirlenmek istenmiyorsa null atanabilir.
Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.
ProductPriceSummary
valueÜrünün fiyat değeri
typeFiyat tipi (alternatif fiyat seçenekleri)
idÜrün fiyatı için benzersiz kimlik
Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.
ProductImageSummary
filename^[a-z0-9-]+$ · requiredDosya adı (uzantısız)
extensionDosya uzantısı
sortOrderGörsel sırası (1-8 arası, 1 ana görsel)
idGörsel için benzersiz kimlik
directoryNamerevisionProduct nesnesi (özet). Tüm alanlar için Product şemasına bakın.
attachment^data:image\/(jpeg|j…Base64 encoded görsel verisi (sadece POST işlemlerinde kullanılır)
altProductExtraFieldSummary
varKeyidÜrün detay objesi — product nesnesi (özet). Tüm alanlar için product şemasına bakın.
varValueProductDetailSummary
detailsDetay bilgisi.
idÜrün detayı nesnesi kimlik değeri.
skuÜrünün stok kodu.
extraDetailsÜrün ekstra detaylı bilgi.
Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.
ProductCommentImageSummary
filenameextensioniddirectoryNameproductComment nesnesi (özet). Tüm alanlar için productComment şemasına bakın.
attachmentProductSummary
idÜrün için benzersiz kimlik
nameÜrün adı
slug^[a-z0-9-]+$URL dostu benzersiz tanımlayıcı
fullNameTam ürün adı (varyantlar için ana ürün + varyant adı)
skuStok kodu (benzersiz)
barcode^[0-9]{8,14}$Ürün barkodu
price1Ana satış fiyatı (Fiyat 1)
warrantyGaranti süresi (ay)
taxKDV oranı (%)
stockAmountMevcut stok miktarı
volumetricWeightDesi (hacimsel ağırlık)
buyingPriceAlış fiyatı
stockTypeLabelStok birim tipi
discountİndirim değeri (tip'e göre ₺ veya %)
discountTypeİndirim tipi
moneyOrderDiscountHavale/EFT indirim yüzdesi
statusÜrün aktiflik durumu
taxIncludedFiyatlara KDV dahil mi?
distributorTedarikçi adı
isGiftedgiftHediye açıklaması
customShippingDisabledÖzel kargo ücreti kullanılsın mı?
customShippingCostÖzel kargo ücreti (customShippingDisabled=0 ise)
marketPriceDetailPiyasa fiyatı açıklaması
createdAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
midblockSortOrderVitrin blokları sırası
metaKeywordsSEO meta anahtar kelimeler
metaDescriptionSEO meta açıklama
pageTitleSEO sayfa başlığı
hasOptionVaryant var mı? (sistem otomatik atar)
shortDetailsKısa ürün açıklaması
searchKeywordsArama anahtar kelimeleri (virgülle ayrılmış)
installmentThresholdMaksimum taksit sayısı ('-' = limit yok)
homeSortOrderAnasayfa vitrini sırası (null = vitrin dışı)
popularSortOrderPopüler ürünler vitrini sırası
brandSortOrderMarka vitrini sırası
featuredSortOrderSponsor ürünler vitrini sırası
campaignedSortOrderKampanyalı ürünler vitrini sırası
newSortOrderYeni ürünler vitrini sırası
discountedSortOrderİndirimli ürünler vitrini sırası
Brand nesnesi (özet). Tüm alanlar için Brand şemasına bakın.
Vitrin bloğu objesi — midblock nesnesi (özet). Tüm alanlar için midblock şemasına bakın.
Currency nesnesi (özet). Tüm alanlar için Currency şemasına bakın.
Ana ürün objesi (varyantlar için)
ProductToCountDown nesnesi (özet). Tüm alanlar için ProductToCountDown şemasına bakın.
DigitalProduct nesnesi (özet). Tüm alanlar için DigitalProduct şemasına bakın.
targetKeywordPaymentTypeSummary
nameÖdeme tipinin adı.
idÖdeme tipi nesnesi kimlik değeri.
sortOrderÖdeme tipinin sıralama değeri.
PaymentProviderSettingSummary
varKeyÖdeme altyapısı sağlayıcısı ayarı nesnesi için değişken anahtarı.
varValueÖdeme altyapısı sağlayıcısı ayarı nesnesi için değişken değeri.
idÖdeme sağlayıcı ayarına ait benzersiz kimlik numarası.
paymentProvider nesnesi (özet). Tüm alanlar için paymentProvider şemasına bakın.
PaymentProviderSummary
idÖdeme altyapısı sağlayıcısı nesnesine ait benzersiz kimlik (ID) değeri.
codeÖdeme altyapısı sağlayıcısı için ön tanımlanmış kod değeri.
nameÖdeme altyapısı sağlayıcısı için isim değeri.
statusÖdeme altyapısı sağlayıcısının aktif veya pasif olup olmadığı bilgisini tutar.(0 = pasif, 1 = aktif)
PaymentType nesnesi (özet). Tüm alanlar için PaymentType şemasına bakın.
PaymentGatewaySettingSummary
varKeyvarValueidÖdeme kanalı ayarı nesnesi kimlik değeri.
paymentGateway nesnesi (özet). Tüm alanlar için paymentGateway şemasına bakın.
PaymentGatewaySummary
codeÖdeme kanalı için sistemde ön tanımlı kod değeri.
nameÖdeme kanalı ismi.
idÖdeme kanalı nesnesinin benzersiz kimlik değeri.
statusÖdeme kanalının aktiflik durumu. Seçenekler: | active: Ödeme kanalı aktif. | passive: Ödeme kanalı pasif.
sortOrderÖdeme kanalının listelerdeki sıralama değeri.
createdAtÖdeme kanalı nesnesinin oluşturulma zamanı.
updatedAtÖdeme kanalı nesnesinin güncellenme zamanı.
legacyTableNamelegacyTableIdPaymentProvider nesnesi (özet). Tüm alanlar için PaymentProvider şemasına bakın.
PaymentBddkCategorySummary
PaymentProvider nesnesi (özet). Tüm alanlar için PaymentProvider şemasına bakın.
bddkCategoryNameidinstallmentextraFieldOrdersSummary
idSiparişe ait benzersiz kimlik (ID) değeridir.
customerFirstnameMüşterinin adı.
customerSurnameMüşterinin soyadı.
customerEmailMüşterinin e-mail adresi.
customerPhoneMüşterinin telefon numarası.
paymentTypeNameSiparişin ödeme tipi.
paymentProviderCodeSiparişin ödeme altyapısı sağlayıcısının sistemdeki kod değeri. Ön tanımlıdır. API otomatik oluşturur.
paymentProviderNameSiparişin ödeme altyapısı sağlayıcısının adı. Ön tanımlıdır. API otomatik oluşturur.
paymentGatewayCodeSiparişin ödeme kanalının kodu. Ön tanımlıdır. API otomatik oluşturur.
paymentGatewayNameSiparişin ödeme kanalının adı. Ön tanımlıdır. API otomatik oluşturur.
bankNameSipariş sırasında seçilen veya kullanılan banka adı. Ön tanımlıdır. API otomatik oluşturur.
cardHolderNameclientIpSiparişi oluşturan müşterinin IP adresi.
userAgentSiparişin oluşturulduğu cihaz/tarayıcı bilgisi.
currencySiparişte kullanılan kur(para birimi) kodu.
currencyRatesİlgili para birimleri ve alış/satış oranlarını içeren nesne, kur oranları.
amountSiparişin vergi hariç ara toplam tutarı.
couponDiscountSiparişte kullanılan hediye çeki indirimi tutarı.
taxAmountSiparişin için hesaplanan toplam vergi tutarı.
promotionDiscountSiparişte kullanılan promosyon indirimi tutarı.
generalAmountSiparişin genel toplam fiyat tutarı. orderAmount, couponDiscount, taxAmount, promotionDiscount, shippingAmount, additionalServiceAmount tutarlarının toplamı.
shippingAmountSipariş için tahsil edilen kargo/teslimat ücreti.
additionalServiceAmountSiparişe ait ek hizmet ücretlerinin toplamı.
finalAmountSiparişin son ödeme tutarı. (generalAmount üzerine taksit/vade farkı eklendiyse dahil edilmiş hali).
sumOfGainedPointsSiparişten müşterinin kazanacağı toplam puan miktarı.
installmentSipariş için seçilen taksit sayısı.
installmentRateSiparişin taksit oranı.
extraInstallmentSipariş için seçilen ek taksit sayısı.
transactionIdSipariş numarası.
hasUserNoteSiparişin müşteri notu içerip içermediğini belirtir. (0 = Yok, 1 = Var) Seçenekler: | 0: Sipariş müşteri notuna sahip değil. | 1: Sipariş müşteri notuna sahip.
statusSiparişin genel durumu. Seçenekler: | deleted: Silindi | waiting_for_approval: Onay Bekliyor | approved: Onaylandı | fulfilled: Kargoya Verildi | cancelled: İptal Edildi | delivered: Teslim Edildi | on_accumulation: Tedarik Sürecinde | waiting_for_payment: Ödeme Bekleniyor | being_prepared: Hazırlanıyor | refunded: İade Edildi | personal_status_1: Kişisel Sipariş Durumu 1 | personal_status_2: Kişisel Sipariş Durumu 2 | personal_status_3: Kişisel Sipariş Durumu 3
paymentStatusÖdeme işleminin sonucu/durumu. Seçenekler: | in_transaction: Sonuçlanmamış Ödemeler | failed: Hatalı Ödemeler | success: Başarılı
errorMessageSipariş ile ilgili hata mesajı (varsa).
sessionIddeviceTypeSiparişin gerçekleştiği cihaz bilgisi. Seçenekler: | desktop: Masaüstü | mobile: Mobil | tablet: Tablet
referrerSiparişe yönlendiren web sitesinin tam URL bilgisi. API otomatik oluşturur.
invoicePrintCountSipariş için alınan fatura çıktısı adedi.
useGiftPackageHediye paketi talebi durumu. (0 = İstemiyorum, 1 = İstiyorum) Seçenekler: | 0: Hediye paketi istemiyorum | 1: Hediye paketi istiyorum
giftNoteMüşterinin bıraktığı hediye notu (varsa).
giftAmountmemberGroupNameSipariş veren müşterinin üye grubunun adı.
usePromotionSiparişte promosyon kullanılıp kullanılmadığını belirtir. (0 = Hayır, 1 = Evet) Seçenekler: | 0: Promosyon kullanma | 1: Promosyon kullan
shippingProviderCodeSiparişin teslimat hizmeti sağlayıcısının kodu. Ön tanımlıdır. API otomatik oluşturur.
shippingProviderNameSiparişin teslimat hizmeti sağlayıcısının adı. Ön tanımlıdır.
shippingCompanyNameSiparişin kargo firmasının adı. Ön tanımlıdır.
shippingPaymentTypeSiparişin kargo ödemesinin tipi. Seçenekler: | cash_on_delivery: Alıcı Ödemeli | standart_delivery: Gönderici Ödemeli | not_applicable: Bu alan için geçerli değil.
shippingTrackingCodeSiparişin kargo takip kodu.
nebimTransferStatuspaidFromCurrentAccountsourceSiparişin geldiği kaynak bilgisi. Siparişin kaynak yazılımını belirtir.
createdAtSipariş kaydının oluşturulma tarihi.
updatedAtSipariş kaydının güncellenme tarihi.
orderDayMaillist nesnesi (özet). Tüm alanlar için Maillist şemasına bakın.
Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.
paymentGateway nesnesi (özet). Tüm alanlar için paymentGateway şemasına bakın.
paymentProvider nesnesi (özet). Tüm alanlar için paymentProvider şemasına bakın.
paymentType nesnesi (özet). Tüm alanlar için paymentType şemasına bakın.
promotion nesnesi (özet). Tüm alanlar için promotion şemasına bakın.
Kargo firması bilgilerini ve gönderim ayarlarını temsil eder. — shippingCompany nesnesi (özet). Tüm alanlar için shippingCompany şemasına bakın.
Kargo sağlayıcısı nesnesi — shippingProvider nesnesi (özet). Tüm alanlar için shippingProvider şemasına bakın.
ShippingAddress nesnesi (özet). Tüm alanlar için ShippingAddress şemasına bakın.
BillingAddress nesnesi (özet). Tüm alanlar için BillingAddress şemasına bakın.
autoPaybackOrderRefundRequestSummary
idSipariş iptal talebi nesnesi kimlik değeri.
codeSipariş iptal talebi için oluşturulan benzersiz kod değeri.
statusSipariş iptal talebinin durumu. Seçenekler: | approved: Onaylandı. | waiting_for_approval: Onay bekliyor. | cancelled: İptal edildi.
feeMüşteriye ödenecek tutar bilgisi.
shippingFeeKargo tutarı.
autoPaybackOtomatik geri ödeme durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
cancellationReasonSipariş iptal talebinin sebebine dair detaylı açıklama.
createdAtSipariş iptal talebi nesnesinin oluşturulma zamanı.
updatedAtSipariş iptal talebi nesnesinin güncellenme zamanı.
Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.
Orders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.
OrderItemSubscriptionSummary
idSipariş kalemi aboneliğine ait benzersiz kimlik numarası.
chosenPeriodchosenDispatchCountorderItem nesnesi (özet). Tüm alanlar için orderItem şemasına bakın.
subscription nesnesi (özet). Tüm alanlar için subscription şemasına bakın.
OrderItemCustomizationSummary
idÖzelleştirme için benzersiz kimlik
productCustomizationGroupIdÜrün özelleştirme grubu kimliği
productCustomizationGroupNameÖzelleştirme grup adı
productCustomizationGroupSortOrderGrup sıralama değeri
productCustomizationFieldIdÖzelleştirme alanı kimliği
productCustomizationFieldTypeAlan tipi
productCustomizationFieldNameAlan adı
productCustomizationFieldSortOrderproductCustomizationFieldValueMüşterinin girdiği değer
cartItemAttributeIdİlişkili sepet kalemi özellik kimliği
isCloudFileDosyanın bulut depolama kullanıp kullanmadığı
cloudContentUrlBulut depolama dosya URL'i
createdAtupdatedAtorderItem nesnesi (özet). Tüm alanlar için orderItem şemasına bakın.
OrderItemSummary
idSipariş kaleminin benzersiz kimlik (ID) değeri.
productNameSiparişteki ürünün adı.
productSkuÜrünün stok kodu (SKU).
productBarcodeÜrünün barkod numarası.
productPriceÜrünün birim fiyatı.
productCurrencyÜrünün fiyatının para birimi. Seçenekler: | USD: Amerikan Doları | EUR: Euro | TL: Türk Lirası | GBP: İngiliz Sterlini | JPY: Japon Yeni | CNY: Çin Yuanı | GR: Yunan Drahmisi (tarihi kullanım) | CHF: İsviçre Frangı
productQuantitySiparişteki ürün adedi (stok tipi cinsinden).
productTaxÜrünün vergi oranı (yüzde cinsinden).
productDiscountÜrüne uygulanan standart indirim miktarı.
productMoneyOrderDiscountHavale/EFT ile ödemede uygulanan indirim miktarı.
productWeightÜrünün ağırlığı (kg veya ilgili stok tipi birimi).
productStockTypeLabelÜrünün stok tipi etiketi (ör. adet, kg, paket).
isProductPromotionedÜrünün promosyon olup olmadığını belirten değer. Seçenekler: | 0: Ürün promosyon değil | 1: Ürün promosyon
discountÜrüne uygulanan hediye çeki indirim değeri.
maxInstallmentpriceRatiocreatedAtupdatedAtOrders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.
Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.
DigitalProduct nesnesi (özet). Tüm alanlar için DigitalProduct şemasına bakın.
OrderItemSubscription nesnesi (özet). Tüm alanlar için OrderItemSubscription şemasına bakın.
OrderDetailSummary
varKeySipariş detayı için değişken anahtarı (örn. ödeme veya teslimat bilgisi)
varValueDeğişkene ait değer, genellikle JSON formatında detaylı bilgi içerir
idSipariş detayı nesnesinin kimlik değeri
Orders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.
OptionsSummary
titleVaryant değeri adı (Kırmızı, L, 42 vb.)
idVaryant seçeneği için benzersiz kimlik
slugsortOrderGörüntüleme sırası
logo^[a-zA-Z0-9-_]+\.(jp…Varyant görseli dosya adı (uzantı ile birlikte)
OptionGroup nesnesi (özet). Tüm alanlar için OptionGroup şemasına bakın.
attachment^data:image\/(jpeg|j…Base64 encoded görsel verisi (POST/PUT için)
sizeupdatedAtcreatedAtOptionGroupSummary
titleVaryant grubu başlığı
idVaryant grubu için benzersiz kimlik
slugURL dostu benzersiz tanımlayıcı
sortOrderGörüntüleme sırası
predefinedSistem öntanımlı mı?
filterStatusFiltre menüsünde göster
aggregatorFiltre menüde gruplanma durumu
MemberGroupSummary
nameÜye grubu ismi
idÜye grubu nesnesinin kimlik değeri
priceIndexÜye grubunun fiyat indeksi (örn. Fiyat 2 için 1)
priceRatioÜye grubunun fiyat indeksi ile çarpanı
allowedPaymentGatewaysMemberDetailSummary
varKeyvarValueidÜye hesap bilgilerini içeren obje — member nesnesi (özet). Tüm alanlar için member şemasına bakın.
createdAtupdatedAtMemberAddressSummary
idAdres için benzersiz kimlik
nameAdres tanımlayıcı adı
typeAdres tipi
firstnameAdı
surnameSoyadı
addressDetaylı adres bilgisi
locationNameŞehir adı
subLocationNameİlçe adı
phoneNumberSabit telefon numarası
mobilePhoneNumberCep telefonu numarası
tcId^[0-9]{11}$TC kimlik numarası
taxNumber^[0-9]{10}$Vergi numarası (kurumsal faturalar için)
taxOfficeVergi dairesi (kurumsal faturalar için)
invoiceTypeFatura tipi
isEinvoiceUserE-fatura kullanıcısı mı?
zipCodecreatedAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.
Country nesnesi (özet). Tüm alanlar için Country şemasına bakın.
Location nesnesi (özet). Tüm alanlar için Location şemasına bakın.
Town nesnesi (özet). Tüm alanlar için Town şemasına bakın.
MemberSummary
idÜye için benzersiz kimlik
firstnameÜyenin adı
surnameÜyenin soyadı
emailÜyenin e-posta adresi
genderCinsiyet bilgisi
birthDateDoğum tarihi
phoneNumberSabit telefon numarası
mobilePhoneNumberCep telefonu numarası
otherLocationAlternatif şehir bilgisi
addressAdres bilgisi
taxNumberVergi numarası
tcId^[0-9]{11}$TC kimlik numarası
passwordÜye hesap şifresi (şifrelenmiş)
activationCodestatusÜye hesap durumu
lastLoginDateSon giriş yapılan tarih ve zaman
createdAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
zipCodePosta kodu
commercialNameKurumsal üyelik için şirket adı
taxOfficeVergi dairesi
lastMailSentDateSon e-posta gönderim tarihi
lastIpSon giriş yapılan IP adresi
gainedPointAmountspentPointAmountallowedToPhoneTelefon ile iletişim izni
allowedToCampaignsKampanya bildirimleri için izin
allowedToSmsSMS bildirimleri için izin
allowedToPhoneUpdatedAtTelefon izni son güncellenme zamanı
allowedToCampaignsUpdatedAtKampanya izni son güncellenme zamanı
allowedToSmsUpdatedAtSMS izni son güncellenme zamanı
referredMemberGainedPointAmountdistrictİlçe bilgisi
deviceTypeÜyelik oluştururken kullanılan cihaz tipi
deviceInfoDetaylı cihaz bilgisi (user agent)
Country nesnesi (özet). Tüm alanlar için Country şemasına bakın.
Location nesnesi (özet). Tüm alanlar için Location şemasına bakın.
locationNameŞehir adı
MemberGroup nesnesi (özet). Tüm alanlar için MemberGroup şemasına bakın.
Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.
kvkkStatusKVKK (kişisel verilerin korunması) onay durumu
kvkkConfirmationDateconfirmationTokenconfirmationTokenExpirationDateMaillistGroupSummary
nameMail listesi grubunun adı.
idMail listesi grubunun benzersiz kimlik değeri.
MaillistSummary
nameMail listesi nesnesinin adı.
emailMail adresi.
MaillistGroup nesnesi (özet). Tüm alanlar için MaillistGroup şemasına bakın.
idMail listesi nesnesinin benzersiz kimlik değeri.
lastMailSentDateSon gönderim tarihi.
creatorIpAddressMail listesini oluşturan kullanıcının IP adresi.
createdAtMail listesi nesnesinin oluşturulma zamanı.
updatedAtMail listesi nesnesinin güncellenme zamanı.
LocationSummary
idŞehir nesnesine ait benzersiz kimlik numarası.
nameŞehir nesnesi için isim değeri.
statusŞehir nesnesinin aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.
predefinedcreatedAtupdatedAtCountry nesnesi (özet). Tüm alanlar için Country şemasına bakın.
Region nesnesi (özet). Tüm alanlar için Region şemasına bakın.
LabelSummary
idKişisel etiket nesnesine ait benzersiz kimlik numarası.
nameKişisel etiket Adı
sortOrderKişisel etiket nesnesi için sıralama değeri.
hasChildrenKişisel etiket nesnesinin alt etiket barındırma durumu. Bu değer otomatik oluşturulur.
slugEtiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.
metaTitlemetaKeywordsArama motorları tarafından tespit edilebilecek anahtar kelimeler.
metaDescriptionstatusEtiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.
rootlevelleftIndexrightIndexLabel nesnesi (özet). Tüm alanlar için Label şemasına bakın.
createdAtKişisel etiket nesnesinin oluşturulma zamanı.
updatedAtKişisel etiket nesnesinin son güncellenme zamanı.
ExtraInfoSummary
idEk bilgi için benzersiz kimlik
nameEk bilgi alanı adı
sortOrderGörüntüleme sırası (küçükten büyüğe)
DistributorSummary
nameTedarikçi şirket adı
idTedarikçi için benzersiz kimlik
emailTedarikçi iletişim e-posta adresi
phoneTedarikçi telefon numarası
contactPersonYetkili kişi adı soyadı
createdAtupdatedAtDigitalProductSummary
idÜrün detay objesi — product nesnesi (özet). Tüm alanlar için product şemasına bakın.
deletedAtCurrencySummary
idKur kimlik değeri.
labelKur etiketi.
buyingPriceKur alış fiyatı.
sellingPriceKur satış fiyatı.
abbrKur kısaltması.
updatedAtKurun güncellenme zamanı.
statusKur aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
permissionStatusKur kullanım izni durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
isPrimaryKurun birincil kur olup olmadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
isEffectiveKurun efektif kur olarak kullanılıp kullanılmadığı. Seçenekler: | 0: Pasif. | 1: Aktif.
isExtraCouponSummary
idHediye çeki nesnesinin benzersiz kimlik değeri.
codeHediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.
maxUsageHediye çekinin toplam kullanım limiti.
currentUsageHediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.
maxUsagePerMemberBir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.
memberGroupIdstartDateHediye çekinin geçerli olmaya başladığı tarih.
expireDateminimumUsageLimitcreatedAtHediye çekinin oluşturulma zamanı.
createrTypecreaterIdvalueTypevalueEffectproductsKuponun geçerli olduğu ürün nesneleri.
categoriesKuponun geçerli olduğu kategori nesneleri.
statusHediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
cargoFreeKuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
useDiscountProductsbrandsKuponun geçerli olduğu marka nesneleri.
membersKuponun geçerli olduğu üye nesneleri.
isEffectiveSpecialTokentaxIncludedminimumUsageLimitTaxIncludedupdatedAtHediye çekinin son güncellenme zamanı.
CountrySummary
idÜlke nesnesinin benzersiz kimlik (ID) değeri.
nameÜlkenin adı.
codeISO 3166-1 alpha-2 ülke kodu (2 harfli).
statusÜlkenin aktiflik durumu. Seçenekler: | 0: Devre dışı (ülke kullanılmaz) | 1: Etkin (ülke kullanılabilir)
exportStatusextraShippingPriceselectedLanguageselectedCurrencyphoneCodeCollectionSummary
nameidslugstatussortOrderdisplayShowcaseContentshowcaseContentshowcaseContentDisplayTypedisplayShowcaseFooterContentshowcaseFooterContentshowcaseFooterContentDisplayTypepageTitlemetaKeywordsmetaDescriptioncanonicalUrlcreatedAtupdatedAtCategorySummary
idKategoriye ait benzersiz kimlik numarası. Sistem tarafından otomatik oluşturulur.
nameKategori nesnesi için isim değeri.
slugSlug değeri ilgili nesnenin Url değeridir.
sortOrderKategori nesnesi için sıralama değeri.
statusKategorinin aktiflik durumunu belirtir. Seçenekler: | 0: Pasif — kategori yayınlanmaz. | 1: Aktif — kategori mağazada görünür.
distributorCodeHer zaman null değer alır. Pratikte kullanımı yoktur.
percentKategori nesnesinin fiyat katsayısı.
imageFileKategori nesnesinin görselinin dosya adı. Geçerli dosya tipleri: .JPG, .PNG, .GIF
distributorHer zaman null değer alır. Pratikte kullanımı yoktur.
displayShowcaseContentKategori üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.
showcaseContentKategori nesnesinin üst içeriği. Admin paneli üzerinden düzenlenebilir.
showcaseContentDisplayTypeKategori nesnesinin üst içerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve üst kategorilere ait içerik. | 3: Bu kategori ve tüm üst kategorilere ait içerik.
displayShowcaseFooterContentKategori Alt İçerik nesnesinin üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.
showcaseFooterContentKategori nesnesinin alt içeriği. Admin paneli üzerinden düzenlenebilir.
showcaseFooterContentDisplayTypeKategori Alt İçerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve alt kategorilere ait içerik. | 3: Bu kategori ve tüm alt kategorilere ait içerik.
hasChildrenKategorinin alt kategorilere sahip olup olmadığını belirtir. Seçenekler: | 0: Var | 1: Yok
metaKeywordsArama motorları tarafından tespit edilebilecek anahtar kelimeler.
metaDescriptionArama motorları tarafından tespit edilebilecek açıklama yazısı.
canonicalUrlİlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-değeri" /> HTML etiketinin girdiginiz-canonical-url alanı yazan yere gelmesini istediğiniz değer. Mağaza domaininizin olduğu kısım değiştirilemez, sistem tarafından otomatik eklenir..
pageTitleSayfanın arama motorları tarafından tespit edilebilecek başlık yazısı.
leftIndexlevelrightIndexrootCategory nesnesi (özet). Tüm alanlar için Category şemasına bakın.
attachmentattachment
isCombineKategori nesnesi kombin kategori durumu.Bu kategori kombin kategorisi olarak işaretlendiğinde kategori altındaki ürünler kombin detay sayfasına yönlendirilecektir. Seçenekler: | 0: Kombin Kategori | 1: Kombin Kategori değil
isSearchablecreatedAtKategorinin oluşturulma zamanı (ISO 8601 formatında).
updatedAtKategorinin son güncellenme zamanı (ISO 8601 formatında).
targetKeywordCartItemSummary
quantityBu ürünün sepetteki adedi.
Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.
idSepet kaleminin benzersiz kimlik değeri.
parentProductIdcategoryIdisDigitalProductcreatedAtSepet kaleminin oluşturulma zamanı.
updatedAtSepet kaleminin son güncellenme zamanı.
Cart nesnesi (özet). Tüm alanlar için Cart şemasına bakın.
Sepet kalemi abonelik bilgisi objesi — cartItemSubscription nesnesi (özet). Tüm alanlar için cartItemSubscription şemasına bakın.
CartSummary
idSepet kimlik değeri
sessionIdSepet oturum kimliği
lockedlockedAtcreatedAtupdatedAtPromotion nesnesi (özet). Tüm alanlar için Promotion şemasına bakın.
Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.
Coupon nesnesi (özet). Tüm alanlar için Coupon şemasına bakın.
BrandSummary
nameMarka adı
idMarka için benzersiz kimlik
slugsortOrderGörüntüleme sırası
statusMarka aktiflik durumu
distributorCodeTedarikçi kodu
distributorTedarikçi adı
imageFileMarka logo dosya adı (JPG, PNG, GIF)
showcaseContentMarka sayfası üst içerik metni (HTML)
displayShowcaseContentÜst içerik gösterim durumu
showcaseFooterContentdisplayShowcaseFooterContentmetaKeywordsSEO meta anahtar kelimeler
metaDescriptionSEO meta açıklama
canonicalUrl^[a-z0-9-/]+$Canonical URL (domain hariç)
pageTitleSEO sayfa başlığı
attachment^data:image\/(jpeg|j…Base64 encoded logo verisi (POST/PUT için)
isSearchablecreatedAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
targetKeywordBillingAddressSummary
firstnameMüşterinin ismi.
surnameMüşterinin soy ismi.
countryMüşterinin ülke bilgisi.
locationMüşterinin şehir bilgisi.
addressMüşterinin adres bilgisi.
mobilePhoneNumberMüşterinin mobil telefon numarası.
idFatura adresi nesnesi kimlik değeri.
subLocationMüşterinin ilçe bilgisi.
phoneNumberMüşterinin telefon numarası.
zipCodecreatedAtupdatedAtOrders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.
invoiceTypeFatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.
taxNoFatura için vergi numarası.
taxOfficeFatura için vergi dairesi.
identityRegistrationNumberMüşterinin T.C. Kimlik numarası.