İçeriğe geç
Admin API

SeoDetail

pageTitle
​string · maxLength: 300 · required

Sayfa başlığı.

Example: Sayfa 1
metaKeywords
​string · maxLength: 800 · required

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 800 · required

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
useAdvancedSeoOption
​integer · enum

Gelişmiş SEO ayarlarının kullanımı Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
changeFreq
​string · enum

Sayfanın değişim sıklığı. Seçenekler: | daily: Günlük. | hourly: Saatlik. | weekly: Haftalık. | yearly: Yıllık. | monthly: Aylık. | always: Her zaman. | never: Hiçbir zaman.

Enum values:
daily
hourly
weekly
yearly
monthly
always
never
Example: weekly
priority
​string · enum

Öncelik değeri Seçenekler: | 0: 0 | 1: 1 | 0.1: 0.1 | 0.2: 0.2 | 0.3: 0.3 | 0.4: 0.4 | 0.5: 0.5 | 0.6: 0.6 | 0.7: 0.7 | 0.8: 0.8 | 0.9: 0.9

Enum values:
0
0.1
0.2
0.3
0.3
0.4
0.5
0.6

Whatsapp

Whatsapp sipariş sistemi ayarlarını temsil eder.
status
​integer · enum

WhatsApp sipariş sisteminin aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
phoneNumber
​string · minLength: 7 · maxLength: 32

WhatsApp üzerinden mesajların gönderileceği telefon numarası.

message
​string

Mesaj

position
​string · enum

WhatsApp widget’ının sayfa üzerinde gösterileceği konum.

Enum values:
sağ
sol
Example: sol
showInHomepage
​integer · enum

WhatsApp widget’ının anasayfada gösterilip gösterilmeyeceği (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1

Watermark

status
​integer · enum

Filigran kullanım durumu. Ürün görsellerine filigran uygulanabilmesi için Görsel Optimizasyonu ayarının açık olması gerekir. 0 = Pasif, 1 = Aktif

Enum values:
0
1
Example: 1
type
​string · enum

Filigran tipi. Metin veya görsel olarak uygulanabilir. Bu ayar aktif edilmeden önce yüklenen ürünler etkilenmez. text = Metin, image = Görsel

Enum values:
text
image
Example: text
text
​string

Filigran olarak kullanılacak yazı.

Example: Örnek Filigran
textRotation
​string · enum

Filigran yazısının eğim değeri. centered_horizontal = Ortalanmış yatay, cross = Çapraz

Enum values:
centered_horizontal
cross
Example: cross
textOpacity
​string · enum

Filigran yazısının şeffaflık değeri. less = Az belirgin, normal = Normal, much = Çok belirgin

Enum values:
less
normal
much
Example: normal
textColor
​string · enum

Filigran yazısının rengi. black = Siyah, white = Beyaz

Enum values:
black
white
Example: white
imageRotation
​string · enum

Filigran görselinin eğim değeri. cross = Çapraz, straight = Ortalanmış yatay

Enum values:
cross
straight
Example: cross
imageLocation
​string · enum

Filigran görselinin konumu. left_top = Sol üst, right_top = Sağ üst, left_bottom = Sol alt, right_bottom = Sağ alt, middle = Orta

Enum values:
left_top
right_top
left_bottom
right_bottom
middle
Example: right_bottom
imageOpacity
​string · enum

Filigran görselinin şeffaflık değeri. less = Az belirgin, normal = Normal, much = Çok belirgin, full = Tam belirgin

Enum values:
less
normal
much
full
Example: normal
imageUrl
​string

Uygulanacak filigran resminin URL'si.

Example: https://example.com/watermark.png
attachment
​string · writeOnly

Uygulanacak filigran resmi dosyası.

Example: watermark.png

OrderRefund

Sipariş iade bilgisi objesi
dayLimit
​integer · min: 0 · required

İade için gün limiti

Example: 14
dateOption
​string · enum · required
Enum values:
order_date
delivery_date
status
​integer · enum

İade durumu

Enum values:
0
1
Example: 0

MercanSuperApp

status
​integer · enum
Enum values:
0
1
clientId
​string
clientSecret
​string
returnUrl
​string

GiftPackage

status
​integer · enum
Enum values:
0
1
type
​string · enum
Enum values:
free
paid
price
​number · float
imageUrl
​string
attachment
​string · writeOnly

FacebookMessenger

status
​integer · enum

Facebook Messenger kullanım durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
facebookPage
​string

Facebook sayfası bağlantısı.

showInHomepage
​integer · enum

Ana sayfada gösterim durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
position
​string · enum

Messenger bileşeninin sayfadaki pozisyonu. Seçenekler: | right: Sağ. | left: Sol.

Enum values:
right
left

CriticalStock

quantity
​integer · min: 0 · required

Kritik stok seviyesi; bu miktarın altına düşerse stok uyarısı tetiklenir.

Example: 5
status
​integer · enum

Kritik stok kontrolünün aktif olup olmadığını belirtir. Seçenekler: | 0: Kritik stok pasif; uyarılar gönderilmez. | 1: Kritik stok aktif; belirlenen miktar altında uyarı oluşturulur.

Enum values:
0
1
Example: 1
email
​string

SubModel-ExtraPref-AbandonedCart

firstDeliveryTime
​integer · enum · required
Enum values:
20
30
45
60
180
360
1440
status
​integer · enum
Enum values:
0
1

SignupPreference

varKey
​string · enum
Enum values:
use_gender
use_gender_required
use_repeat_password
use_repeat_password_required
use_cell_phone
use_cell_phone_required
member_signup_birthday_field
member_signup_birthday_field_required
varValue
​integer · enum
Enum values:
0
1

Creator

Nesneyi oluşturan kullanıcıyı temsil eder.
id
​integer · required

Oluşturan kişinin benzersiz kimlik numarası.

Example: 123
username
​string

Oluşturan kişinin kullanıcı adı veya sistemde görünen adı.

type
​string · enum

Oluşturan kişinin tipi (üye veya kullanıcı).

Enum values:
user
member
Example: user
align
​string · enum · required

Logonun sayfa üzerindeki hizalama konumu. Seçenekler: | left: Sol | middle: Orta | right: Sağ

Enum values:
left
middle
right
Example: middle
imageUrl
​string

Logo imajı dosyasının tam URL adresi.

Example: https://cdn.site.com/uploads/logo.png
attachment
​string · writeOnly

Logo dosyasına ait dosya bilgisi

align
​string · enum · required

Görselin yatay hizalaması. Seçenekler: | left: Sol | middle: Orta | right: Sağ

Enum values:
left
middle
right
imageUrl
​string

Sayfa alt kısmında gösterilecek görselin URL değeri.

Example: https://www.magaza-adiniz.com/uploads/footer-banner.png
attachment
​string · writeOnly

Görselin sayfaya eklenme biçimi (örn. arka plan resmi).

Example: fixed

SubModel-CheckoutDesignPref-Banner

align
​string · enum · required
Enum values:
left
middle
right
imageUrl
​string
attachment
​string · writeOnly

UserRolePermission

Kullanıcı rolüne ait izinleri temsil eder. Her rol için hangi işlemlere izin verildiğini belirler.
name
​string · maxLength: 255 · required

Kullanıcı rolü nesnesi ismi.

Example: product
createPermission
​integer · enum · required

Oluşturma işlemi için izin durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
readPermission
​integer · enum · required

Okuma işlemi için izin durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
updatePermission
​integer · enum · required

Güncelleme işlemi için izin durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
deletePermission
​integer · enum · required

Silme işlemi için izin durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Kullanıcı rolü izin kaydının benzersiz kimlik değeri.

Example: 101
​UserRoleSummary
createdAt
​string · date-time

Kullanıcı rolü izin kaydının oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Kullanıcı rolü izin kaydının son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

UserRole

name
​string · maxLength: 255 · required

Rol adı.

Example: Yönetici
id
​integer

Kullanıcı rolü nesnesi kimlik değeri.

Example: 12
predefined
​integer · enum

Değiştirilemez kullanıcı rolü durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1

Role ait izinler listesi.

userCount
​integer

Role sahip kullanıcı sayısı.

Example: 4
createdAt
​string · date-time

Kullanıcı rolü nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kullanıcı rolü nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

User

id
​integer

Kullanıcı nesnesinin benzersiz kimlik değeri.

Example: 123
firstname
​string · maxLength: 255

Kullanıcının adı.

Example: John
surname
​string · maxLength: 255

Kullanıcının soyadı.

Example: Doe
email
​string · email · maxLength: 255

Kullanıcının sisteme giriş ve bildirimler için kullandığı e-posta adresi.

Example: johndoe@ideasoft.com.tr
password
​string · maxLength: 255 · writeOnly · pattern: (?=.*[0-9])(?=.*[A-Z…

Kullanıcının kimlik doğrulamasında kullanılan şifre (hashlenmiş olarak saklanır).

username
​string · minLength: 4 · maxLength: 16

Sistemde kullanıcı adı olarak kullanılan benzersiz değer.

Example: yonetici
status
​integer · enum

Kullanı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ş.

Enum values:
0
1
2
Example: 1
createdAt
​string · date-time

Kullanıcı hesabının oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kullanıcı hesabında yapılan son güncellemenin zamanı.

Example: 2018-02-21T15:01:03+0300
isCustomerRepresentative
​integer · enum

Kullanıcının müşteri temsilcisi olup olmadığını belirtir. Seçenekler: | 0: Müşteri temsilcisi değil. | 1: Müşteri temsilcisi.

Enum values:
0
1
Example: 0
isOwner
​integer · enum
Enum values:
0
1
​MemberGroupSummary[]

Kullanıcının üye olduğu gruplar; yetki ve erişim seviyelerini etkiler.

​UserRoleSummary
mfaStatus
​integer · enum
Enum values:
0
1

UrlRouting

oldUrl
​string · minLength: 2 · maxLength: 250 · required

Yönlendirme yapılmadan önceki eski URL

newUrl
​string · minLength: 1 · maxLength: 250 · required

Yönlendirme yapılan yeni URL

id
​integer

URL yönlendirme nesnesinin kimlik değeri

updatedAt
​string · date-time

URL yönlendirme nesnesinin son güncellenme zamanı

Example: 2018-02-21T15:01:03+0300

TownGroup

name
​string · required

İlçe grubu nesnesinin adı.

Example: Standart İlçeler
id
​integer

İlçe grubu nesnesinin benzersiz kimlik değeri.

Example: 123
status
​integer · enum

İlçe grubunun aktiflik durumu. true = Aktif, false = Pasif

Enum values:
0
1
Example: true

Town

İlçe nesnesi
id
​integer · required

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · required

İlçe adı.

Example: Üsküdar
status
​integer · enum

İlçenin aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
​LocationSummary
​TownGroupSummary

Ticket

content
​string · minLength: 10 · required

Destek talebi içeriği.

status
​string · enum · maxLength: 8 · required

Destek talebi durumu. Seçenekler: | pending: Beklemede. | closed: Kapandı. | replied: Yanıtlandı.

Enum values:
pending
closed
replied
id
​integer

Destek talebi kimlik değeri.

subject
​string · maxLength: 255

Destek talebi başlığı.

code
​string · maxLength: 10

Destek talebi kodu.

​MemberSummary

Üye hesap bilgilerini içeren obje

updatedAt
​string · date-time

Destek talebi güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Destek talebi oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

Theme

platform
​string · enum · required

Temanı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..

Enum values:
desktop
mobile
Example: desktop
name
​string · maxLength: 255 · required

Temanın ismi.

Example: Chalcedon
status
​integer · enum · required

Temanın aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif). Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 0
version
​integer · enum · required

Tema versiyon numarasını belirtir. Seçenekler: | 1: 1 | 2: 2

Enum values:
2
id
​integer

Tema nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
type
​string · enum

Tema tipini belirtir. Seçenekler: | self: Kişisel olarak oluşturulan özel tema. | standard: Sistem tarafından sağlanan standart tema.

Enum values:
standard
self
Example: standard
preset
​string · maxLength: 255

Temaya ait varsayılan renk

Example:
directoryName
​string · maxLength: 255

Temanın bulunduğu dizin adı.

Example: tpl-chalcedon
attachment
​string · writeOnly

Temaya ait dosya ekini ifade eder.

packageGroup
​integer · enum
Enum values:
1
2
3
4
isCopyright
​integer · enum
Enum values:
0
1
createdAt
​string · date-time

Tema nesnesinin oluşturulma tarihi.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Tema nesnesinin güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300

Tag

SEO+ etiket nesnesi
id
​integer · required

SEO+ etiketi nesnesine ait benzersiz kimlik numarası

Example: 123
name
​string · maxLength: 255 · required

SEO+ etiketi nesnesi adı.

Example: ideasoft
slug
​string · maxLength: 255 · required
count
​integer · min: 0

SEO+ etiketinin kaç kez kullanıldığı bilgisi.

Example: 2
pageTitle
​string · maxLength: 255

SEO+ etiketi nesnesinin etiket başlığı.

Example: Kırmızı Kalem
metaDescription
​string

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye

TabbedMidblockProduct

Tablı vitrin bloğu ürün ilişki objesi
​ProductSummary · required

Ürün detay objesi

​TabbedMidblockSummary · required
sortOrder
​integer · min: 0 · max: 9999 · required

Ürünün blok içindeki sırası

Example: 1
id
​integer

İlişki için benzersiz kimlik

Example: 456

TabbedMidblock

id
​integer · required

Tablı vitrin blokları nesnesi kimlik değeri.

Example: 101
name
​string · maxLength: 255 · required

Blok adı.

Example: Yeni Ürünler
status
​integer · enum

Tablı vitrin bloğu aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
sortOrder
​integer · min: 0 · max: 99

Sıra numarası.

Example: 3
productCountPerRow
​integer · enum

Satırdaki ürün sayısı. Seçenekler: | 1: 1 | 2: 2 | 3: 3 | 4: 4 | 5: 5

Enum values:
1
2
3
4
5
rowCountPerPage
​integer · enum

Sayfadaki satır sayısı. Seçenekler: | 1: 1 | 2: 2 | 3: 3 | 4: 4 | 5: 5

Enum values:
1
2
3
4
5

SubscriptionProduct

​ProductSummary · required

Ürün detay objesi

​SubscriptionSummary · required
id
​integer

Abonelikli ürün nesnesi kimlik değeri.

Subscription

id
​integer · required

Abonelik nesnesi kimlik değeri

name
​string · maxLength: 255 · required

Abonelik nesnesi adı

periods
​string · maxLength: 255

Abonelik periyodu

periodFrequency
​string · enum

Abonelik periyodu sıklığı Seçenekler: | daily: Günlük | weekly: Haftalık | monthly: Aylık

Enum values:
daily
weekly
monthly
dispatchCounts
​string · maxLength: 255

Periyot içindeki sevk sayısı. Örneğin 30 günde bir en fazla 1, 2, 3 veya 4 defa abone olunabilir

Example: 1,2,3,4
continuousSending
​integer · enum

Sürekli gönderim. Kullanıcı abonelikten çıkmadığı sürece gönderim devam eder Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
description
​string

Açıklama

status
​string · enum

Abonelik nesnesi aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
active
passive
discount
​integer · min: 0

İndirim

shippingAmount
​number · float · min: 0

Kargo ücreti

createdAt
​string · date-time

Abonelik nesnesinin oluşturulma zamanı

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Abonelik nesnesinin güncellenme zamanı

Example: 2018-02-21T15:01:03+03:00

StockWarning

id
​integer · required

Stok bildirimi nesnesi kimlik değeri.

​MemberSummary · required

Üye hesap bilgilerini içeren obje

​ProductSummary · required

Ürün detay objesi

createdAt
​string · date-time

Stok bildirimi nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

SpecValue

id
​integer · required

Ürün özelliği değeri nesnesinin benzersiz kimlik (ID) değeri.

Example: 101
name
​string · maxLength: 255 · required

Özelliğe ait görünen ad.

Example: Kırmızı
sortOrder
​integer · min: 0 · max: 999 · required

Özellik değerinin listeleme sırası (artan olarak sıralanır).

Example: 1
slug
​string · minLength: 1 · maxLength: 255

Özellik için oluşturulmuş URL uyumlu kısa ad (slug).

Example: kirmizi
logo
​string

Özellik değerine ait logo dosyasının adı veya yolu.

Example: color_red.svg
status
​integer · enum

Ö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).

Enum values:
0
1
imageUrl
​string

Özellik değerine ait görselin tam URL bilgisi.

Example: https://cdn.site.com/spec/color/red.png
attachment
​string · writeOnly

Özellik değerine ait görsel dosyası (upload edilen ham dosya bilgisi).

size
​integer · enum · writeOnly

Özellik görseli/logosu için kullanılan boyut değeri (px). Seçenekler: | 16: 16px | 24: 24px | 32: 32px

Enum values:
16
24
32
​SpecNameSummary

Ürün özelliği nesnesi

​SpecGroupSummary

Ürün özellik grubu objesi

updatedAt
​string · date-time

Özellik değerinin son güncellenme tarihi (ISO 8601 formatında).

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Özellik değerinin oluşturulma tarihi (ISO 8601 formatında).

Example: 2018-02-21T09:36:03+0300

SpecName

Ürün özelliği nesnesi
id
​integer · required

Ürün özelliğine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 255 · required

Ürün özelliği adı.

Example: Kapasite
slug
​string · minLength: 1 · maxLength: 255

URL’de kullanılan özellik slug değeri.

Example: kapasite
choiceType
​string · enum

Özellik tipini belirtir.

Enum values:
singular
plural
Example: singular
sortOrder
​integer · min: 0 · max: 999

Ürün özelliği sıralaması.

Example: 999
status
​integer · enum

Ürün özelliği aktiflik durumunu belirtir (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
​SpecGroupSummary

Ürün özellik grubu objesi

​SpecValueSummary[]

specValues

SpecGroup

Ürün özellik grubu objesi
id
​integer · required

Özellik grubu için benzersiz kimlik

Example: 123
name
​string · maxLength: 255 · required

Özellik grubu adı

Example: Cep Telefonları
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası

Example: 999
status
​integer · enum

Grup aktiflik durumu

Enum values:
0
1
Example: 1
​SpecNameSummary[]

İlişkili özellik adları listesi

SmtpPref

SMTP sunucu yapılandırma ayarları
server
​string · required

SMTP sunucu adresi

Example: smtp.gmail.com
username
​string · required

SMTP kimlik doğrulama kullanıcı adı

Example: user@example.com
port
​integer · required

SMTP sunucu port numarası

Example: 587
password
​string · password · required

SMTP kimlik doğrulama şifresi

secure
​integer · enum · required

Güvenli bağlantı tipi

Enum values:
0
1
2
Example: 1
provider
​string · enum · required
Enum values:
tucows
uzmanposta
mailEngine
​string · enum · required

Kullanılacak mail motoru

Enum values:
ideasoft
other
Example: ideasoft
sender
​string · email

Gönderici e-posta adresi

Example: noreply@example.com

SliderSetting

sliderEffect
​string · enum · required

Slayt geçiş tipi. Seçenekler: | slide: Kaydırma efekti | fade: Kaybolma efekti

Enum values:
slide
fade
sliderWidth
​number · float · required

Slider genişliği (px).

sliderHeight
​number · float · required

Slider yüksekliği (px).

autoStartTime
​number · float · required

Resimlerin değişme süresi (milisaniye cinsinden).

effectTime
​number · float · required

Resmin görüntülenme süresi (milisaniye cinsinden).

autoStart
​integer · enum · required

Otomatik başlatma durumu. Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
definition
​integer · enum · required

Açıklama alanı gösterilsin. Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
definitionEffectTime
​number · float · required

Açıklama alanının oluşturulma süresi (ms).

definitionVerticalPosition
​string · enum · required

Açıklama alanının dikey konumu. Seçenekler: | top: Yukarı | bottom: Aşağı

Enum values:
top
bottom
definitionHorizontalPosition
​string · enum · required

Açıklama alanının yatay konumu. Seçenekler: | left: Sol | right: Sağ

Enum values:
left
right
definitionVerticalSpace
​integer · enum · required

Açıklama alanının dikey kenar boşluğu (px). Seçenekler: | 5: 5 px | 10: 10 px | 15: 15 px | 20: 20 px | 25: 25 px | 30: 30 px

Enum values:
5
10
15
20
25
30
definitionHorizontalSpace
​integer · enum · required

Açıklama alanının yatay kenar boşluğu (px). Seçenekler: | 5: 5 px | 10: 10 px | 15: 15 px | 20: 20 px | 25: 25 px | 30: 30 px

Enum values:
5
10
15
20
25
30
definitionFontFamilySelect
​string · enum · required

Açıklama yazı tipi. Seçenekler: | arial: Arial | tahoma: Tahoma | verdana: Verdana | georgia: Georgia | trebuchet: Trebuchet | courier: Courier | timesnewroman: Times New Roman

Enum values:
arial
tahoma
verdana
georgia
trebuchet
courier
timesnewroman
definitionFontColorSelect
​string · enum · required

Açıklama yazı rengi. Seçenekler: | white: Beyaz | black: Siyah | red: Kırmızı | green: Yeşil | blue: Mavi | purple: Mor | yellow: Sarı | silver: Gümüş | orange: Turuncu | brown: Kahverengi | cyan: Camgöbeği

Enum values:
white
black
red
green
blue
purple
yellow
silver
definitionFontFamilySize
​integer · min: 10 · max: 30 · required

Açıklama yazı boyutu (px).

definitionBackgroundColor
​string · required

Açıklama yazı arka plan rengi.

showButton
​integer · enum · required

İleri/Geri butonları gösterilsin. Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
previousNextColor
​string · required

İleri/Geri buton rengi.

previousNextSize
​integer · required

İleri/Geri buton büyüklüğü (px).

previousNextOpacity
​integer · min: 0 · max: 100 · required

İleri/Geri buton şeffaflık oranı (1-100 arası).

pagination
​integer · enum · required

Slider altında geçiş butonları aktif mi? Seçenekler: | 0: Hayır | 1: Evet

Enum values:
0
1
bulletActiveFontColor
​string · required

Geçiş butonları aktif yazı rengi.

bulletPassiveFontColor
​string · required

Geçiş butonları pasif yazı rengi.

bulletActiveColor
​string · required

Geçiş butonları aktif arka plan rengi.

bulletPassiveColor
​string · required

Geçiş butonları pasif arka plan rengi.

paginationNumeric
​integer · enum · required

Slider altında geçiş butonları numerik olsun mu? Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1

SliderItem

index
​integer · min: 1 · max: 10

Slider kaleminin indeksi

link
​string

Slider kaleminin yönlendirme linki

sortOrder
​integer · min: 1 · max: 10

Slider kaleminin sırası

targetBlankStatus
​integer · enum

Slider kaleminin yeni sayfada açılma durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
status
​integer · enum

Slider kaleminin aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
imageUrl
​string

Slider kaleminin imaj URL'i

attachment
​string · writeOnly

Slider kalemine ait eklenti dosyası

description
​string

Slider kaleminin açıklaması

Slider

Slider nesnesini temsil eder.
​SliderSettingSummary · required
​SliderItemSummary[] · maxItems: 10 · required

Slider tanımlı ürünler listesi

id
​integer

Slider nesnesine ait benzersiz kimlik numarası.

Example: 12
description
​string

Slider ile ilgili açıklama veya başlık.

Example: Ana sayfa slider'ı
status
​integer · enum

Slider aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
predefined
​integer · enum

Değiştirilemez slider durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 0
updatedAt
​string · date-time

Slider nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Slider nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

SiteContent

homePageHeadContent
​string

Anasayfa için üst içerik. (Yalnızca /index.php rotasında geçerlidir)

Example: <h1>Hoş Geldiniz</h1><p>En yeni ürünlerimizi keşfedin.</p>
footer
​string

Site genelinde gösterilen footer içeriği.

Example: <p>© 2025 Şirket Adı. Tüm hakları saklıdır.</p>
brandListHeadContent
​string

/markalar sayfası için üst içerik.

Example: <h2>Markalar</h2><p>Tüm markalarımızı buradan inceleyebilirsiniz.</p>
categoryListHeadContent
​string

/kategoriler sayfası için üst içerik.

Example: <h2>Kategoriler</h2><p>İstediğiniz ürün kategorisini seçin.</p>
newProductsListHeadContent
​string

/yeni-urunler sayfası için üst içerik.

Example: <h2>Yeni Ürünler</h2><p>Son eklenen ürünleri keşfedin.</p>
featuredProductsListHeadContent
​string

/sponsor-urunler sayfası için üst içerik.

Example: <h2>Sponsor Ürünler</h2><p>Özel olarak öne çıkan ürünlerimiz.</p>
rebatedProductsListHeadContent
​string

/indirimli-urunler sayfası için üst içerik.

Example: <h2>İndirimli Ürünler</h2><p>Fırsatları kaçırmayın.</p>
popularProductsListHeadContent
​string

/populer-urunler sayfası için üst içerik.

Example: <h2>Popüler Ürünler</h2><p>En çok tercih edilen ürünlerimiz.</p>
promotionCampaignListHeadContent
​string

/kampanyalar sayfası için üst içerik.

Example: <h2>Kampanyalar</h2><p>Güncel kampanyalarımızı burada bulabilirsiniz.</p>

ShoppingExperience

rating
​integer · enum · required
Enum values:
1
2
3
4
5
isAnonymous
​integer · enum · required
Enum values:
0
1
status
​integer · enum · required
Enum values:
0
1
id
​integer
​MemberSummary

Üye hesap bilgilerini içeren obje

content
​string · maxLength: 65535
createdAt
​string · date-time
updatedAt
​string · date-time

ShippingRate

volumetricWeightStart
​number · float · min: 0 · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait minimum desi değeri.

Example: 0
volumetricWeightEnd
​number · float · min: 1 · required

İlgili kargo firması, ilgili bölge ve ilgili orana ait maximum desi değeri.

Example: 1
rate
​number · float · min: 0 · required

Seçili bölge ve kargo firması için kargo oranı.

Example: 1
​RegionSummary · required
​ShippingCompanySummary · required

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.

id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123

ShippingProviderSetting

varKey
​string · maxLength: 255 · required

Ayar değişkeninin anahtar değeri

Example: var-key
varValue
​string · maxLength: 65535 · required

Ayar değişkeninin değeri

Example: var-value
id
​integer

Teslimat sağlayıcısı ayarı nesnesi kimlik değeri

Example: 123
​ShippingProviderSummary

Kargo sağlayıcısı nesnesi

ShippingProvider

Kargo sağlayıcısı nesnesi
id
​integer

Kargo sağlayıcısının benzersiz kimlik numarası.

Example: 123
code
​string · maxLength: 64

Kargo sağlayıcısı kodu. Benzersiz olmalıdır.

Example: idea
name
​string · maxLength: 255

Kargo sağlayıcısının görünen adı.

Example: Idea Cargo
trackingUrl
​string · maxLength: 1024

Kargo takip url.

Example: https://app.kargonomi.com.tr/kargo-takip
trackingFormMethod
​string · enum

Kargo takibi için kullanılan HTTP metodu (GET veya POST).

Enum values:
get
post
Example: get
payload
​string · maxLength: 65535

Kargo takip kodunun gönderildiği sorgu veya form şablonu.

Example: q={tracking_code}&val=1
settings
​object

Kargo sağlayıcısına özel ek yapılandırma ayarları.

Example: {"apiKey":"abc123xyz","region":"TR","supportsCashOnDelivery":true}

ShippingCompany

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
id
​integer · required

Kargo firması nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 128 · required

Kargo firması nesnesi adı.

Example: Idea Cargo
status
​string · enum

Kargo firmasının aktiflik durumu. Pasif firmalar sistemde görünmez.

Enum values:
active
passive
Example: active
extraPrice
​number · float · min: 0

Kargo 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.

Example: 5
extraVolumetricWeightPrice
​number · float · min: 0

Kargo 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.

Example: 10
freeShipmentOrderPrice
​number · float · min: 0

Alışveriş sepeti toplamı belirlediğiniz Ücretsiz kargo limitini geçtiğinde müşterileriniz ücretsiz kargo hizmetinden faydalanabilirler.(Örn: X Lira üzeri ücretsiz Kargo!)

Example: 100
freeShipmentVolumetricWeightLimit
​number · float · min: 0

Ü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.

Example: 1
sortOrder
​integer · min: 0 · max: 999

Kargo firmalarının listelenme sırasını belirler.

Example: 999
paymentType
​string · enum

Kargo ödemesinin tipini belirtir.

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
companyCode
​string · maxLength: 255

API tarafından otomatik oluşturulan kargo firması kodu.

Example: CMP12KD
​ShippingProviderSummary

Kargo sağlayıcısı nesnesi

​CountrySummary[]

Ülkeler nesnesi listesi

createdAt
​string · date-time

Kargo firması nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kargo firması nesnesinin son güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

ShippingAddress

Teslimat adresi objesi
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Ülke adı

Example: Türkiye
location
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Şehir adı

Example: İstanbul
subLocation
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

İlçe adı

Example: Üsküdar
address
​string · minLength: 5 · maxLength: 255 · required

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
id
​integer

Adres için benzersiz kimlik

Example: 123
firstname
​string · maxLength: 255

Alıcı adı

Example: Ahmet
surname
​string · maxLength: 255

Alıcı soyadı

Example: Yılmaz
phoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Cep telefonu numarası

Example: +90 (555) 555 55 55
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi

ShipmentPref

Teslimat ayarlarını temsil eder.
id
​integer

Teslimat tercihleri nesnesi benzersiz kimlik değeri.

Example: 123
value
​string

Teslimat nesnesi değeri.

Shipment

id
​integer · required

Teslimat nesnesi kimlik değeri.

Example: 123
status
​integer · enum · required

Teslimat nesnesinin aktiflik durumunu belirten değer.

Enum values:
0
1
-1
Example: 1
barcodeImage
​string · required

Barkod resmi.

trackingUrl
​string · required

Takip linki.

barcode
​string

Teslimat barkodu.

Example: 12345678ASD
waybillNo
​string

Teslimat fatura numarası.

Example: A-1002
invoiceKey
​string

Teslimat irsaliye makbuzu numarası.

Example: A-1231
cargoOffice
​string

Teslimatın kargo şubesi

Example: Üsküdar
code
​string

Teslimat kodu. Kargo takip kodu.

Example: KOD123456
deliveryType
​string

Teslimat tipi

Example: deliveryType
invoiceIncluded
​string · enum

Faturanın pakete dahillik durumunu belirtir.

Enum values:
0
1
Example: 1
payAtDoorAmount
​string · min: 0

Kapıda ödeme hizmeti bedeli.

Example: 5
​OrderSummary

Sipariş detay objesi

createdAt
​string · date-time · writeOnly

Teslimat nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

SeoSetting

​object · required

SEO ayarları nesnesi JSON formatında değeri.

Example: {"title": "Kaliteli Kalemler", "description": "En iyi fiyatlar"}
id
​integer

SEO ayarları nesnesi kimlik değeri.

Example: 123
context
​string · enum · maxLength: 255

SEO ayarları nesnesi içeriği. Seçenekler: | product: Ürün.

Enum values:
product
brand
blog
category
page
collection
contextItemId
​integer

SEO ayarları nesnesi içerik kalemi kimlik değeri.

Example: 999
updatedAt
​string · date-time

SEO ayarları nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00
createdAt
​string · date-time

SEO ayarları nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00

SeoPref

​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary · required
​SeoDetailSummary
​SeoDetailSummary
​SeoDetailSummary

SelectionGroup

id
​integer · required

Ek özellik grubu nesnesi kimlik değeri.

Example: 123
title
​string · maxLength: 255 · required

Ek özellik grubu ismi.

Example: Renk Seçenekleri
sortOrder
​integer

Ek özellik grubu sırası.

Example: 1
​SelectionSummary[]

Ek özellik nesnesi listesi.

Selection

title
​string · maxLength: 255 · required

Ek özelliğin başlığı veya adı; ürün sayfasında kullanıcıya gösterilir.

Example: Renk Seçeneği
id
​integer

Ek özellik nesnesinin benzersiz kimlik değeri.

Example: 123
sortOrder
​integer

Ek özelliğin sıralama önceliği; küçük değerler önce, büyük değerler sonra listelenir.

Example: 1
​SelectionGroupSummary

SearchEnginePref

Arama motoru optimizasyonu (SEO) ile ilgili tercihleri temsil eder.
googleVerifyCode
​string · maxLength: 5000 · required

Google site doğrulama kodu. Google Search Console gibi servisler sitenizi doğrulamak için bu meta etiketi kullanır.

Example: <meta name="google-site-verification" content="ideaTest" />
googleAnalyticsRemarketingCode
​string · maxLength: 10000 · required

Google Analytics ve Remarketing izleme kodu. Site trafiğini izlemek ve reklam hedeflemeleri yapmak için kullanılır.

orderTrackingCode
​string · maxLength: 10000 · required

Sipariş takip Kodu.

Example: <div id="ideaTrackOrder" style="display:none"> <h4 id="orderId" content="{orderId}">{orderId}</h4> <h4 id="companyName" content="{companyName}">{companyName}</h4> <h4 id="tax" content="{tax}">{tax}</h4> <h4 id="cargo" content="{cargo}">{cargo}</h4> <h4 id="city" content="{city}">{city}</h4> <h4 id="country" content="{country}">{country}</h4> <h4 id="cartUrl" content="{cartUrl}">{cartUrl}</h4> <h4 id="cartNumber" content="{cartNumber}">{cartNumber}</h4> <h4 id="totalProduct" content="{totalProduct}">{totalProduct}</h4> <h4 id="total" content="{total}">{total}</h4> <h4 id="email" content="{email}">{email}</h4> <h4 id="memberId" content="{memberId}">{memberId}</h4> [loop_product] <h4 id="{productId}_productStockcode" content="{productStockcode}">{productStockcode}</h4> <h4 id="{productId}_productId" content="{productId}">{productId}</h4> <h4 id="{productId}_productName" content="{productName}">{productName}</h4> <h4 id="{productId}_productAmount" content="{productAmount}">{productAmount}</h4> <h4 id="{productId}_productPrice" content="{productPrice}">{productPrice}</h4> <h4 id="{productId}_productTax" content="{productTax}">{productTax}</h4> <h4 id="{productId}_productCurrency" content="{productCurrency}">{productCurrency}</h4> <h4 id="{productId}_productUrl" content="{productUrl}">{productUrl}</h4> <h4 id="{productId}_productImage" content="{productImage}">{productImage}</h4> <h4 id="{productId}_productCategory" content="{productCategory}">{productCategory}</h4> [/loop_product] </div>
cartTrackingCode
​string · maxLength: 10000 · required

Sepet takip Kodu.

Example: <div id="ideaTrackBasket" style="display:none"> <h4 id="cartUrl" content="{cartUrl}">{cartUrl}</h4> <h4 id="cartNumber" content="{cartNumber}">{cartNumber}</h4> <h4 id="totalProduct" content="{totalProduct}">{totalProduct}</h4> <h4 id="total" content="{total}">{total}</h4> <h4 id="email" content="{email}">{email}</h4> <h4 id="memberId" content="{memberId}">{memberId}</h4> [loop_product] <h4 id="{productId}_productStockcode" content="{productStockcode}">{productStockcode}</h4> <h4 id="{productId}_productId" content="{productId}">{productId}</h4> <h4 id="{productId}_productName" content="{productName}">{productName}</h4> <h4 id="{productId}_productAmount" content="{productAmount}">{productAmount}</h4> <h4 id="{productId}_productPrice" content="{productPrice}">{productPrice}</h4> <h4 id="{productId}_productTax" content="{productTax}">{productTax}</h4> <h4 id="{productId}_productCurrency" content="{productCurrency}">{productCurrency}</h4> <h4 id="{productId}_productUrl" content="{productUrl}">{productUrl}</h4> <h4 id="{productId}_productImage" content="{productImage}">{productImage}</h4> <h4 id="{productId}_productCategory" content="{productCategory}">{productCategory}</h4> [/loop_product] </div>
productTrackingCode
​string · maxLength: 10000 · required

Ürün takip Kodu.

Example: <div id="ideaTrackProduct" style="display:none"> <h4 id="productId" content="{productId}">{productId}</h4> <h4 id="productStockcode" content="{productStockcode}">{productStockcode}</h4> <h4 id="productName" content="{productName}">{productName}</h4> <h4 id="productCategory" content="{productCategory}">{productCategory}</h4> <h4 id="productPrice" content="{productPrice}">{productPrice}</h4> <h4 id="productCurrency" content="{productCurrency}">{productCurrency}</h4> <h4 id="productTax" content="{productTax}">{productTax}</h4> <h4 id="productImage" content="{productImage}">{productImage}</h4> <h4 id="productUrl" content="{productUrl}">{productUrl}</h4> <h4 id="email" content="{email}">{email}</h4> <h4 id="memberId" content="{memberId}">{memberId}</h4> </div>
homepageTrackingCode
​string · maxLength: 10000 · required

Anasayfa takip Kodu.

Example: <div id="ideaTrackHomepage" style="display:none"> <h4 id="email" content="{email}">{email}</h4> </div>
memberTrackingCode
​string · maxLength: 10000 · required

Üye takip Kodu.

Example: <div id="ideaTrackMemberRegister" style="display:none"> <h4 id="memberId" content="{memberId}">{memberId}</h4> <h4 id="email" content="{email}">{email}</h4> </div>
robotsTxt
​string · maxLength: 5000 · required

Robots.txt dosyası, ileri seviye kullanıcılar için tasarlanmış, arama motorlarının sitenizdeki belirli sayfaların taramasını önleyen bir metin dosyasıdır. Bu alan arama motoru performansınızı etkilemez. Standart olarak değişiklik yapmanıza gerek yoktur.

llmsTxt
​string · maxLength: 5000 · required

llms.txt, bir web sitesinin kök dizininde bulunan ve LLM'lere (Büyük Dil Modelleri) sitenin içeriğinin nasıl kullanılabileceğini anlatan bir metin dosyasıdır. Arama motorları için robots.txt'nin çalışma şekline benzer şekilde, llms.txt, hangi sayfaların özetlenebileceği, alıntı yapılabileceği veya eğitim amaçlı kullanılabileceği konusunda LLM'lere kurallar iletmek için kullanılır.

ScriptTag

src
​string · maxLength: 255 · required

Script tag değişkeni kaynağının URL veya dosya yolu.

id
​integer

Script tag değişkeni nesnesine ait benzersiz kimlik (ID) değeri.

createdAt
​string · date-time

Script tag değişkeni nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Script tag değişkeni nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

Region

id
​integer · required

Teslimat bölgesi kimlik değeri.

Example: 1
name
​string

Teslimat bölgesi ismi.

Example: Marmara
​CountrySummary[]

Teslimat bölgesine ait ülkeler listesi.

QuickCart

Hızlı satın alma sepeti objesi
name
​string · maxLength: 255 · required

Sepet adı

Example: Ofis Malzemeleri Paketi
​array · required

Sepetteki ürünler listesi

id
​integer

Hızlı sepet için benzersiz kimlik

Example: 321
url
​string · maxLength: 2048

Benzersiz URL tanımlayıcısı

Example: ofis-malzemeleri-paketi
updatedAt
​string · date-time

Son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300

QueueProcess

Kuyruk işlemi objesi (asenkron işlemler için)
id
​integer

Kuyruk işlemi için benzersiz kimlik

Example: 567
type
​string · maxLength: 255

İşlem tipi

Example: product_bulk_update
model
​string · maxLength: 255

İşlenecek model adı

Example: Product
status
​string · enum · maxLength: 255

İşlem durumu

Enum values:
started
created
completed
failed
cancelled
in_queue
Example: processing
output
​string · maxLength: 65535 · writeOnly

output

tooltipType
​string · maxLength: 255
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00

Question

​ProductSummary · required

Ürün detay objesi

​MemberSummary · required

Üye hesap bilgilerini içeren obje

content
​string · maxLength: 255 · required
status
​integer · enum · required
Enum values:
0
1
richSnippetStatus
​integer · enum · required
Enum values:
0
1
mailStatus
​integer · enum · required
Enum values:
0
1
isAnonymous
​integer · enum · required
Enum values:
0
1
id
​integer
answerContent
​string · maxLength: 255
answerDate
​string · date-time
updatedAt
​string · date-time
createdAt
​string · date-time

PurchaseLimitationItem

Satın alma limiti kalemi objesi
id
​integer

Limit kalemi için benzersiz kimlik

Example: 456
​PurchaseLimitationSummary
​BrandSummary

Marka objesi

​CategorySummary

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

​ProductSummary

Ürün detay objesi

​MemberGroupSummary
createdAt
​string · date-time

Satın alma limiti kalemi nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Satın alma limiti kalemi nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

PurchaseLimitation

id
​integer · required

Satın alma limiti nesnesine ait benzersiz kimlik (ID) değeri.

name
​string · maxLength: 255 · required

Satın alma limiti nesnesine ait isim.

minimumLimit
​number · float · min: 0

Belirlenen en düşük satın alma limiti.

maximumLimit
​number · float · min: 0

Belirlenen en yüksek satın alma limiti.

type
​string · enum

Satı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..

Enum values:
product
category
brand
status
​integer · enum

Satın alma limitinin aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 0
​PurchaseLimitationItemSummary[]

Satın alma limiti kapsamında yer alan ürünlerin listesi.

updatedAt
​string · date-time

Satın alma limiti nesnesinin güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Satın alma limiti nesnesinin oluşturulma tarihi.

Example: 2018-02-21T09:36:03+0300

PromotionPriceRange

Promosyon fiyat aralığı objesi (basamaklı indirim)
fromQty
​integer · min: 0

Başlangıç adeti

toQty
​integer · min: 0

Bitiş adeti (fromQty'den büyük olmalı)

discountAmount
​integer · min: 0

İndirim miktarı (₺ veya %)

createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300

PromotionBar

Promosyon barını temsil eder.
title
​string · maxLength: 255 · required

Promosyon barının adı.

Example: Haftanın Kampanyası
content
​string · required

Promosyon barında gösterilecek içerik.

Example: Tüm ürünlerde %20 indirim!
status
​integer · enum · required

Bar durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
backgroundColor
​string · maxLength: 255 · required

Barın arka plan rengi.

Example: #ffffff
id
​integer

Promosyon barına ait benzersiz kimlik numarası.

Example: 12
closeButton
​integer · enum

Kapat butonu durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
position
​string · enum

Barın sayfa üzerindeki konumu.

Enum values:
top
bottom
Example: top
isStatic
​integer · enum

Barın statik olup olmadığı (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 0
frameColor
​string · maxLength: 255

Barın çerçeve rengi.

Example: #000000
frameSize
​integer · min: 0

Çerçeve kalınlığı (px cinsinden).

Example: 2
displayHomepage
​integer · enum

Anasayfada gösterim durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
displayProductPage
​integer · enum

Ürün sayfalarında gösterim durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
displayCategoryPage
​integer · enum

Kategori sayfalarında gösterim durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 0
​CategorySummary[]

Barın ilişkilendirildiği kategori nesneleri.

createdAt
​string · date-time

Promosyon barının oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Promosyon barının son güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

Promotion

id
​integer · required

Promosyon nesnesi kimlik değeri.

name
​string · maxLength: 255 · required

Promosyon adı.

Example: Sepette %20 İndirim
type
​string · enum

Promosyon tipi.

Enum values:
cart
product
category_and_brand
Example: cart
maxUsage
​integer · min: 0

Promosyonun maksimum kullanım sayısı.

Example: 1000
currentUsage
​integer · min: 0

Şu ana kadar toplam kullanım sayısı.

Example: 250
useDateFilter
​integer · enum

Tarih aralığı özelliği kullanılsın mı?

Enum values:
0
1
Example: 1
startDate
​string · date-time

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time
​MemberSummary[]

members

​MemberGroupSummary
minimumCheckoutLimit
​number · float

Kullanım alışveriş sınırı.

Example: 200
​CategorySummary

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

​CategorySummary[]
​BrandSummary

Marka objesi

​ProductSummary[]

Ana Ürünler

​PromotionPriceRangeSummary[] · minItems: 2 · maxItems: 5
minimumPurchaseQuantityOfMainProducts
​integer · min: 0

Ana ürün minimum satın alma zorunluluğu miktarı.

Example: 2
promotionValidityControl
​string · enum

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
promotionFeatureType
​string · enum

Promosyon özelliği tipi.

Enum values:
free
discountPrice
discountPercentage
fixedPrice
cartDiscountPercentage
Example: discountPercentage
promotionFeatureValue
​number · float · min: 0

Promosyon özelliğine ait promosyon miktarı.

Example: 20
​ProductSummary[]

Promosyonlu ürün nesnesi listesi

promotionalProductQuantity
​integer · min: 0

Promosyonlu ürün miktarı.

Example: 1
description
​string

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255
urlBlankStatus
​integer · enum
Enum values:
0
1
imageFile
​string · maxLength: 255
imageUrl
​string
attachment
​string · writeOnly
status
​integer · enum

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999999
freeShipping
​integer · enum

Ücretsiz kargo durumu.

Enum values:
0
1
Example: 1
applyToDiscountProduct
​integer · enum

İndirimli ürünlerde geçerli olsun mu?

Enum values:
0
1
Example: 0
createdAt
​string · date-time

Promosyon nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Promosyon nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

ProductToCollection

​CollectionSummary · required
id
​integer
​ProductSummary

Ürün detay objesi

sortOrder
​integer · max: 500

ProductTag

​TagSummary · required

SEO+ etiket nesnesi

​ProductSummary · required

Ürün detay objesi

id
​integer

Ürün SEO etiketi bağı nesnesi kimlik değeri.

Example: 987

ProductSpecialInfo

Ürünlere eklenebilen özel bilgi alanlarını temsil eder. Bu alanlar ürün detay sayfasında açıklama, teknik bilgi veya özel metin göstermek için kullanılır.
title
​string · minLength: 1 · maxLength: 255 · required

Özel bilgi alanı başlığı.

Example: Özel Bilgi Başlığı
content
​string · required

Özel bilgi alanı içeriği.

Example: Bu ürünle ilgili özel bilgileri içeren metindir.
status
​integer · enum · required

Özel bilgi alanı aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 0
id
​integer

Özel bilgi alanı kaydının benzersiz kimlik değeri.

Example: 123
​ProductSummary

Ürün detay objesi

ProductProtection

isPriceProtected
​integer · enum · required

Ürün fiyatının koruma durumu. Seçenekler: | 0: Korumasız | 1: Korumalı

Enum values:
0
1
Example: 0
isStockProtected
​integer · enum · required

Ürün stokunun koruma durumu. Seçenekler: | 0: Korumasız | 1: Korumalı

Enum values:
0
1
Example: 0
id
​integer

Ürün koruma nesnesi kimlik değeri.

Example: 123
​ProductSummary

Ürün detay objesi

ProductPriceWarning

​MemberSummary · required

Üye hesap bilgilerini içeren obje

​ProductSummary · required

Ürün detay objesi

price
​number · float · min: 0 · required

Ürün fiyatı.

priceIndex
​integer · enum · required

Ürünün tanımlı fiyat indeksi. Seçenekler: | 1: Fiyat 1. | 2: Fiyat 2. | 3: Fiyat 3. | 4: Fiyat 4. | 5: Fiyat 5.

Enum values:
1
2
3
4
5
id
​integer

Ürün fiyat bildirimi nesnesi kimlik değeri.

updatedAt
​string · date-time

Ürün fiyat bildirimi güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Ürün fiyat bildirimi oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

ProductPrice

Ürün fiyatlandırma bilgilerini içeren obje
type
​integer · enum · required

Fiyat tipi (alternatif fiyat seçenekleri)

Enum values:
2
3
4
5
6
Example: 2
value
​number · float · min: 0 · required

Ürünün fiyat değeri

Example: 10.99
id
​integer

Ürün fiyatı için benzersiz kimlik

Example: 123
​ProductSummary

Ürün detay objesi

ProductLabel

​LabelSummary · required

Kişisel etiket nesnesi

​ProductSummary · required

Ürün detay objesi

id
​integer

Ürün adı ile ürün nesnesi arasındaki bağ kimlik değeri.

Example: 456

ProductImage

Ürün görseli objesi
id
​integer

Görsel için benzersiz kimlik

Example: 123
filename
​string · maxLength: 255 · pattern: ^[a-z0-9-]+$

Dosya adı (uzantısız)

Example: ornek-urun-gorseli
extension
​string · enum

Dosya uzantısı

Enum values:
jpg
jpeg
png
gif
webp
JPG
JPEG
PNG
Example: jpg
sortOrder
​integer · min: 1 · max: 8

Görsel sırası (1-8 arası, 1 ana görsel)

Example: 1
thumbUrl
​string · uri

Küçük boyut (thumbnail) görsel URL'i

Example: https://cdn.example.com/thumbs/product-123.jpg
originalUrl
​string · uri

Orijinal boyut görsel URL'i

Example: https://cdn.example.com/products/product-123.jpg
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded görsel verisi (sadece POST işlemlerinde kullanılır)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
​ProductSummary

Ürün detay objesi

alt
​string · maxLength: 150

ProductFeed

​MemberSummary · required

Üye hesap bilgilerini içeren obje

​ProductSummary · required

Ürün detay objesi

id
​integer

Ürün önerisi nesnesi kimlik değeri.

​object

Öneri değeri

createdAt
​string · date-time

Ürün önerisi nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

ProductExtraInfo

Ürün ile ilgili ekstra bilgileri temsil eder.
value
​string · required

Ekstra bilgi değeri

​ExtraInfoSummary · required

Ek bilgi alanı tanımı objesi

id
​integer

Ekstra bilgi nesnesine ait benzersiz kimlik numarası.

Example: 123
​ProductSummary

Ürün detay objesi

ProductExtraField

id
​integer · required
varKey
​string · maxLength: 255 · required
​ProductSummary

Ürün detay objesi

varValue
​string

ProductDetail

details
​string · required

Detay bilgisi.

Example: <div><strong><br /><table style="border-collapse:collapse;width:100%;"><tbody><tr><td>&nbsp;Özellik</td><td>Tipi&nbsp;</td></tr><tr><td>&nbsp;Uç tipi</td><td>&nbsp;2B</td></tr></tbody></table></strong></div><br/>
id
​integer

Ürün detayı nesnesi kimlik değeri.

Example: 123
sku
​string · maxLength: 255

Ürünün stok kodu.

Example: KAL-1234
extraDetails
​string

Ürün ekstra detaylı bilgi.

Example: Ekstra detay.
​ProductSummary

Ürün detay objesi

ProductCustomizationGroup

name
​string · maxLength: 255 · required

Ürün özelleştirme grubu nesnesi adı.

id
​integer

Ürün özelleştirme grubu nesnesi kimlik değeri.

sortOrder
​integer · min: 0 · max: 999

Ürün özelleştirme grubu sıralama değeri.

Ürün özelleştirme alanı nesneleri.

updatedAt
​string · date-time

Ürün özelleştirme grubu nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Ürün özelleştirme grubu nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

ProductCustomizationFieldSetting

varKey
​string · enum · required

Ürün özelleştirme alanı ayarları seçeneği. Seçenekler: | attributes: Özellikler | min_length: Minimum uzunluk | max_length: Maksimum uzunluk

Enum values:
attributes
min_length
max_length
id
​integer

Ürün özelleştirme alanı ayarları nesnesi kimlik değeri.

varValue
​string

Ürün özelleştirme alanı ayarları seçeneği değeri.

​object · writeOnly

Ürün özelleştirme form alanı tanımı

ProductCustomizationField

Ürün özelleştirme form alanı tanımı
name
​string · maxLength: 255 · required

Alan adı/başlığı

Example: Hediye Mesajı
isRequired
​integer · enum · required

Alan zorunluluğu

Enum values:
0
1
Example: 0
type
​string · enum · required

Form alanı tipi

Enum values:
checkbox
dropdown
file
radio
textarea
textbox
Example: textarea
placeHolder
​string · maxLength: 255 · required

Alan için yer tutucu metin

Example: Hediye mesajınızı buraya yazın...
info
​string · maxLength: 255 · required

Alan hakkında açıklayıcı bilgi

Example: Maksimum 200 karakter
id
​integer

Alan için benzersiz kimlik

Example: 789
sortOrder
​integer · min: 0 · max: 999

Sıralama değeri (küçükten büyüğe)

Example: 1
​object · writeOnly
​object[]

Seçim alanları için seçenek listesi

settings
​object

Alan için ek ayarlar

ProductCountDown

useCountDown
​integer · enum · required

Geriye Sayım Özelliği kullanımının aktif veya pasif olup olmadığı bilgisini tutar.(0 = kapalı, 1 = açık) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 0
id
​integer

Ürün geri sayım nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
startDate
​string · date-time

Geri sayımın başlangıç tarihi belirtir.

Example: 2018-02-21T09:36:03+0300
endDate
​string · date-time

Geri sayımın sona ereceği tarihi belirtir.

Example: 2018-02-26T09:36:03+0300
expireDate
​string · date-time

Geri sayımın ürün için geçersiz olacağı tarihi belirtir.

Example: 2018-02-26T09:36:03+0300
​ProductSummary

Ürün detay objesi

ProductCommentImage

filename
​string · maxLength: 255 · required
extension
​string · enum · required
Enum values:
jpg
png
jpeg
JPG
PNG
JPEG
id
​integer
thumbUrl
​string · writeOnly
originalUrl
​string
attachment
​string · writeOnly
​object · writeOnly

ProductComment

status
​integer · enum · required

Ürün yorumu durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
rank
​integer · enum · required

Ürün yorumunda ürüne verilen puan. Seçenekler: | 1: 1 puan. | 2: 2 puan. | 3: 3 puan. | 4: 4 puan. | 5: 5 puan.

Enum values:
1
2
3
4
5
Example: 5
isAnonymous
​integer · enum · required

Ürün yorumu yapan kişinin anonim olup olmadığı bilgisi. Seçenekler: | 0: Anonim değil. | 1: Anonim.

Enum values:
0
1
Example: 0
id
​integer

Ürün yorumu nesnesi kimlik değeri.

Example: 123
title
​string · maxLength: 255

Ürün yorumu başlığı.

Example: Çok kaliteli bir ürün.
content
​string · maxLength: 65535

Ürün yorumu içeriği.

Example: Ürünü çok beğendim. Tarif edildiği gibi çıktı ve kargo süreci çok hızlıydı.
​MemberSummary

Üye hesap bilgilerini içeren obje

​ProductSummary

Ürün detay objesi

createdAt
​string · date-time

Ürün yorumu nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Ürün yorumu nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300
next
​string · writeOnly
prev
​string · writeOnly

ProductCategory

Ürünün kategori ile ilişkisini temsil eder.
​ProductSummary · required

Ürün detay objesi

​CategorySummary · required

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

id
​integer

Ürün-kategori ilişkisinin benzersiz kimlik numarası.

Example: 123
sortOrder
​integer · max: 500

Ürün kategorisinin sıralama değeri (vitrin sırası için null bırakılabilir).

Example: 1

ProductButton

Ürün buton ve rozet gösterim ayarları objesi
id
​integer

Buton ayarları için benzersiz kimlik

Example: 123
fastShipping
​integer · enum

Hızlı gönderi rozeti

Enum values:
0
1
Example: 0
sameDayShipping
​integer · enum

Aynı gün kargo rozeti

Enum values:
0
1
Example: 0
threeDaysDelivery
​integer · enum

3 günde teslimat rozeti

Enum values:
0
1
Example: 0
fiveDaysDelivery
​integer · enum

5 günde teslimat rozeti

Enum values:
0
1
Example: 0
sevenDaysDelivery
​integer · enum

7 günde teslimat rozeti

Enum values:
0
1
Example: 0
freeShipping
​integer · enum

Ücretsiz kargo butonu

Enum values:
0
1
Example: 0
deliveryFromStock
​integer · enum

Stoktan teslim rozeti

Enum values:
0
1
Example: 0
preOrderedProduct
​integer · enum

Ön siparişli ürün rozeti

Enum values:
0
1
Example: 0
limitedStock
​integer · enum

Sınırlı stok rozeti

Enum values:
0
1
Example: 0
askStock
​integer · enum

Stok sorunuz rozeti

Enum values:
0
1
Example: 0
campaignedProduct
​integer · enum

Kampanyalı ürün rozeti

Enum values:
0
1
Example: 0
​ProductSummary

Ürün detay objesi

Product

Ürün detay objesi
id
​integer · required

Ürün için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Ürün adı

Example: Kalem
fullName
​string · maxLength: 255

Tam ürün adı (varyantlar için ana ürün + varyant adı)

Example: Kalem Kırmızı
slug
​string · minLength: 1 · maxLength: 255 · pattern: ^[a-z0-9-]+$

URL dostu benzersiz tanımlayıcı

Example: kalem
sku
​string · maxLength: 255

Stok kodu (benzersiz)

Example: KAL-1234
barcode
​string · maxLength: 255 · pattern: ^[0-9]{8,14}$

Ürün barkodu

Example: 869456789874
stockAmount
​number · decimal · min: 0

Mevcut stok miktarı

Example: 100
price1
​number · decimal · min: 0

Ana satış fiyatı (Fiyat 1)

Example: 10.99
​CurrencySummary
discount
​number · decimal · min: 0

İndirim değeri (tip'e göre ₺ veya %)

Example: 5
discountType
​integer · enum

İndirim tipi

Enum values:
0
1
Example: 1
moneyOrderDiscount
​number · decimal · min: 0 · max: 99

Havale/EFT indirim yüzdesi

Example: 10
buyingPrice
​number · decimal · min: 0

Alış fiyatı

Example: 5.5
marketPriceDetail
​string · maxLength: 255

Piyasa fiyatı açıklaması

Example: Diğer mağazalarda 15 TL
taxIncluded
​integer · enum

Fiyatlara KDV dahil mi?

Enum values:
0
1
Example: 1
tax
​integer · decimal · min: 0

KDV oranı (%)

Example: 20
warranty
​integer · min: 0

Garanti süresi (ay)

Example: 24
volumetricWeight
​number · decimal · min: 0

Desi (hacimsel ağırlık)

Example: 1.5
stockTypeLabel
​string · enum

Stok birim tipi

Enum values:
Piece
cm
Dozen
gram
kg
Person
Package
metre
Example: Piece
customShippingDisabled
​integer · enum

Özel kargo ücreti kullanılsın mı?

Enum values:
0
1
Example: 0
customShippingCost
​number · decimal · min: 0

Özel kargo ücreti (customShippingDisabled=0 ise)

Example: 5
distributor
​string · maxLength: 255

Tedarikçi adı

Example: superTedarik
hasGift
​integer · enum

Ürün hediyeli mi?

Enum values:
0
1
Example: 0
gift
​string · maxLength: 255

Hediye açıklaması

Example: Silgi hediyeli
status
​integer · enum

Ürün aktiflik durumu

Enum values:
0
1
Example: 1
hasOption
​integer · enum · readOnly

Varyant var mı? (sistem otomatik atar)

Enum values:
0
1
Example: 0
shortDetails
​string · maxLength: 512

Kısa ürün açıklaması

Example: Yumuşak uçlu, kırmızı renkli kalem.
searchKeywords
​string · maxLength: 255

Arama anahtar kelimeleri (virgülle ayrılmış)

Example: kırmızı, kalem, kırtasiye
installmentThreshold
​string · maxLength: 10

Maksimum taksit sayısı ('-' = limit yok)

Example: 12
homeSortOrder
​integer | null · max: 500

Anasayfa vitrini sırası (null = vitrin dışı)

Example: 1
popularSortOrder
​integer | null · max: 500

Popüler ürünler vitrini sırası

Example: 1
brandSortOrder
​integer | null · max: 500

Marka vitrini sırası

Example: 1
featuredSortOrder
​integer | null · max: 500

Sponsor ürünler vitrini sırası

Example: 1
campaignedSortOrder
​integer | null · max: 500

Kampanyalı ürünler vitrini sırası

Example: 1
newSortOrder
​integer | null · max: 500

Yeni ürünler vitrini sırası

Example: 1
discountedSortOrder
​integer | null · max: 500

İndirimli ürünler vitrini sırası

Example: 1
categoryShowcaseStatus
​integer · enum

Kategori vitrininde gösterim durumu

Enum values:
0
1
Example: 1
collectionShowcaseStatus
​integer · enum
Enum values:
0
1
midblockSortOrder
​integer | null · max: 9999

Vitrin blokları sırası

Example: 1
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Kırmızı Kalem
metaDescription
​string

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri.
metaKeywords
​string

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: urun/kalem
​

Ana ürün objesi (varyantlar için)

​BrandSummary

Marka objesi

Ürün buton ve rozet gösterim ayarları objesi

Ürünlere eklenebilen özel bilgi alanlarını temsil eder. Bu alanlar ürün detay sayfasında açıklama, teknik bilgi veya özel metin göstermek için kullanılır.

​SpecGroupSummary

Ürün özellik grubu objesi

​CategorySummary[]

İlişkili kategoriler listesi

Alternatif fiyatlar listesi

​DistributorSummary[]

Tedarikçiler listesi

Ek bilgiler listesi

Ürün görselleri listesi

Etiketler listesi

​SelectionGroupSummary[]

Ek özellik grupları

​OptionGroupSummary[]

Varyant grupları

Ürün etiketleri

​OfferedProductSummary[]

Tavsiye edilen ürünler

​CombineProductSummary[]

Kombine ürünler

Özelleştirme grupları

​MidblockSummary

Vitrin bloğu objesi

​SeoSettingSummary
​ProductSummary[]

Varyant ürünler (ana ürün için)

updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
​ProductExtraFieldSummary[]
​DigitalProductSummary
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer
next
​string · writeOnly
prev
​string · writeOnly

ProcessLog

Sistem üzerinde yapılan işlemlere ait log kayıtlarını temsil eder.
userId
​integer · required

İşlemi yapan kullanıcının kimlik numarası.

Example: 1
username
​string · minLength: 4 · maxLength: 16 · required

İşlemi yapan kullanıcı adı

Example: admin
ip
​string · maxLength: 255 · required

İşlemin yapıldığı IP adresi.

Example: 192.168.1.1
recordId
​integer · required

İşlem yapılan kaydın tablo kimlik (ID) numarası.

Example: 10
module
​string · maxLength: 255 · required

İşlem yapılan modülün adı.

Example: AuthModule
file
​string · maxLength: 255 · required

İşlemin gerçekleştiği dosya adı.

Example: AuthController.php
act
​string · maxLength: 255 · required

Yapılan işlem türü

Example: login
tableName
​string · maxLength: 255 · required

İşlem sonucu değişen tablonun adı

Example: users
userType
​string · maxLength: 32 · required

İşlemi yapan kullanıcının tipi.

Example: User
functionName
​string · maxLength: 255 · required

Loglanan işlemin tetiklendiği fonksiyon

Example: loginAction
moduleNameVerbose
​string · maxLength: 255 · required

Modülün açıklamalı adı.

Example: Kullanıcı Yetkilendirme Modülü
logSentence
​string · maxLength: 255 · required

İşlem detayını açıklayan log cümlesi.

Example: 1 idli kullanıcı giriş yaptı.
id
​integer

Log kaydının benzersiz kimlik numarası.

Example: 123
createdAt
​string · date-time

Log kaydının oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00

PriceRule

status
​integer · enum · required
Enum values:
0
1
id
​integer
name
​string
ruleType
​string
​CountrySummary
​CurrencySummary
priceType
​string · enum
Enum values:
price1
price2
price3
price4
price5
operation
​string · enum
Enum values:
increase
decrease
type
​string · enum
Enum values:
percentage
regular
value
​number · float
rounding
​string · enum
Enum values:
up
down
none
createdAt
​string · date-time
updatedAt
​string · date-time

PriceGap

start
​integer · required

Fiyat aralığının başlangıç değeri.

end
​integer · required

Fiyat aralığının bitiş değeri.

id
​integer

Fiyat Aralığı nesnesinin benzersiz kimlik (ID) değeri.

Preference

varValue
​string · required

Tanımlamanın değer kısmı. Belirtilen anahtarın mağazada gözükecek karşılık değeri.

Example: Firma Adınız
id
​integer

Tanımlama nesnesinin benzersiz kimlik değeri.

Example: 123
varKey
​string

Tanımlamanın anahtar değeri. Sistem içi konfigürasyonlarda kullanılan sabit tanım anahtarıdır.

Example: company_name

PreOrderInfo

id
​integer

Sipariş öncesi bilgisi nesnesinin kimlik değeri

Example: 123
sessionId
​string · maxLength: 255

Üyenin son oturumunun benzersiz kimlik değeri

Example: oibtkn9rspcdbmphf8iceondg1
customerFirstname
​string · maxLength: 255

Müşterinin adı

Example: John
customerSurname
​string · maxLength: 255

Müşterinin soyadı

Example: Doe
customerEmail
​string · email

Müşterinin e-posta adresi

Example: johndoe@ideasoft.com.tr
shippingAddressName
​string · maxLength: 255
shippingFirstname
​string · maxLength: 255

Teslimat yapılacak kişinin adı

Example: John
shippingSurname
​string · maxLength: 255

Teslimat yapılacak kişinin soyadı

Example: Doe
shippingAddress
​string · maxLength: 65535

Teslimat adresi detayları

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
shippingPhoneNumber
​string · maxLength: 32 · pattern: \D*(?:\d\D*){10,12}

Teslimat yapılacak kişinin telefon numarası

Example: +90 (216) 326 04 77
shippingMobilePhoneNumber
​string · maxLength: 32 · pattern: \D*(?:\d\D*){10,12}

Teslimat yapılacak kişinin mobil telefon numarası

Example: +90 (555) 555 55 55
shippingLocationName
​string · maxLength: 128

Teslimat şehri

Example: İstanbul
shippingTown
​string · maxLength: 128

Teslimat ilçesi

Example: Üsküdar
shippingIdentityRegistrationNumber
​string · maxLength: 32
shippingZipCode
​string · maxLength: 64
differentBillingAddress
​integer · enum

Teslimat adresinden farklı bir fatura adresi var mı Seçenekler: | 0: Yok | 1: Var

Enum values:
0
1
Example: 0
billingAddressName
​string · maxLength: 255
billingFirstname
​string · maxLength: 255

Fatura kesilecek kişinin adı

Example: John
billingSurname
​string · maxLength: 255

Fatura kesilecek kişinin soyadı

Example: Doe
billingAddress
​string · maxLength: 65535

Fatura adresi detayları

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
billingPhoneNumber
​string · maxLength: 32 · pattern: \D*(?:\d\D*){10,12}

Fatura kesilecek kişinin telefon numarası

Example: +90 (216) 326 04 77
billingMobilePhoneNumber
​string · maxLength: 32 · pattern: \D*(?:\d\D*){10,12}

Fatura kesilecek kişinin mobil telefon numarası

Example: +90 (555) 555 55 55
billingLocationName
​string · maxLength: 128

Fatura adresi şehri

Example: İstanbul
billingTown
​string · maxLength: 128

Fatura adresi ilçesi

Example: Üsküdar
billingInvoiceType
​string · enum

Fatura tipi Seçenekler: | individual: Bireysel | corporate: Kurumsal

Enum values:
individual
corporate
Example: individual
billingIdentityRegistrationNumber
​string · maxLength: 32

TC kimlik numarası (bireysel faturalarda)

Example: 11111111111
billingTaxOffice
​string · maxLength: 255

Fatura kesilen kişi/kurumun vergi dairesi

Example: Üsküdar
billingTaxNo
​string · maxLength: 128

Fatura kesilen kişi/kurum vergi numarası

Example: 9325912620
billingZipCode
​string · maxLength: 128
isEinvoiceUser
​integer · enum

Yöneticinin e-fatura kullanıp kullanmadığı Seçenekler: | 0: Hayır | 1: Evet

Enum values:
0
1
Example: 1
useGiftPackage
​integer · enum

Müşteri hediye paketi isteyip istemediği Seçenekler: | 0: Hayır | 1: Evet

Enum values:
0
1
Example: 0
giftNote
​string · maxLength: 65535

Hediye notu

Example: Doğum günün kutlu olsun.
imageFile
​string · maxLength: 128

Sipariş öncesi görsel dosya adı (jpg, jpeg, png, gif)

Example: kalem.jpg
deliveryDate
​string · date-time

Müşterinin talep ettiği teslimat tarihi

Example: 2018-02-21T18:30:00+0000
deliveryTime
​string · maxLength: 128

API tarafından oluşturulan teslimat saati aralığı

Example: 18:00-19:00
createdAt
​string · date-time

Sipariş öncesi bilgisi nesnesinin oluşturulma zamanı

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Sipariş öncesi bilgisi nesnesinin güncellenme zamanı

Example: 2018-02-21T15:01:03+0300
​CountrySummary
​LocationSummary
​ShippingCompanySummary

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.

​CountrySummary
​LocationSummary
​MemberAddressSummary

Üye adresi objesi

​MemberAddressSummary

Üye adresi objesi

PosCampaignCategory

POS kampanya kategori ilişki objesi
​PosCampaignSummary · required

POS kampanya tanımı objesi

​CategorySummary · required

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

id
​integer

İlişki için benzersiz kimlik

Example: 234

PosCampaign

POS kampanya tanımı objesi
id
​integer · required

Kampanya için benzersiz kimlik

Example: 67
name
​string · maxLength: 255 · required

Kampanya adı

Example: 3 Taksit %5 İndirim
​PosAccountSummary
​object[] · maxItems: 36

Taksit oranları listesi

status
​integer · enum

Kampanya aktiflik durumu

Enum values:
0
1
Example: 1

PosAccount

id
​integer · required

Sanal POS hesabı kimlik değeri.

bank
​integer · writeOnly

Banka bilgisi.

cardName
​string · maxLength: 255

Kart adı.

cardLogo
​string · maxLength: 255 · writeOnly

Kart logosu.

status
​integer · enum · writeOnly

Sanal POS hesabının aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
settings
​string · writeOnly

Sanal POS yapılandırma ayarları.

permit
​integer · enum · writeOnly

Hesap izni durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
threedStatus
​integer · enum · writeOnly

3D Secure aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif. | 2: Kısmi aktif.

Enum values:
0
1
2
paynet
​integer · enum · writeOnly

Paynet entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
segment
​integer · enum · writeOnly

Segment durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
payu
​integer · enum · writeOnly

PayU entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
ipara
​integer · enum · writeOnly

iPara entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
turkPara
​integer · enum · writeOnly

TürkPara entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
hepsiPay
​integer · enum · writeOnly

HepsiPay entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
boschSanalPos
​integer · enum · writeOnly

Bosch Sanal POS durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
payTr
​integer · enum · writeOnly

PayTR entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
paytrek
​integer · enum · writeOnly

Paytrek entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
wirecard
​integer · enum · writeOnly

Wirecard entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
sipay
​integer · enum · writeOnly

Sipay entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
moka
​integer · enum · writeOnly

Moka entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
vepara
​integer · enum · writeOnly

Vepara entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
faturamatik
​integer · enum · writeOnly

Faturamatik entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
paratika
​integer · enum · writeOnly

Paratika entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
akode
​integer · enum · writeOnly

Akode entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
papel
​integer · enum · writeOnly
Enum values:
0
1
posFix
​integer · enum · writeOnly
Enum values:
0
1
qnbPay
​integer · enum · writeOnly
Enum values:
0
1
trPos
​integer · enum · writeOnly
Enum values:
0
1
paycell
​integer · enum · writeOnly
Enum values:
0
1
posMode
​string · enum · maxLength: 8 · writeOnly

POS çalışma modu. Seçenekler: | test: Test modu. | prod: Canlı (üretim) modu.

Enum values:
test
prod
authType
​string · enum · maxLength: 8 · writeOnly

Otorizasyon tipi. Seçenekler: | Auth: Tam otorizasyon. | PreAuth: Ön otorizasyon.

Enum values:
Auth
PreAuth
extraRateMinimumLimit
​number · float · writeOnly

Ek oran için minimum limit.

installmentLimit
​number · float · writeOnly

Maksimum taksit sayısı.

threedType
​string · enum · maxLength: 8 · writeOnly

3D Secure türü. Seçenekler: | 3D: 3D. | 3DPAY: 3D Pay. | 3D_FULL: 3D Full. | 3DHOSTING: 3D Hosting. | 3D_OOS_PAY: 3D OOS Pay.

Enum values:
3D
3DPAY
3D_FULL
3DHOSTING
3D_OOS_PAY
sortOrder
​integer · min: 0 · max: 999 · writeOnly

Sıralama değeri.

Popup pencerelerini ve gösterim ayarlarını temsil eder.
title
​string · maxLength: 255 · required

Popup başlığı. Kullanıcıya gösterilecek kısa ve dikkat çekici metin.

Example: Haftanın Özel Teklifi
content
​string · required

Popup içeriği. HTML formatında olabilir ve kampanya mesajlarını içerebilir.

Example: <p>Tüm ürünlerde %20 indirim fırsatını kaçırmayın!</p>
status
​integer · enum · required

Popup aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
exitOffer
​integer · enum · required

Çıkış teklifi durumu (0 = Pasif, 1 = Aktif). Kullanıcı sayfadan ayrılırken gösterilir.

Enum values:
0
1
Example: 1
id
​integer

Popup nesnesine ait benzersiz kimlik numarası.

Example: 101
frequency
​integer · min: 0

Popup gösterim sıklığı. Örneğin, her kullanıcıya sadece 1 kez gösterilecek şekilde ayarlanabilir.

Example: 1
displayHomepage
​integer · enum

Anasayfada gösterim durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
displayProductPage
​integer · enum

Ürün sayfasında gösterim durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 0
displayCategoryPage
​integer · enum

Kategori sayfalarında gösterim durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 0
​CategorySummary[]

Kategori nesnesi

type
​string
closeButton
​integer · enum
Enum values:
0
1
position
​string · enum
Enum values:
top
bottom
isStatic
​integer · enum
Enum values:
0
1
backgroundColor
​string · maxLength: 255
frameColor
​string · maxLength: 255
frameSize
​integer · min: 0
timeout
​integer · min: 0 · max: 10
createdAt
​string · date-time

Popup nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Popup nesnesinin son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

PollAnswer

name
​string · maxLength: 255 · required

Anket cevabının metin değeri

id
​integer

Anket cevabı nesnesinin kimlik değeri

vote
​integer

Bu cevaba verilen oy sayısı

sortOrder
​integer · min: 0 · max: 999

Anket cevabının sıralama numarası

​object · writeOnly

Anket ve anket sonuçları objesi

Poll

Anket ve anket sonuçları objesi
name
​string · maxLength: 255 · required

Anket başlığı

Example: Müşteri Memnuniyet Anketi
status
​integer · enum · required

Anket aktiflik durumu

Enum values:
0
1
Example: 1
​PollAnswerSummary[] · minItems: 1 · required

Anket cevapları listesi

id
​integer

Anket için benzersiz kimlik

Example: 456
slug
​string · maxLength: 255

URL dostu benzersiz tanımlayıcı

Example: musteri-memnuniyet-anketi
updatedAt
​string · date-time

Son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00

PointPref

​CategorySummary[] · maxLength: 500 · required

Token kullanımının geçerli olduğu kategori listesi.

Example: {"0":"Elektronik","1":"Giyim"}
​BrandSummary[] · maxLength: 500 · required

Token kullanımının geçerli olduğu marka listesi.

Example: {"0":"Apple","1":"Nike"}
useInCommenting
​integer · enum

Yorum yaparak puan kazanma özelliğinin aktif veya pasif olup olmadığını belirtir. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
useInAdvicing
​integer · enum

Tavsiye/öneri paylaşarak puan kazanma özelliğinin aktif veya pasif olup olmadığını belirtir. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
useRegisteringAMember
​integer · enum

Üye olarak puan kazanma özelliğinin aktif veya pasif olup olmadığını belirtir. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
useInVoting
​integer · enum

Anketlere oy vererek puan kazanma özelliğinin aktif olup olmadığını belirtir. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
useInShopping
​integer · enum

Alışveriş yaparak puan kazanma özelliğinin aktif olup olmadığını belirtir. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
useInPayment
​integer · enum
Enum values:
0
1
pointValue
​number · float · min: 0

1 puanın parasal değerini belirtir.

Example: 5
pointPerCommenting
​number · float · min: 0

Yorum başına verilecek puan miktarı.

Example: 10
pointPerAdvicing
​number · float · min: 0

Tavsiyede bulunma başına verilecek puan miktarı.

Example: 10
pointPerRegisteringAMember
​number · float · min: 0

Üye olma işlemi başına verilecek puan miktarı.

Example: 50
pointPerVoting
​number · float · min: 0

Ankete oy verme işlemi başına verilecek puan miktarı.

Example: 5
percentPerShopping
​number · float · min: 0

Alışverişte harcanan tutara göre kazanılacak puan yüzdesi.

Example: 2
percentPerPayment
​number · float · min: 0
tokenProductionRatio
​number · float · min: 0

Hediye çeki üretim oranı.

Example: 0.1
tokenMinimumUsageLimit
​number · float · min: 0

Hediye çeki kullanabilmek için belirtilen minimum harcama tutarı.

Example: 100
minShoppingForInvitationGain
​number · float · min: 0

Davet eden üyenin puan kazanabilmesi için, davet edilen üyenin yapması gereken minimum alışveriş tutarı.

Example: 50
invitationGain
​integer

Davet edilen üye minimum alışveriş tutarında veya daha yüksek alışveriş yaptığında, davet eden üyenin kazanacağı puan miktarı.

Example: 20
isEffectiveSpecialToken
​integer · enum

Özel hediye çeki tanımlama alanlarının geçerli olup olmadığını belirtir. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
tokenTaxIncluded
​integer · enum

Hediye çeki kullanımında KDV dahil olup olmadığını belirtir. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
tokenMinimumUsageLimitTaxIncluded
​integer · enum

Minimum hediye çeki kullanım limitine KDV’nin dahil olup olmadığını belirtir. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
tokenMaximumUsageLimit
​number · float · min: 0

Hediye çeki kullanımında belirtilen alışveriş üst sınır tutarı.

Example: 500
useInDiscountedProduct
​integer · enum

İndirimli ürünlerde token kullanımının aktif olup olmadığını belirtir. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1

PointLog

pointValue
​number · float · min: 0 · required

Puan değeri.

Example: 50
event
​string · enum · required

Puan kazanılan olay. Seçenekler: | advice: Tavsiye. | comment: Yorum. | shopping: Alışveriş. | shoppingcancel: Alışveriş İptali. | signup: Sisteme Üye Olma. | vote: Oy verme. | token_production: Hediye Çeki Oluşturma. | payment: Ödeme. | paymentcancel: Ödeme İptali. | invitedshopping: Davetli Alışverişi. | invitedshoppingcancel: Davetli Alışveriş İptali. | admincancel: İptal.

Enum values:
advice
comment
shopping
shoppingcancel
signup
vote
token_production
payment
mark
​integer · enum · required

Puan tipi. Seçenekler: | gain: Kazanç. | spend: Harcama.

Enum values:
0
1
​MemberSummary · required

Üye hesap bilgilerini içeren obje

id
​integer

Puan geçmişi nesnesi kimlik değeri.

Example: 321
createdAt
​string · date-time

Puan geçmişi nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00

PixelSettingPref

Facebook Pixel yapılandırma ayarları
pixelId
​string · pattern: ^[0-9]{15,16}$

Facebook Pixel kimlik numarası

Example: 1234567890123456
capiToken
​string

Conversions API (CAPI) erişim token'ı

Example: EAAGZCxXu7owIBAJSLcMtIoyL125136246cERTj234o5EGSDF2gD135rsLWN8a6i2GDAuszZAGDkksZC58u77v6Sexk7yMxTSHx1UmJR4148ZD
testEventCode
​string

Test etkinlikleri için kullanılan kod

Example: TEST12345
facebookCatalogIdType
​string · enum

Facebook ürün kataloğunda kullanılacak kimlik tipi

Enum values:
sku
id
Example: sku
isAuthenticated
​integer · enum
Enum values:
0
1
errorMessage
​string

PaymentType

id
​integer · required

Ödeme tipi nesnesi kimlik değeri.

Example: 123
name
​string

Ödeme tipinin adı.

Example: Havale
sortOrder
​integer · min: 0 · max: 999

Ödeme tipinin sıralama değeri.

PaymentProxySetting

id
​integer · required

Ödeme proxy ayarı nesnesinin benzersiz kimlik değeri.

Example: 123
varValue
​string · maxLength: 255 · required

Ödeme proxy ayarı için değişken değeri.

Example: 12702123
varKey
​string

Ödeme proxy ayarı için değişken anahtarı.

Example: client_id
​PaymentProxySummary

PaymentProxy

id
​integer · required

Ödeme yönlendiricisi nesnesinin benzersiz kimlik (ID) değeri.

Example: 5
code
​string

Ödeme yönlendiricisini temsil eden sistemsel kod (sabit string).

Example: Masterpass
name
​string

Ödeme yönlendiricisinin görünen adı.

Example: Masterpass
status
​integer · enum

Ödeme yönlendiricisinin aktiflik durumu. Seçenekler: | 0: Devre dışı (kullanılamaz). | 1: Etkin (ödeme yönlendirme kullanılabilir).

Enum values:
0
1

Ödeme yönlendiricisine ait özel ayarları içeren JSON nesnesi (ör. API anahtarı, endpoint bilgileri).

Example: {"apiKey":"abc123xyz","endpoint":"https://masterpass.com/api"}
updatedAt
​string · date-time

Ödeme yönlendiricisinin son güncellenme zamanı (ISO 8601 formatında).

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Ödeme yönlendiricisinin oluşturulma zamanı (ISO 8601 formatında).

Example: 2022-04-20T14:33:45+03:00

PaymentProviderSetting

Ödeme sağlayıcısına ait yapılandırma ayarlarını temsil eder.
id
​integer · required

Ödeme sağlayıcı ayarına ait benzersiz kimlik numarası.

Example: 123
varValue
​string · maxLength: 255 · required

Ödeme altyapısı sağlayıcısı ayarı nesnesi için değişken değeri.

Example: PALIKJXZQ
varKey
​string

Ödeme altyapısı sağlayıcısı ayarı nesnesi için değişken anahtarı.

Example: agentId
​PaymentProviderSummary

PaymentProvider

id
​integer · required

Ödeme altyapısı sağlayıcısı nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
code
​string

Ödeme altyapısı sağlayıcısı için ön tanımlanmış kod değeri.

Example: MoneyOrder
name
​string

Ödeme altyapısı sağlayıcısı için isim değeri.

Example: Havale
status
​integer · enum

Ödeme altyapısı sağlayıcısının aktif veya pasif olup olmadığı bilgisini tutar.(0 = pasif, 1 = aktif)

Enum values:
0
1
Example: 1

Ödeme altyapısı sağlayıcısına ait ayarların listesi

​PaymentBddkCategorySummary[]
​PaymentTypeSummary

PaymentGatewaySetting

varKey
​string · maxLength: 255 · required
varValue
​string · required
id
​integer

Ödeme kanalı ayarı nesnesi kimlik değeri.

Example: 123
​PaymentGatewaySummary

PaymentGateway

id
​integer · required

Ödeme kanalı nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Ödeme kanalı için sistemde ön tanımlı kod değeri.

Example: ideabank
name
​string · maxLength: 255 · required

Ödeme kanalı ismi.

Example: Idea Bank
sortOrder
​integer · min: 0 · max: 999

Ödeme kanalının listelerdeki sıralama değeri.

Example: 999
status
​string · enum

Ödeme kanalının aktiflik durumu. Seçenekler: | active: Ödeme kanalı aktif. | passive: Ödeme kanalı pasif.

Enum values:
active
passive
Example: active
legacyTableName
​string · maxLength: 512
legacyTableId
​integer · min: 1
​PaymentProviderSummary

Ödeme kanalına ait konfigürasyon ve ayarlar.

​InstallmentRateSummary[]

Ödeme kanalının desteklediği taksit oranları.

​ExtraInstallmentSummary

Ekstra taksit seçeneği objesi

updatedAt
​string · date-time

Ödeme kanalı nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Ödeme kanalı nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00

PaymentBddkCategory

bddkCategoryName
​string · maxLength: 255 · required
installment
​integer · min: 0 · required
id
​integer
​PaymentProviderSummary
extraField
​string · maxLength: 255

Payment

Ödeme işlemi detay objesi
transactionId
​string · maxLength: 255 · required

İşlem numarası

Example: 152502357
memberFirstname
​string · maxLength: 255 · required

Ödeme yapan üyenin adı

Example: Ahmet
memberSurname
​string · maxLength: 255 · required

Ödeme yapan üyenin soyadı

Example: Yılmaz
memberEmail
​string · email · required

Ödeme yapan üyenin e-posta adresi

Example: ahmet.yilmaz@example.com
memberPhone
​string · maxLength: 255 · required

Ödeme yapan üyenin telefon numarası

Example: +90 (216) 326 04 77
status
​string · enum · required

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: approved
paymentTypeName
​string · maxLength: 255 · required

Ödeme yöntemi adı

Example: Kredi Kartı
paymentProviderCode
​string · maxLength: 255 · required

Ödeme sağlayıcı kodu

Example: IdeaPay
paymentProviderName
​string · maxLength: 255 · required

Ödeme sağlayıcı adı

Example: IdeaPay
paymentGatewayCode
​string · maxLength: 255 · required

Ödeme gateway kodu

Example: ideacard
paymentGatewayName
​string · maxLength: 255 · required

Ödeme gateway adı

Example: IdeaCard
bankName
​string · maxLength: 64 · required

İşlem yapılan banka adı

Example: Idea Bank
deviceType
​string · enum · required

Ödemenin yapıldığı cihaz tipi

Enum values:
desktop
mobile
tablet
Example: mobile
currencyRates
​string · maxLength: 255 · required

İşlem anındaki döviz kurları (JSON string)

Example: {"TL":[1,1],"USD":[3.7698,3.7766],"EUR":[4.6575,4.6659],"GBP":[5.2597,5.2872]}
amount
​number · decimal · min: 0 · required

Ödeme tutarı (vergi ve indirimler hariç)

Example: 100
finalAmount
​number · decimal · min: 0 · required

Toplam ödeme tutarı (tüm hesaplamalarla birlikte)

Example: 118
installment
​integer · min: 0 · max: 12 · required

Taksit sayısı

Example: 3
installmentRate
​number · decimal · required

Taksit oranı (faiz oranı)

Example: 1.05
currency
​string · maxLength: 32 · pattern: ^[A-Z]{3}$ · required

Para birimi kodu

Example: TRY
id
​integer

Ödeme için benzersiz kimlik

Example: 123
statusLang
​string

Sipariş durumu yerelleştirilmiş metni

Example: Onaylandı
cardHolderName
​string · maxLength: 64

Kart sahibinin adı

Example: AHMET YILMAZ
sumOfGainedPoints
​number · decimal · min: 0

Bu ödemeden kazanılan toplam puan

Example: 100
extraInstallment
​integer · min: 0 · max: 12

Ekstra kampanya taksit sayısı

Example: 0
memberNote
​string

Müşteri tarafından eklenen sipariş notu

Example: Her ayın ikisinde teslimat istiyorum
userNote
​string

Yönetici tarafından eklenen sipariş notu

Example: Her ayın ikisinde gönderilecek
errorMessage
​string

Hatalı ödeme işlemlerinde hata mesajı

Example: Limit yetersiz
cardSavingSystem
​string

Kullanılan kart saklama sistemi

Example: ideasave
​MemberSummary

Üye hesap bilgilerini içeren obje

updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
clientIp
​string · ipv4

Müşterinin IP adresi

Example: 192.168.1.1

Page

Sayfa nesnesi
id
​integer · required

Sayfa nesnesine ait benzersiz kimlik değeri.

Example: 101
title
​string · maxLength: 255 · required

Sayfanın başlığı. Kullanıcıya görünür ve SEO açısından önemlidir.

Example: Mesafeli Satış Sözleşmesi
type
​string · enum

Sayfanın türü. Sistem, sayfanın normal içerik sayfası mı yoksa haber sayfası mı olduğunu bu alana göre belirler.

Enum values:
page
article
Example: page
slug
​string · maxLength: 255

Sayfa URL'sinde kullanılacak SEO dostu kısa metin. Boşluk yerine tire (-) kullanılır.

Example: mesafeli-satis-sozlesmesi
scoop
​string · maxLength: 255

Sayfa için kısa özet veya teaser metni. Haber sayfalarında öne çıkan özet olarak kullanılabilir.

Example: Bu sayfa, Mesafeli Satış Sözleşmesi ile ilgili bilgilendirme sağlar.
content
​string

Sayfanın HTML veya zengin metin formatındaki içeriği.

Example: <p>Mesafeli Satış Sözleşmesi hakkında detaylı bilgi burada yer alır.</p>
status
​integer · enum

Sayfanın aktiflik durumu. Pasif sayfalar kullanıcıya gösterilmez. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
blockStatus
​integer · enum

Sayfanın blok içerik durumunu belirler. Pasifse bloklar gösterilmez. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
sortOrder
​integer · min: 0 · max: 9999

Sayfanın listelerde veya menülerde gösterim sırasını belirler.

Example: 10
pageTitle
​string · maxLength: 255

Sayfa başlığı

Example: Sayfa 1
metaDescription
​string

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string

İlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-de&#x11F;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.

Example: sayfa/idea-haber
​SeoSettingSummary
updatedAt
​string · date-time

Sayfanın en son güncellenme zamanı.

Example: 2025-10-17T09:00:00+03:00
createdAt
​string · date-time

Sayfanın oluşturulma zamanı.

Example: 2023-05-10T12:30:00+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

PackageItemProduct

Paket kalemi ürünü objesi
​PackageItemSummary · required

Paket kalemi objesi

​PackageSummary · required
​ProductSummary · required

Ürün detay objesi

id
​integer

Paket kalemi ürününe ait benzersiz kimlik numarası.

Example: 123
updatedAt
​string · date-time

Paket kalemi ürününün son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Paket kalemi ürünü nesnesi oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00

PackageItem

Paket kalemi objesi
id
​integer · required

Paket kalemi için benzersiz kimlik

Example: 234
name
​string · maxLength: 255 · required

Paket kalemi adı

Example: Ana Ürün
choiceType
​string · enum

Seçim tipi

Enum values:
singular
plural
Example: singular
isRequired
​integer · enum

Zorunlu alan mı?

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 1 · max: 20

Görüntüleme sırası

Example: 999
​PackageSummary
​CategorySummary

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

​ProductSummary[] · maxItems: 50

Seçilebilir ürünler listesi

updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00

Package

id
​integer · required

Paket nesnesi kimlik değeri.

Example: 123
name
​string · maxLength: 255 · required

Paket nesnesi ismi.

Example: Ofis Seti
slug
​string · maxLength: 255

Slug değeri, ilgili nesnenin URL değeridir.

Example: ofis-seti
description
​string

Paket nesnesi açıklama alanı.

Example: Ofis malzemeleri içeren avantajlı paket.
​PackageItemSummary[] · maxItems: 20

Paket kalemi nesnesi listesi.

status
​integer · enum

Paket aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
pageTitle
​string · maxLength: 255

Sayfa başlığı.

Example: Ofis Seti - Kaliteli Ürünler
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
metaDescription
​string

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
updatedAt
​string · date-time

Paket nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Paket nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00

OrderUserNote

Sipariş yönetici notu objesi
id
​integer · required

Not için benzersiz kimlik

Example: 123
userEmail
​string · email · required

Not ekleyen yöneticinin e-posta adresi

Example: admin@example.com
userFirstname
​string · maxLength: 255 · required

Yöneticinin adı

Example: Ahmet
userSurname
​string · maxLength: 128 · required

Yöneticinin soyadı

Example: Yılmaz
note
​string · maxLength: 65535 · required

Not içeriği

Example: Kutulanırken dikkat edilecek
​OrderSummary · required

Sipariş detay objesi

updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300

OrderRefundRequestItem

paybackStatus
​integer · enum · required

Geri ödeme durumu Seçenekler: | 0: Hayır | 1: Evet

Enum values:
0
1
id
​integer

Sipariş iptal talebi kalemi nesnesi kimlik değeri.

Example: 123
amount
​number · float

Talep edilen ürün miktarı.

Example: 1
reason
​string · maxLength: 1024

Sipariş iptal talebi sebebi. Tanımlı dört seçenekten biri seçilmelidir.

Example: Ürünü iade etmek istiyorum.
details
​string · maxLength: 1024

Talebin detaylı açıklaması.

Example: Ürünü iade etmek istiyorum. Çünkü ürünü beğenmedim.
createdAt
​string · date-time

Sipariş iptal talebi kalemi nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Sipariş iptal talebi kalemi nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

OrderRefundRequest

status
​string · enum · required

Sipariş iptal talebinin durumu. Seçenekler: | approved: Onaylandı. | waiting_for_approval: Onay bekliyor. | cancelled: İptal edildi.

Enum values:
approved
waiting_for_approval
cancelled
refundReasonOrderSpecial1
refundReasonOrderSpecial2
Example: approved
autoPayback
​integer · enum · required

Otomatik geri ödeme durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Sipariş iptal talebi nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Sipariş iptal talebi için oluşturulan benzersiz kod değeri.

Example: KOD-1234
fee
​number · float

Müşteriye ödenecek tutar bilgisi.

Example: 15
shippingFee
​number · float

Kargo tutarı.

cancellationReason
​string · maxLength: 512

Sipariş iptal talebinin sebebine dair detaylı açıklama.

Example: Ürün kusurlu.
​OrderSummary

Sipariş detay objesi

​OrderRefundRequestItemSummary[]

Sipariş iptal talebi kalemleri.

createdAt
​string · date-time

Sipariş iptal talebi nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Sipariş iptal talebi nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

OrderItemSubscription

Sipariş kalemi ile ilişkili abonelik bilgilerini temsil eder.
id
​integer

Sipariş kalemi aboneliğine ait benzersiz kimlik numarası.

Example: 123
​SubscriptionSummary

OrderItemCustomization

Sipariş kalemi özelleştirme değerleri objesi
id
​integer

Özelleştirme için benzersiz kimlik

Example: 123
productCustomizationGroupId
​integer

Ürün özelleştirme grubu kimliği

Example: 45
productCustomizationGroupName
​string · maxLength: 255

Özelleştirme grup adı

Example: Sertifika Özelleştirme
productCustomizationGroupSortOrder
​integer

Grup sıralama değeri

Example: 999
productCustomizationFieldId
​integer

Özelleştirme alanı kimliği

Example: 123
productCustomizationFieldType
​string · enum · maxLength: 255

Alan tipi

Enum values:
text
textarea
file
dropdown
radio
checkbox
Example: text
productCustomizationFieldName
​string · maxLength: 255

Alan adı

Example: Sertifika Düzenlenen Kişi
productCustomizationFieldValue
​string · maxLength: 255

Müşterinin girdiği değer

Example: Ahmet Yılmaz
productCustomizationFieldPath
​string · uri · maxLength: 255

Dosya tipi alanlar için dosya yolu

Example: /uploads/customizations/certificate.pdf
cartItemAttributeId
​integer

İlişkili sepet kalemi özellik kimliği

Example: 789
isCloudFile
​integer

Dosyanın bulut depolama kullanıp kullanmadığı

cloudContentUrl
​string · uri

Bulut depolama dosya URL'i

Example: https://cdn.example.com/file.pdf
​object · writeOnly

OrderItem

productName
​string · maxLength: 255 · required

Siparişteki ürünün adı.

Example: Kalem
productSku
​string · maxLength: 255 · required

Ürünün stok kodu (SKU).

Example: KAL-1234
productPrice
​number · float · min: 0 · required

Ürünün birim fiyatı.

Example: 15
productCurrency
​string · maxLength: 32 · required

Ü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ı

Example: TL
productQuantity
​number · float · min: 0 · required

Siparişteki ürün adedi (stok tipi cinsinden).

Example: 1
productTax
​number · float · min: 0 · required

Ürünün vergi oranı (yüzde cinsinden).

Example: 18
productDiscount
​number · float · min: 0 · required

Ürüne uygulanan standart indirim miktarı.

Example: 5
id
​integer

Sipariş kaleminin benzersiz kimlik (ID) değeri.

Example: 123
productBarcode
​string · maxLength: 255

Ürünün barkod numarası.

Example: 869456789874
productMoneyOrderDiscount
​number · float · min: 0

Havale/EFT ile ödemede uygulanan indirim miktarı.

Example: 5
productWeight
​number · float · min: 0

Ürünün ağırlığı (kg veya ilgili stok tipi birimi).

Example: 1.2
productStockTypeLabel
​string · maxLength: 255

Ürünün stok tipi etiketi (ör. adet, kg, paket).

Example: Adet
isProductPromotioned
​integer · enum

Ürünün promosyon olup olmadığını belirten değer. Seçenekler: | 0: Ürün promosyon değil | 1: Ürün promosyon

Enum values:
0
1
Example: 0
discount
​number · float · min: 0

Ürüne uygulanan hediye çeki indirim değeri.

Example: 5
​OrderSummary

Sipariş detay objesi

​ProductSummary

Ürün detay objesi

​OrderItemCustomizationSummary[]

Sipariş kalemine uygulanan özelleştirmeler (OrderItemCustomization şeması ile ilişkili).

​OrderItemSubscriptionSummary

Sipariş kalemi ile ilişkili abonelik bilgilerini temsil eder.

OrderDetail

varKey
​string · maxLength: 255 · required

Sipariş detayı için değişken anahtarı (örn. ödeme veya teslimat bilgisi)

Example: bank_account_detail
varValue
​string · maxLength: 65535 · required

Değişkene ait değer, genellikle JSON formatında detaylı bilgi içerir

Example: {"branch_name":"Tuzla/İstanbul","branch_code":"238","account_name":"Ideasoft Kurumsal","account_code":"123123","account_type":"Kurumsal","uses_iban":"0"}
id
​integer

Sipariş detayı nesnesinin kimlik değeri

Example: 123
​OrderSummary

Sipariş detay objesi

OrderCustomTaxLine

Sipariş özel vergi satırı objesi
name
​string · maxLength: 255 · required

Özel vergi adı

Example: Özel Tüketim Vergisi
value
​number · decimal · min: 0 · required

Vergi tutarı

Example: 15.5
currency
​string · maxLength: 255 · pattern: ^[A-Z]{3}$ · required

Para birimi kodu

Example: TRY
id
​integer

Vergi satırı için benzersiz kimlik

Example: 789
​OrderSummary

Sipariş detay objesi

Order

Sipariş detay objesi
id
​integer · required

Sipariş için benzersiz kimlik

Example: 123
customerFirstname
​string · maxLength: 255

Müşteri adı

Example: Ahmet
customerSurname
​string · maxLength: 255

Müşteri soyadı

Example: Yılmaz
customerEmail
​string · email

Müşteri e-posta adresi

Example: ahmet.yilmaz@example.com
customerPhone
​string

Müşteri telefon numarası

Example: +90 (216) 326 04 77
paymentTypeName
​string · maxLength: 128

Ödeme yöntemi adı

Example: Havale
paymentProviderCode
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı kodu (sistem otomatik atar)

Example: MoneyOrder
paymentProviderName
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı adı (sistem otomatik atar)

Example: Havale
paymentGatewayCode
​string · maxLength: 255 · readOnly

Ödeme gateway kodu (sistem otomatik atar)

Example: ideabank_1
paymentGatewayName
​string · maxLength: 255 · readOnly

Ödeme gateway adı (sistem otomatik atar)

Example: IdeaBank
bankName
​string · maxLength: 128 · readOnly

Banka adı (sistem otomatik atar)

Example: IdeaBank
clientIp
​string · ipv4 · maxLength: 40

Müşterinin IP adresi

Example: 192.168.1.1
userAgent
​string · maxLength: 1024

Tarayıcı ve cihaz bilgisi

Example: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.167 Safari/537.36
currency
​string · enum

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
currencyRates
​string · maxLength: 65535

İşlem anındaki döviz kurları (JSON string)

Example: {"TL":[1,1],"USD":[3.7698,3.7766],"EUR":[4.6575,4.6659],"GBP":[5.2597,5.2872]}
amount
​number · decimal · min: 0

Vergi hariç toplam tutar

Example: 100
couponDiscount
​number · decimal · min: 0

Hediye çeki indirim tutarı

Example: 0
taxAmount
​number · decimal · min: 0

Toplam vergi tutarı

Example: 18
totalCustomTaxAmount
​number · decimal · min: 0

Özel vergi toplam tutarı

Example: 0
promotionDiscount
​number · decimal · min: 0

Promosyon indirim tutarı

Example: 0
generalAmount
​number · decimal · min: 0

Genel toplam (ürün + vergi + kargo + ek hizmet - indirimler)

Example: 125
shippingAmount
​number · decimal · min: 0

Kargo ücreti

Example: 15
additionalServiceAmount
​number · decimal · min: 0

Ek hizmet bedeli (hediye paketi vb.)

Example: 0
finalAmount
​number · decimal · min: 0

Son ödeme tutarı (taksit farkı dahil)

Example: 125
sumOfGainedPoints
​number · decimal · min: 0

Kazanılan toplam puan

Example: 200
installment
​integer · min: 0

Taksit sayısı

Example: 3
installmentRate
​number · decimal · min: 0

Taksit oranı (1.0 = vade farkı yok)

Example: 1.05
extraInstallment
​integer · min: 0

Ekstra kampanya taksit sayısı

Example: 0
transactionId
​string · maxLength: 255

Benzersiz işlem numarası

Example: c88728ce28151
hasUserNote
​integer · enum

Müşteri notu var mı?

Enum values:
0
1
Example: 0
status
​string · enum

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: waiting_for_approval
paymentStatus
​string · enum

Ödeme işlem durumu

Enum values:
in_transaction
failed
success
Example: success
errorMessage
​string · maxLength: 65535

Hata mesajı (başarısız işlemler için)

Example: Limit yetersiz
sessionId
​string · maxLength: 255 · writeOnly

Oturum kimliği

Example: abc123def456
deviceType
​string · enum

Sipariş verildiği cihaz tipi

Enum values:
desktop
mobile
tablet
Example: desktop
referrer
​string · maxLength: 65535

Yönlendiren web sitesi URL'i

Example: www.referrer.com
invoicePrintCount
​integer · min: 0

Fatura çıktısı alınma sayısı

Example: 1
useGiftPackage
​integer · enum

Hediye paketi tercihi

Enum values:
0
1
Example: 0
giftNote
​string

Hediye notu

Example: Doğum günün kutlu olsun
giftAmount
​number · float · min: 0
memberGroupName
​string · maxLength: 255

Üye grubu adı

Example: Üyeliksiz alışveriş
usePromotion
​integer · enum

Promosyon kullanım durumu

Enum values:
0
1
Example: 0
shippingProviderCode
​string · maxLength: 255 · readOnly

Kargo sağlayıcı kodu (sistem otomatik atar)

Example: idea
shippingProviderName
​string · maxLength: 255 · readOnly

Kargo sağlayıcı adı (sistem otomatik atar)

Example: Idea Cargo
shippingCompanyName
​string · maxLength: 255 · readOnly

Kargo firması adı (sistem otomatik atar)

Example: Idea Cargo
shippingPaymentType
​string · enum

Kargo ödeme tipi

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
shippingTrackingCode
​string · maxLength: 255

Kargo takip kodu

Example: 123123IDEA
source
​string · maxLength: 255

Sipariş kaynağı (yazılım/platform)

Example: IdeaShop Payment
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​MaillistSummary
​MemberSummary

Üye hesap bilgilerini içeren obje

​OrderDetailSummary[]

Sipariş detayı nesnesi

​OrderCustomTaxLineSummary[]

Özel vergi oranları nesnesi

​OrderItemSummary[]

Sipariş kalemi nesnesi listesi

​ShippingAddressSummary

Teslimat adresi objesi

​BillingAddressSummary
​FraudOrderSummary
​PromotionSummary
autoPayback
​integer · enum · writeOnly

Otomatik iade durumu

Enum values:
0
1
Example: 0
orderItemCount
​integer
lastShipmentStatus
​integer
next
​string · writeOnly
prev
​string · writeOnly

OptionGroup

Varyant grubu objesi (renk, beden vb.)
title
​string · maxLength: 255 · required

Varyant grubu başlığı

Example: Renk
id
​integer

Varyant grubu için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255

URL dostu benzersiz tanımlayıcı

Example: renk
sortOrder
​integer · min: 0 · max: 9999

Görüntüleme sırası

Example: 999
predefined
​integer · enum · writeOnly

Sistem öntanımlı mı?

Enum values:
0
1
Example: 0
filterStatus
​integer · enum

Filtre menüsünde göster

Enum values:
0
1
Example: 1
aggregator
​integer · enum

Filtre menüde gruplanma durumu

Enum values:
0
1
Example: 0
​OptionSummary[]

Varyant seçenekleri listesi (Kırmızı, Mavi vb.)

Option

id
​integer · required

Varyant nesnesinin kimlik değeri

Example: 123
title
​string · maxLength: 255 · required

Varyant başlığı. Örneğin, Varyant Grubu renk ise bu değer "Kırmızı" olabilir.

Example: Kırmızı 1
sortOrder
​integer · min: 0 · max: 9999 · required

Varyantın sıralama değeri

Example: 999
slug
​string · minLength: 1 · maxLength: 255

Slug değeri, ilgili varyantın URL'de kullanılacak değeri

Example: kirmizi-1
logo
​string

Varyant logosu

attachment
​string · writeOnly

Varyant logosunun dosya bilgisi

imageUrl
​string

Varyant imajının URL adresi

size
​integer · enum · writeOnly

Varyant logosu boyutu (piksel) Seçenekler: | 16: 16 px | 24: 24 px | 32: 32 px | 64: 64 px | 128: 128 px

Enum values:
16
24
32
64
128
256
512
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

updatedAt
​string · date-time

Varyantın güncellenme zamanı

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Varyantın oluşturulma zamanı

Example: 2022-04-20T14:33:45+03:00

OfferedProduct

Tavsiye edilen ürün ilişki objesi
​ManualRelationSummary · required
id
​integer

İlişki için benzersiz kimlik

Example: 234

Midblock

Vitrin bloğu objesi
id
​integer · required

Vitrin bloğu için benzersiz kimlik

Example: 567
name
​string · maxLength: 255 · required

Vitrin bloğu adı

Example: Yeni Ürünler
status
​integer · enum

Blok aktiflik durumu

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 0

Görüntüleme sırası

Example: 1
productCountPerRow
​integer · enum

Satırda gösterilecek ürün sayısı

Enum values:
1
2
3
4
5
Example: 4

MetaField

Genişletilebilir meta veri objesi
type
​string · enum · maxLength: 255 · pattern: \w+:\w+ · required

Meta alan veri tipi

Enum values:
string
integer
boolean
json
text
Example: string
varKey
​string · maxLength: 255 · pattern: ^[a-z0-9_]+$ · required

Meta alan anahtarı

Example: video_url
varValue
​string · maxLength: 131070 · required

Meta alan değeri

Example: https://youtube.com/watch?v=123
contextItemId
​integer · required

İlişkili öğenin kimlik değeri

Example: 456
id
​integer

Meta alan için benzersiz kimlik

Example: 123
context
​string · enum · maxLength: 255

Meta alanın ilişkili olduğu bağlam/modül

Enum values:
banner
product
productDetail
productSpecialInfo
category
brand
blog
blogCategory
Example: product
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300

MerchantPollPref

Mağaza anketi ayarları objesi
id
​string · required

Anket ayarları için benzersiz kimlik

Example: 456
status
​integer · enum · required

Anket aktiflik durumu

Enum values:
0
1
Example: 1

MerchantPoll

id
​integer · required

Merchant anketi nesnesine ait benzersiz kimlik (ID) değeri.

Example: 456
status
​integer · enum · required

Merchant anketi nesnesinin aktif olup olmadığını belirtir. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
day
​integer · required

Anketin geçerli olduğu gün sayısı bilgisi.

Example: 7
​CategorySummary · required

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

type
​string · enum · required

Menü öğesinin tipi; hangi türde içerik gösterileceğini belirler. Seçenekler: | url: Harici veya dahili bağlantı. | page: Site içi sayfa. | category: Ürün kategorisi.

Enum values:
url
page
category
collection
title
​string · maxLength: 255 · required

Menüde görünecek başlık veya ad.

Example: Test Menü Nesnesi - 1
hasChildren
​integer · enum · required
Enum values:
0
1
id
​integer

Menü öğesinin benzersiz kimlik değeri.

Example: 1
url
​string · maxLength: 255

Menü öğesinin tıklanınca gidilecek bağlantı adresi (type=url için geçerlidir).

Example: https://test.myideasoft.ide/sayfa/mesafeli-satis-sozlesmesi
targetBlankStatus
​integer · enum

Bağlantının yeni sekmede açılıp açılmayacağını belirtir. Seçenekler: | 0: Aynı sekmede açılır. | 1: Yeni sekmede açılır.

Enum values:
0
1
rowOrder
​integer · enum

Menü öğesinin satır sırasını belirler; üstten alta sıralamada kullanılır.

Enum values:
1
2
Example: 1
sortOrder
​integer · min: 0 · max: 99

Menü öğesi içindeki genel sıralama numarası; küçük değer önce gösterilir.

Example: 1
​CategorySummary

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

​CollectionSummary

Sayfa nesnesi

tree
​string
​object
level
​integer

MemberGroupPosAccount

​InstallmentRateSummary[] · required

POS hesabı için tanımlanmış taksit oranı nesnelerinin listesi.

installmentThreshold
​number · float · maxLength: 255 · required

Taksitlerin geçerli olabilmesi için belirlenen minimum tutar.

Example: 0.0
status
​integer · enum · required

Üye Grubu Pos Hesabı nesnesinin aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 0
​MemberGroupSummary · required
​PosAccountSummary · required
id
​integer

Üye Grubu Pos Hesabı nesnesine ait benzersiz kimlik (ID) değeri.

​ExtraInstallmentSummary

Ekstra taksit seçeneği objesi

MemberGroupEmail

mailExtension
​string · maxLength: 255 · required

Üye grubuna ait e-mail uzantısı

Example: deneme.com.tr
​MemberGroupSummary · required
id
​integer

Üye grubu e-maili nesnesine ait benzersiz kimlik (ID) değeri.

createdAt
​string · date-time

Üye grubu e-maili nesnesinin oluşturulma tarihi.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Üye grubu e-maili nesnesinin güncellenme tarihi.

Example: 2022-04-20T14:33:45+03:00

MemberGroup

id
​integer · required

Üye grubu nesnesinin kimlik değeri

Example: 123
name
​string · maxLength: 255 · required

Üye grubu ismi

Example: Üyeler
priceIndex
​integer · min: 1 · max: 5

Üye grubunun fiyat indeksi (örn. Fiyat 2 için 1)

Example: 1
priceRatio
​number · float · min: 0 · max: 5

Üye grubunun fiyat indeksi ile çarpanı

Example: 1
currentAccountStatus
​integer · enum

Hesabın aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
ideapayStatus
​integer · enum

Ideapay aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
​object

Üye grubuna izin verilen ödeme kanalları

Example: Custom, CreditCard, MailOrder ...

MemberAddress

Üye adresi objesi
id
​integer

Adres için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Adres tanımlayıcı adı

Example: Ev
type
​string · enum

Adres tipi

Enum values:
shipping
billing
Example: shipping
firstname
​string · maxLength: 255

Adı

Example: Ahmet
surname
​string · maxLength: 255

Soyadı

Example: Yılmaz
address
​string · maxLength: 65535

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
zipCode
​string · maxLength: 64
subLocationName
​string · maxLength: 255

İlçe adı

Example: Üsküdar
locationName
​string · maxLength: 255

Şehir adı

Example: İstanbul
phoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
taxNumber
​string · maxLength: 255 · pattern: ^[0-9]{10}$

Vergi numarası (kurumsal faturalar için)

Example: 1966712049
taxOffice
​string · maxLength: 255

Vergi dairesi (kurumsal faturalar için)

Example: Üsküdar
invoiceType
​string · enum · maxLength: 255

Fatura tipi

Enum values:
individual
corporate
Example: individual
isEinvoiceUser
​boolean · enum

E-fatura kullanıcısı mı?

Enum values:
Example: true
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​MemberSummary

Üye hesap bilgilerini içeren obje

​CountrySummary
​LocationSummary
​TownSummary

İlçe nesnesi

Member

Üye hesap bilgilerini içeren obje
id
​integer · required

Üye için benzersiz kimlik

Example: 123
firstname
​string · maxLength: 255

Üyenin adı

Example: Ahmet
surname
​string · maxLength: 255

Üyenin soyadı

Example: Yılmaz
email
​string · email

Üyenin e-posta adresi

Example: ahmet.yilmaz@example.com
password
​string · password · maxLength: 255 · writeOnly

Üye hesap şifresi (şifrelenmiş)

gender
​string · enum

Cinsiyet bilgisi

Enum values:
male
female
unspecified
Example: male
birthDate
​string · date-time

Doğum tarihi

Example: 1988-02-21T00:00:00+0000
phoneNumber
​string · maxLength: 32

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · maxLength: 32

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
status
​string · enum

Üye hesap durumu

Enum values:
queue
active
passive
suspended
Example: active
kvkkStatus
​integer · enum

KVKK (kişisel verilerin korunması) onay durumu

Enum values:
0
1
Example: 1
commercialName
​string · maxLength: 255

Kurumsal üyelik için şirket adı

Example: Ideasoft Yazılım San. ve Tic. A.Ş.
taxNumber
​string · minLength: 10 · maxLength: 255

Vergi numarası

Example: 1966712049
taxOffice
​string · maxLength: 255

Vergi dairesi

Example: Üsküdar
address
​string

Adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
​CountrySummary
​LocationSummary
locationName
​string

Şehir adı

otherLocation
​string · maxLength: 255

Alternatif şehir bilgisi

Example: Diğer şehir
district
​string · maxLength: 255

İlçe bilgisi

Example: Üsküdar
zipCode
​string · maxLength: 50

Posta kodu

Example: 34704
​MemberGroupSummary
​CurrentAccountSummary
deviceType
​string · enum

Üyelik oluştururken kullanılan cihaz tipi

Enum values:
bilgisayar
mobil
Example: mobil
deviceInfo
​string · maxLength: 65535

Detaylı cihaz bilgisi (user agent)

lastIp
​string · ipv4 · maxLength: 255

Son giriş yapılan IP adresi

Example: 192.168.1.1
pointAmount
​number · decimal

Toplam kazanılan puan miktarı

Example: 10500

Özel meta alan bilgileri

allowedToPhone
​integer · enum

Telefon ile iletişim izni

Enum values:
0
1
Example: 1
allowedToCampaigns
​integer · enum

Kampanya bildirimleri için izin

Enum values:
0
1
Example: 1
allowedToSms
​integer · enum

SMS bildirimleri için izin

Enum values:
0
1
Example: 1
lastLoginDate
​string · date-time

Son giriş yapılan tarih ve zaman

lastMailSentDate
​string · date-time

Son e-posta gönderim tarihi

allowedToPhoneUpdatedAt
​string · date-time

Telefon izni son güncellenme zamanı

allowedToCampaignsUpdatedAt
​string · date-time

Kampanya izni son güncellenme zamanı

allowedToSmsUpdatedAt
​string · date-time

SMS izni son güncellenme zamanı

createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00

ManualRelation

id
​integer · required

Nesne ilişkisi nesnesi kimlik değeri. Parent veya child olarak kullanılan nesneler arasındaki bağı tanımlamak için kullanılır.

name
​string

Nesne ilişkisi nesnesi ismi

title
​string · writeOnly

Nesne ilişkisi nesnesi başlığı

slug
​string
hasImage
​integer
status
​integer
newSortOrder
​integer

MaillistGroup

id
​integer · required

Mail listesi grubunun benzersiz kimlik değeri.

name
​string · required

Mail listesi grubunun adı.

Maillist

id
​integer · required

Mail listesi nesnesinin benzersiz kimlik değeri.

Example: 123
name
​string · maxLength: 255

Mail listesi nesnesinin adı.

Example: Mail listesi 1
email
​string

Mail adresi.

Example: mail@example.com
lastMailSentDate
​string · date-time

Son gönderim tarihi.

Example: 2022-04-18T09:15:30+03:00
creatorIpAddress
​string

Mail listesini oluşturan kullanıcının IP adresi.

Example: 10.10.10.1
​MaillistGroupSummary
createdAt
​string · date-time

Mail listesi nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Mail listesi nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

Location

id
​integer · required

Şehir nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string

Şehir nesnesi için isim değeri.

Example: İstanbul
status
​integer · enum

Şehir nesnesinin aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
​CountrySummary
​RegionSummary

Language

key
​string · required

Dil değişkeni alanı

Example: _PasswordInfo_
value
​string · required

Dil değişkenine tanımlanan değer.

Example: Şifre bilgisi
originalValue
​string

Dil değişkeninin orijinal metin değeri.

Example: Şifre en az 6 hane olmalıdır, en az bir rakam ve bir harf içermelidir.

Label

Kişisel etiket nesnesi
id
​integer · required

Kişisel etiket nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 255 · required

Kişisel etiket Adı

slug
​string · minLength: 1 · maxLength: 255

Etiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.

Example: indirimli-urunler
sortOrder
​integer · min: 0 · max: 999

Kişisel etiket nesnesi için sıralama değeri.

Example: 10
status
​integer · enum

Etiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.

Enum values:
0
1
Example: 1
hasChildren
​integer · enum

Kişisel etiket nesnesinin alt etiket barındırma durumu. Bu değer otomatik oluşturulur.

Enum values:
0
1
Example: 0
pageTitle
​string · maxLength: 255

Kişisel etiket nesnesi sayfa başlığı.

Example: Etiket 1
metaDescription
​string
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
tree
​string

Etiket hiyerarşisi ağacı. Üst ve alt etiketler arasındaki ilişkileri gösterir.

​LabelSummary

Kişisel etiket nesnesi

​object

Bu etiketin sahip olduğu alt etiketlerin listesi.

updatedAt
​string · date-time

Kişisel etiket nesnesinin son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kişisel etiket nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00

InvoiceSetting

formWidth
​string · maxLength: 255

Fatura formu toplam genişliği (cm).

formHeight
​string · maxLength: 255

Fatura formu yüksekliği (cm).

seriNoCaption
​string · maxLength: 255

Seri numarası başlığı.

orderIdCaption
​string · maxLength: 255

Sipariş numarası başlığı.

dateCaption
​string · maxLength: 255

Tarih başlığı.

irsaliyeDateCaption
​string · maxLength: 255

İrsaliye tarihi başlığı.

productLabelCaption
​string · maxLength: 255

Ürün başlığı.

stockCodeCaption
​string · maxLength: 255

Stok kodu başlığı.

barCodeCaption
​string · maxLength: 255

Barkod başlığı.

quantityCaption
​string · maxLength: 255

Miktar başlığı.

unitPriceCaption
​string · maxLength: 255

Birim fiyat başlığı.

kdvCaption
​string · maxLength: 255

KDV başlığı.

priceCaption
​string · maxLength: 255

Fiyat başlığı.

matrahCaption
​string · maxLength: 255

Matrah başlığı.

subTotalCaption
​string · maxLength: 255

Ara toplam başlığı.

totalAmountCaption
​string · maxLength: 255

Genel toplam başlığı.

taxDesignCaption
​string · maxLength: 255

KDV tutar başlığı.

priceStringCaption
​string · maxLength: 255

Yazı ile fiyat başlığı.

generalBillingDesign
​string · maxLength: 255

Genel toplam tasarımı.

logoCaption
​string · maxLength: 255

Logo başlığı.

logoSource
​string · maxLength: 255

Logo kaynak dosyası.

addressCaption
​string · maxLength: 255

Adres başlığı.

address
​string · maxLength: 255

Adres bilgisi.

phoneCaption
​string · maxLength: 255

Telefon başlığı.

faxCaption
​string · maxLength: 255

Faks başlığı.

buyerCaption
​string · maxLength: 255

Alıcı bilgileri başlığı.

taxPlaceCaption
​string · maxLength: 255

Vergi dairesi başlığı.

taxIdCaption
​string · maxLength: 255

Vergi numarası başlığı.

tcIdCaption
​string · maxLength: 255

TC kimlik numarası başlığı.

buyerInformation
​string · maxLength: 255

Alıcı bilgileri.

invoiceNoteCaption
​string · maxLength: 255

Fatura notu başlığı.

invoiceNote
​string · maxLength: 255

Fatura notu içeriği.

fontSize
​string · maxLength: 255

Fatura font boyutu (px).

productContainerHeight
​string · maxLength: 255

Ürün içerik alanı yüksekliği.

paymentTypeCaption
​string · maxLength: 255

Ödeme tipi başlığı.

stockTypeCaption
​string · maxLength: 255

Teslimat adresi başlığı.

shippingAddressCaption
​string · maxLength: 255

Teslimat adresi etiketi.

singleFormWidth
​string · maxLength: 255

Tek fatura formu genişliği (cm).

divider
​string · maxLength: 255

İki fatura arası boşluk genişliği (cm).

irsaliyeNumberCaption
​string · maxLength: 255

İrsaliye numarası başlığı.

customTaxDesignCaption
​string · maxLength: 255

Ek vergi tutar başlığı.

InstallmentRate

installment
​integer · min: 1 · max: 36 · required

Taksit oranına ait taksit sayısı.

Example: 3
rate
​number · float · required

Taksit oranı değeri. Ödeme tutarı bu oranla çarpılır.

Example: 1.05
id
​integer

Taksit oranı nesnesinin benzersiz kimlik değeri.

Example: 1
​PaymentGatewaySummary

FraudRisk

Sipariş doğrulama için dolandırıcılık risk değerlendirme objesi
id
​integer · required

Dolandırıcılık risk kaynağı için benzersiz kimlik

Example: 12345
firstname
​string · maxLength: 255

Sipariş ile ilişkili ad

Example: Ahmet
surname
​string · maxLength: 255

Sipariş ile ilişkili soyad

Example: Yılmaz
email
​string · email

Sipariş için kullanılan e-posta adresi

Example: ahmet.yilmaz@example.com
phoneNumber
​string · minLength: 10 · maxLength: 20 · pattern: \D*(?:\d\D*){10,12}

Sipariş ile ilişkili telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 10 · maxLength: 20 · pattern: \D*(?:\d\D*){10,12}

Sipariş ile ilişkili cep telefonu numarası

Example: +90 (555) 555 55 55
identityRegistrationNumber
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
ip
​string · ipv4 · pattern: \b(?:\d{1,3}\.){3}\d…

Siparişin verildiği IP adresi

Example: 192.168.1.1
taxNo
​string · minLength: 10 · maxLength: 11

Vergi kimlik numarası

Example: 1234567890
note
​string · maxLength: 255

Risk değerlendirmesi hakkında ek notlar

Example: Yüksek risk kriteri tespit edildi
updatedAt
​string · date-time

Kaydın son güncellenme tarihi ve zamanı

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kaydın oluşturulma tarihi ve zamanı

Example: 2022-04-20T14:33:45+03:00

FraudOrder

​FraudRiskSummary · required

Sipariş doğrulama için dolandırıcılık risk değerlendirme objesi

id
​integer

Riskli sipariş nesnesi kimlik değeri.

​OrderSummary

Sipariş detay objesi

FormSetting

varKey
​string · enum · required

Form alanı ayar seçeneği Seçenekler: | attributes: Form alanı özelliği

Enum values:
attributes
varValue
​string · required

Form alanı ayar seçeneği değeri

FormOption

name
​string · maxLength: 255 · required

Form alanı seçeneği kimlik değeri

Example: gender
marked
​integer · enum · required

Form alanı işaretlenme durumu

Enum values:
0
1
Example: 1
value
​string · maxLength: 255

Form alanı seçeneği değeri

Example: male

FormField

type
​string · enum · maxLength: 255 · required

Form alanının tipi (ör. text, select, checkbox, radio, textarea vb.).

Enum values:
textbox
textarea
dropdown
radiobox
checkbox
info
name
​string · maxLength: 255 · required

Form alanının benzersiz ismi veya anahtar adı.

isRequired
​integer · enum · required

Form alanının zorunlu olup olmadığını belirler. Seçenekler: | 0: Devre dışı (alan doldurulması opsiyonel). | 1: Etkin (alan doldurulması zorunlu).

Enum values:
0
1
​FormOptionSummary[] · maxItems: 10 · required

Alanın seçeneklerini içeren liste (sadece select/radio/checkbox gibi çoklu seçim alanları için geçerlidir).

​FormSettingSummary[] · required

Form alanına özel ek ayarlar veya yapılandırma parametrelerini içeren nesne (ör. placeholder, maxLength, validation pattern vb.).

Form

Form tanımı ve yapılandırma objesi
name
​string · maxLength: 255 · required

Form adı/başlığı

Example: İletişim Formu
​FormFieldSummary[] · required

Form alanları listesi

status
​integer · enum · required

Form aktiflik durumu

Enum values:
0
1
Example: 1
blockStatus
​integer · enum · required

Blok olarak görüntüleme durumu

Enum values:
0
1
Example: 1
language
​string · required
id
​integer

Form için benzersiz kimlik

Example: 101
formKey
​string · maxLength: 255
info
​string
updatedAt
​string · date-time
createdAt
​string · date-time

FilterMenuSetting

Filtre bloğu ayarlarını temsil eder.
id
​integer

Filtre bloğu seçeneğine ait benzersiz kimlik numarası.

Example: 101
varKey
​string · maxLength: 255

Filtre bloğu seçeneğinin anahtar değeri.

Example: brand_sort_order_type
varValue
​string · maxLength: 255

Filtre bloğu seçeneğinin değerini belirtir.

Example: count
​object · writeOnly

FilterMenu

name
​string · maxLength: 255 · required

Filtre bloğu nesnesi ismi.

Example: Renk Filtresi
id
​integer

Filtre bloğu nesnesi kimlik değeri.

Example: 456
sortOrder
​integer · min: 0 · max: 999

Sıralama seçeneği.

Example: 2
updatedAt
​string · date-time

Filtre bloğu nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
status
​integer · enum

Filtre bloğu kullanım durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1

Filtre bloğu seçenekleri nesnesi.

FavouritedProduct

id
​integer

Favori ürün nesnesine ait benzersiz kimlik (ID) değeridir.

Example: 123
​MemberSummary

Üye hesap bilgilerini içeren obje

​ProductSummary

Ürün detay objesi

createdAt
​string · date-time

ExtraPref

useShippingSystem
​integer · enum · required

Kargo modülünün aktif olup olmadığını belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
usePaymentAgreement
​integer · enum · required

Satış sözleşmesinin ödeme sırasında zorunlu olup olmadığını belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
​CurrencySummary · required
​OrderRefundSummary · required

Sipariş iade bilgisi objesi

useBrandSystem
​integer · enum

Ürünlerde marka bilgisinin kullanılıp kullanılmayacağını belirler. Seçenekler: | 0: Devre dışı (marka alanı gösterilmez). | 1: Etkin (marka bilgisi ürün detay ve liste sayfalarında gösterilir).

Enum values:
0
1
usePriceSystem
​integer · enum

Üye girişi yapmayan ziyaretçilere fiyat bilgisinin gösterilip gösterilmeyeceğini belirler. Seçenekler: | 0: Devre dışı (fiyatlar sadece giriş yapmış kullanıcılara görünür). | 1: Etkin (fiyatlar herkese görünür).

Enum values:
0
1
useCreditcardSystem
​integer · enum

Kredi kartı ile ödeme seçeneğinin etkin olup olmadığını belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useMailorderSystem
​integer · enum

Mail order ile ödeme seçeneğinin etkin olup olmadığını belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
defaultTaxRate
​number · float · min: 0

Varsayılan KDV oranı (ondalık sayı, yüzde cinsinden).

Example: 18.0
productGroupMenuType
​string · enum

Ürün kategorileri menüsünün varsayılan görselleştirme tipini belirler. Seçenekler: | right_expand_menu: Kategoriler sağa açılır liste olarak gösterilir. | right_expand_menu_with_image: Kategoriler sağa açılır, yanında görsel gösterilir. | collapsable_menu: Katlanabilir (açılır/kapanır) menü. | standart_menu: Standart liste menü. | accordion_menu: Akordeon menü. | two_collapsable_menu: Çift katmanlı katlanabilir menü.

Enum values:
right_expand_menu
right_expand_menu_with_image
collapsable_menu
standart_menu
accordion_menu
two_collapsable_menu
useBanktransferSystem
​integer · enum

Havale/EFT ile ödeme seçeneğini açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useExtraRate
​integer · enum

Taksit seçeneklerinde ek vade farkı kullanımını açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
approveOfflinePayments
​integer · enum

Offline ödemelerin (havale/mail order vb.) otomatik onaylanıp onaylanmayacağını belirler. Seçenekler: | 0: Devre dışı (manuel onay gerekir). | 1: Etkin (otomatik onay).

Enum values:
0
1
displayNostockProduct
​integer · enum

Stokta olmayan ürünlerin vitrin/liste sayfalarında görünüp görünmeyeceğini belirler. Seçenekler: | 0: Devre dışı (stokta olmayan ürünler gizlenir). | 1: Etkin (stokta olmayan ürünler listelenir).

Enum values:
0
1
displayNostockProductView
​integer · enum

Stokta olmayan ürünlerin URL üzerinden erişildiğinde gösterilip gösterilmeyeceğini belirler. Seçenekler: | 0: Gösterme (404 veya yönlendirme yapılır). | 1: Göster (sadece direkt URL ile ulaşılırsa görünür).

Enum values:
0
1
infiniteScroll
​integer · enum
Enum values:
0
1
defaultImageSizeOnShowcase
​integer · enum

Vitrindeki ürün görsellerinin varsayılan boyutu. Seçenekler: | 120: 120x120 px | 180: 180x180 px | 240: 240x240 px | 300: 300x300 px | 360: 360x360 px | 480: 480x480 px | 600: 600x600 px

Enum values:
120
180
240
300
360
480
600
960
productRecordPerPage
​integer · min: 1 · max: 60

Ürün listeleme sayfalarında gösterilecek ürün adedi.

Example: 30
useTabMidblockSystem
​integer · enum

Vitrin bloklarının sekmeli (tab) olarak kullanılıp kullanılmayacağını belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
usePointSystem
​integer · enum

Puan/ödül sistemi kullanımını açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useInvitationSystem
​integer · enum

Davet sistemi (arkadaşını davet et) modülünün aktif olup olmadığını belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
usePromotionSystem
​integer · enum

Promosyon kodu kullanımını açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useTokenSystem
​integer · enum

Hediye çeki/kod kullanımını açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
siteStatus
​string · enum

Sitenin genel durumunu belirtir. Seçenekler: | active: Site yayında. | under_construction: Site yapım aşamasında.

Enum values:
active
under_construction
orderWithoutRegistration
​integer · enum

Üyelik oluşturmadan misafir kullanıcı olarak sipariş verilmesine izin verilip verilmediğini belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
memberActivationSystemType
​string · enum

Yeni üyeliklerde aktivasyon yöntemi. Seçenekler: | closed: Aktivasyon kullanılmaz. | individual: Kullanıcı e-posta/SMS ile aktivasyon yapar. | admin: Yönetici aktivasyonu gerekir.

Enum values:
closed
individual
admin
memberSignup
​integer · enum

Yeni üyelik oluşturma özelliği. Seçenekler: | 0: Devre dışı (yeni üyelik alınmaz). | 1: Etkin (kayıt açık).

Enum values:
0
1
defaultStatusOfProductComment
​integer · enum

Ürün yorumlarının varsayılan onay durumu. Seçenekler: | 0: Devre dışı (yorumlar onay bekler). | 1: Etkin (yorumlar otomatik yayınlanır).

Enum values:
0
1
identityNumberRequiredInOrder
​integer · enum

Siparişlerde TC kimlik numarası zorunluluğunu belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
usePaymentSystem
​integer · enum

Genel ödeme sisteminin aktif olup olmadığını belirler. Seçenekler: | 0: Devre dışı (ödeme yapılamaz). | 1: Etkin.

Enum values:
0
1
filterMenuDelay
​integer · enum

Filtreleme menüsündeki seçim sonrası gecikme süresi (saniye). Seçenekler: | 0: 0 | 1: 1 | 2: 2 | 3: 3

Enum values:
0
1
2
3
useFilterBlockMenu
​integer · enum

Filtreleme bloğunun kullanılıp kullanılmayacağını belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useProductAttributeSystem
​integer · enum

Ürün özelliklerinin (renk, beden vb.) kullanımını açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
usePrivateShoppingSystem
​integer · enum

Zorunlu üyelik sistemi. Aktif olduğunda sadece giriş yapmış kullanıcılar siteyi görüntüleyebilir. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useSeoTagsSystem
​integer · enum

SEO etiket sistemini açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useCargoTrackingSystem
​integer · enum

Kargo takip modülünü açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
minimumOrderAmount
​number · float · min: 0

Minimum sipariş tutarı (para birimi ana para birimine göre).

minimumOrderAmountTaxStatus
​integer · enum

Minimum sipariş tutarının vergi dahil/dahil değil durumunu belirler. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
defaultTaxTypeStatus
​integer · enum
Enum values:
0
1
​CriticalStockSummary
useProductImageOptimization
​integer · enum

Görsellerin otomatik optimizasyonunu açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useCurrencyAutoUpdateSystem
​integer · enum

Döviz kurlarının otomatik güncellenmesini açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useOfferedProduct
​integer · enum

Tavsiye edilen ürünlerin vitrinde gösterilip gösterilmeyeceğini belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useMaximumInstallment
​integer · enum

Ürün/kategori bazlı taksit sınırlandırma özelliğini açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
usePriceDiscountNotificationSystem
​integer · enum

Fiyat düşünce haber ver butonunun gösterilip gösterilmeyeceğini belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useOrderImage
​integer · enum

Siparişe özel görsel ekleme özelliğini açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
mobileView
​string · enum

Mobil site kullanım tipini belirler. Seçenekler: | closed: Kapalı. | phone: Sadece cep telefonu. | phone_and_tablet: Cep telefonu ve tablet.

Enum values:
closed
phone
phone_and_tablet
displayNoImagesProductOnShowcase
​integer · enum

Resimsiz ürünlerin vitrinde en sonda listelenmesini açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
filterMenuViewType
​string · enum

Filtre menüsünün görüntüleme yönünü belirler. Seçenekler: | vertical: Dikey görünüm. | horizontal: Yatay görünüm.

Enum values:
vertical
horizontal
​WatermarkSummary
​GiftPackageSummary
​WhatsappSummary

Whatsapp sipariş sistemi ayarlarını temsil eder.

​FacebookMessengerSummary
variantDisplayTypeOnShowcase
​integer · enum

Vitrinde varyantların nasıl gösterileceğini belirler. Seçenekler: | 0: Kapalı (varyantlar gösterilmez). | 1: Seçenekli olarak (dropdown/select ile gösterilir). | 2: Aynı ürün olarak (her varyant ayrı ürün gibi listelenir).

Enum values:
0
1
2
useCommentExtraDetail
​integer · enum

Ürün yorumlarında hangi alanların zorunlu olduğunu belirler. Seçenekler: | 0: Yalnızca puan zorunlu. | 1: Puan ve başlık zorunlu. | 2: Puan, başlık ve detaylı bilgi zorunlu.

Enum values:
0
1
2
variantCommentsType
​integer · enum
Enum values:
0
1
useZipCode
​integer · enum

Adreslerde posta kodu alanının kullanılıp kullanılmayacağını belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useZipCodeRequired
​integer · enum

Posta kodunun zorunlu olup olmadığını belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
​MercanSuperAppSummary
useProductImageForOption
​integer · enum
Enum values:
0
1
useDatalayer
​integer · enum

DataLayer (veri katmanı) entegrasyonunu açar/kapatır (özellikle GTM/GA için). Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
defaultStatusOfShoppingExperience
​integer · enum

Alışveriş deneyimi (yorum/anket vb.) varsayılan durumunu belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
memberSuspendAndDelete
​integer · enum
Enum values:
0
1
useRedirectLoginPage
​integer · enum

Yetkisiz kullanıcıların otomatik olarak login sayfasına yönlendirilmesini açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
excludeTaxAbroad
​integer · enum
Enum values:
0
1
useGender
​integer · enum
Enum values:
0
1
useGenderRequired
​integer · enum
Enum values:
0
1
useRepeatPassword
​integer · enum
Enum values:
0
1
useRepeatPasswordRequired
​integer · enum
Enum values:
0
1
useKvkk
​integer · enum

KVKK (kişisel verilerin korunması) onay kutusunun kullanımını açar/kapatır. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
useKvkkRequired
​integer · enum
Enum values:
0
1
memberSignupBirthdayField
​integer · enum

Üyelik formunda doğum tarihi alanının zorunlu olup olmadığını belirler. Seçenekler: | 0: Devre dışı. | 1: Etkin.

Enum values:
0
1
memberSignupBirthdayFieldRequired
​integer · enum
Enum values:
0
1
useTicketSystem
​integer · enum
Enum values:
0
1
useCellPhone
​integer · enum
Enum values:
0
1
useCellPhoneRequired
​integer · enum
Enum values:
0
1
useFeedingVariantImage
​integer · enum
Enum values:
0
1
useCategorySearchStatus
​integer · enum
Enum values:
0
1
useBrandSearchStatus
​integer · enum
Enum values:
0
1
useStockCodeSearchStatus
​integer · enum
Enum values:
0
1
useBarcodeSearchStatus
​integer · enum
Enum values:
0
1
criticalStockInfoEmail
​string
usePurchaseRequirementToProductComment
​integer · enum
Enum values:
0
1
useProductCommentImage
​integer · enum
Enum values:
0
1

ExtraInstallment

Ekstra taksit seçeneği objesi
minLimit
​number · decimal · min: 0 · required

Taksit için minimum tutar limiti

Example: 100
rangeStart
​integer · min: 0 · max: 35 · required

Taksit sayısı aralığı alt değer

Example: 3
rangeEnd
​integer · min: 0 · max: 36 · required

Taksit sayısı aralığı üst değer

Example: 6
installment
​integer · min: 0 · max: 36 · required

Ekstra taksit sayısı (banka kampanyası)

Example: 3
id
​integer

Ekstra taksit için benzersiz kimlik

Example: 890
​PaymentGatewaySummary

ExtraInfo

Ek bilgi alanı tanımı objesi
id
​integer · required

Ek bilgi için benzersiz kimlik

Example: 78
name
​string · maxLength: 255 · required

Ek bilgi alanı adı

Example: Ürün Kılavuzu
sortOrder
​integer · min: 0 · max: 99

Görüntüleme sırası (küçükten büyüğe)

Example: 1

EntityMetaField

Metafield nesnesi
customizationFieldId
​integer · required

Bu metafield'ın ait olduğu özelleştirme alanının kimlik numarası.

Example: 5
varKey
​string · maxLength: 255 · required

Metafield nesnesi seçeneği

varValue
​string · maxLength: 255 · required

Metafield nesnesi seçeneğinin değeri

id
​integer · writeOnly

Metafield nesnesine ait benzersiz kimlik numarası.

Example: 101
createdAt
​string · date-time · writeOnly

Metafield nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time · writeOnly

Metafield nesnesinin son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
Açılır menü görsel ve davranış ayarları
status
​integer · enum · required

Açılır menü aktiflik durumu

Enum values:
0
1
Example: 1
categoryLimit
​integer

Menüde gösterilecek maksimum kategori sayısı

Example: 10
columnWidth
​number · float

Toplam kolon genişliği (piksel)

Example: 1200
leftMargin
​integer

Sol kenar boşluğu (piksel)

Example: 20
menuEffect
​string · enum

Menü animasyon efekti

Enum values:
fade
show
Example: fade
openingEffect
​string · enum

Menü açılış animasyonu

Enum values:
jswing
easeInQuad
easeOutQuad
easeInOutQuad
easeInCubic
easeOutCubic
easeInOutCubic
easeInQuart
Example: easeOutQuad
closingEffect
​string · enum

Menü kapanış animasyonu

Enum values:
jswing
easeInQuad
easeOutQuad
easeInOutQuad
easeInCubic
easeOutCubic
easeInOutCubic
easeInQuart
Example: easeInQuad
openingSpeed
​number · float

Açılış animasyon hızı (milisaniye)

Example: 300
closingSpeed
​number · float

Kapanış animasyon hızı (milisaniye)

Example: 200
useCategoryImage
​integer · enum

Kategori görsellerini göster

Enum values:
0
1
Example: 1
hideThirdLevelCategories
​integer · enum
  1. seviye kategorileri gizle
Enum values:
0
1
Example: 0
useThirdLevelCategoryLimit
​integer · enum
  1. seviye kategoriler için sayı limiti kullan
Enum values:
0
1
Example: 0
thirdLevelCategoryCount
​integer

Gösterilecek maksimum 3. seviye kategori sayısı

Example: 5

DraftOrder

name
​string · maxLength: 255 · required

Manuel sipariş nesnesi için isim değeri.

Example: Test Siparişi
​CartItemSummary[] · required

Sepet kalemi nesnesi listesi

id
​integer

Manuel sipariş nesnesi kimlik değeri

code
​string · maxLength: 255

Manuel sipariş kodu

Example: 35384d65-c450-4f48-adcc-beeb638554ad
​MemberSummary

Üye hesap bilgilerini içeren obje

​CouponSummary
subTotal
​number · float

Ara toplam

Example: 42.37
couponDiscount
​number · float

Hediye çeki indirimi

Example: 5
amountWithCouponDiscount
​number · float

Hediye çeki indirimi uygulanmış toplam fiyat

Example: 37.37
shipmentAmount
​number · float

Kargo ücreti

Example: 0
customTaxAmount
​number · float

Özel vergi oranı uygulanmış fiyat

Example: 0
moneyOrderDiscountAmount
​number · float

Havale indirimi miktarı

Example: 0
taxAmount
​number · float

Vergi miktarı

Example: 6.73
amountWithTax
​number · float

Vergi eklenmiş toplam fiyat

Example: 44.1
createdAt
​string · date-time
updatedAt
​string · date-time

Distributor

Tedarikçi bilgileri objesi
id
​integer · required

Tedarikçi için benzersiz kimlik

Example: 501
name
​string · maxLength: 150 · required

Tedarikçi şirket adı

Example: ABC Tedarik Ltd. Şti.
email
​string · email · maxLength: 100

Tedarikçi iletişim e-posta adresi

Example: info@abctedarik.com
phone
​string · maxLength: 100

Tedarikçi telefon numarası

Example: +90 (212) 555 00 00
contactPerson
​string · maxLength: 200

Yetkili kişi adı soyadı

Example: Mehmet Demir

DigitalProductFile

filename
​string · maxLength: 255 · required
extension
​string · required
id
​integer
url
​string
path
​string · writeOnly
attachment
​string · writeOnly
​object · writeOnly

Ürün detay objesi

DigitalProduct

id
​integer
digitalProductFileName
​string · maxLength: 255
​DigitalProductFileSummary[]

CustomizationGroup

Özel form grup tanımı objesi
id
​integer · required

Grup için benzersiz kimlik

Example: 89
type
​string · enum · maxLength: 255 · required

Form türü

Enum values:
Member
Product
Order
Example: Member
namespace
​string · enum · maxLength: 255 · required

Form alanı bağlamı

Enum values:
Signup
Profile
Checkout
Example: Signup
sortOrder
​integer · min: 0 · max: 9999 · required

Görüntüleme sırası

Example: 1
status
​integer · enum · required

Grup aktiflik durumu

Enum values:
0
1
Example: 1
name
​string · maxLength: 255

Grup adı

Example: Üyelik Ek Bilgileri

Gruptaki form alanları listesi

​SignupPreferenceSummary[]
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300

CustomizationFieldSetting

Özel form alanlarına ait ayarları temsil eder.
varKey
​string · enum · required

Ayar türünü belirtir.

Enum values:
attributes
min_length
max_length
Example: attributes
id
​integer

Özel form alanı ayarına ait benzersiz kimlik numarası.

Example: 123
varValue
​string

Ayara ait değer veya yapılandırma.

Example: {"class":"small"}
​object · writeOnly

Özel form alanı tanımı

CustomizationFieldOption

Özel form alanı seçenek objesi
name
​string · maxLength: 255 · required

Seçenek görünen adı

Example: Küçük Boy
value
​string · maxLength: 255 · required

Seçenek değeri

Example: small
id
​integer

Seçenek için benzersiz kimlik

Example: 123
​object · writeOnly

Özel form alanı tanımı

updatedAt
​string · date-time · writeOnly

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time · writeOnly

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300

CustomizationField

Özel form alanı tanımı
name
​string · maxLength: 255 · required

Alan adı/başlığı

Example: Özel Mesaj
isRequired
​integer · enum · required

Alan zorunluluğu

Enum values:
0
1
Example: 0
type
​string · enum · required

Form alanı tipi

Enum values:
checkbox
dropdown
file
radio
textarea
textbox
Example: textbox
id
​integer

Özel form alanı için benzersiz kimlik

Example: 123
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası (küçükten büyüğe)

Example: 999
placeHolder
​string · maxLength: 255

Alan için yer tutucu metin

Example: Mesajınızı buraya yazın...
info
​string · maxLength: 255

Alan hakkında açıklayıcı bilgi

Example: Maksimum 500 karakter girebilirsiniz
​object · writeOnly

Özel form grup tanımı objesi

Seçim alanları (dropdown, radio, checkbox) için seçenek listesi

settings
​object

Alan için ek yapılandırma ayarları

updatedAt
​string · date-time · writeOnly

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time · writeOnly

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300

CustomTax

Özel vergi oranları nesnesi
name
​string · maxLength: 255 · required

Özel vergi oranının adı.

countryCode
​string · maxLength: 255 · required

Ülke nesnesi için tanımlı 2 harfli kod.

Example: TR
currencyAbbr
​string · maxLength: 255 · required

Özel vergi oranları nesnesine ait kurun kısaltması.

Example: TL
limitType
​string · enum · required

Vergi oranının uygulanabileceği limit tipi.

Enum values:
min
max
Example: min
limitValue
​number · float · min: 0 · required

Özel vergi oranları limit değeri

amountType
​string · enum · required

Vergi miktarının hangi formatta olduğunu belirtir. - "percentage": Vergi, ürün veya hizmet fiyatının yüzdesi olarak uygulanır (örn. %18 KDV). - "fixed": Vergi, sabit bir tutar olarak uygulanır (örn. 10 TL sabit vergi).

Enum values:
percentage
fixed
Example: percentage
amountValue
​number · float · min: 0 · required

Özel vergi oranları miktarı

isShippingValueIncluded
​integer · enum · required

Verginin kargo bedeline dahil olup olmadığını belirtir (0 = Dahil değil, 1 = Dahil).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Özel vergi oranının aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
id
​integer

Özel vergi oranı nesnesine ait benzersiz kimlik numarası.

Example: 123
createdAt
​string · date-time

Özel vergi oranının oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Özel vergi oranının son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

CurrentAccount

balance
​number · float · required

Cari hesap bakiyesi.

Example: 155.5
riskLimit
​number · float · min: 0 · required

Cari hesap için risk limiti.

Example: 155.5
id
​integer

Cari hesap nesnesi kimlik değeri.

Example: 123
​MemberSummary

Üye hesap bilgilerini içeren obje

code
​string · maxLength: 255

Cari hesap için düzenlenebilir kod değeri.

Example: cari-hesap-kod-ornegi
title
​string · maxLength: 255

Cari hesap başlığı.

Example: Cari Hesap Başlığı
createdAt
​string · date-time

Cari hesap nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Cari hesap nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

Currency

id
​integer · required

Kur kimlik değeri.

Example: 123
label
​string

Kur etiketi.

Example: Türk Lirası
abbr
​string

Kur kısaltması.

Example: TL
buyingPrice
​number · float · min: 0

Kur alış fiyatı.

Example: 1
sellingPrice
​number · float · min: 0

Kur satış fiyatı.

Example: 1
status
​integer · enum

Kur aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
permissionStatus
​integer · enum

Kur kullanım izni durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
isPrimary
​integer · enum

Kurun birincil kur olup olmadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
isEffective
​integer · enum

Kurun efektif kur olarak kullanılıp kullanılmadığı. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
updatedAt
​string · date-time

Kurun güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

Coupon

id
​integer · required

Hediye çeki nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Hediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.

Example: TESTKUPON123
currentUsage
​integer · min: 0

Hediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.

Example: 10
maxUsage
​integer · min: 1

Hediye çekinin toplam kullanım limiti.

Example: 100
maxUsagePerMember
​integer · min: 1

Bir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.

Example: 5
startDate
​string · date-time

Hediye çekinin geçerli olmaya başladığı tarih.

Example: 2015-04-16T00:00:00+03:00
endDate
​string · date-time

Hediye çekinin geçerlilik bitiş tarihi.

Example: 2015-05-16T00:00:00+03:00
​CreatorSummary

Nesneyi oluşturan kullanıcıyı temsil eder.

minimumCheckoutLimit
​number · float

Kuponun kullanılabilmesi için gereken minimum sepet tutarı.

Example: 100
minimumCheckoutLimitTaxIncluded
​integer · enum

Minimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
discountType
​string · enum

Kupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.

Enum values:
fixed
percentage
Example: percentage
discountValue
​number · float

Kuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)

Example: 20
discountTaxIncluded
​integer · enum

İndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
filterType
​string · enum

Kuponun hangi ürün/kategori/marka/üyelerde geçerli olacağını belirtir. Seçenekler: | all: Tüm kategori ve markalarda geçerli. | product: Belirli ürünlerde geçerli. | category: Belirli kategorilerde geçerli. | brand: Belirli markalarda geçerli. | member: Belirli üyelere özel.

Enum values:
all
product
category
brand
member
Example: category
​ProductSummary[]

Kuponun geçerli olduğu ürün nesneleri.

​CategorySummary[]

Kuponun geçerli olduğu kategori nesneleri.

Kuponun geçerli olduğu marka nesneleri.

​MemberSummary[]

Kuponun geçerli olduğu üye nesneleri.

​MemberGroupSummary
status
​integer · enum

Hediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
cargoFree
​integer · enum

Kuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
useDiscountedProducts
​integer · enum

Kuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
filterValidityType
​integer · enum

Kupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
Example: 1
couponWithoutMembership
​integer · enum
Enum values:
0
1
createdAt
​string · date-time

Hediye çekinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Hediye çekinin son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

Country

id
​integer

Ülke nesnesinin benzersiz kimlik (ID) değeri.

Example: 123
name
​string

Ülkenin adı.

Example: Türkiye
code
​string

ISO 3166-1 alpha-2 ülke kodu (2 harfli).

Example: TR
status
​integer · enum

Ülkenin aktiflik durumu. Seçenekler: | 0: Devre dışı (ülke kullanılmaz) | 1: Etkin (ülke kullanılabilir)

Enum values:
0
1
Example: 1
exportStatus
​integer · enum
Enum values:
0
1
selectedLanguage
​string
selectedCurrency
​string

ContractPlan

period
​integer · min: 0 · required

Abonelik planının periyodu(gün/hafta/ay).

Example: 1
status
​string · enum · required

Abonelik planı nesnesinin durumunu belirten değer. Seçenekler: | waiting: Beklemede | successful: Başarılı | failed: Başarısız | canceled: İptal edildi

Enum values:
waiting
successful
failed
canceled
​ContractSummary · required

Abonelik sözleşmesi objesi

id
​integer

Abonelik planı nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
message
​string · maxLength: 255

Abonelik planı nesnesi ile ilgili mesaj değeri.

periodDate
​string · date-time

Abonelik planı için geçerli tarih aralığı veya tarih bilgisi.

createdAt
​string · date-time

Abonelik planı nesnesinin oluşturulma tarihi.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Abonelik planı nesnesinin son güncellenme tarihi.

Example: 2022-04-20T14:33:45+03:00

Contract

Abonelik sözleşmesi objesi
id
​integer · required

Abonelik için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Abonelik planı adı

Example: Aylık Kahve Aboneliği
status
​string · enum

Abonelik aktiflik durumu

Enum values:
0
1
Example: 1
description
​string

Abonelik plan açıklaması

Example: 30 günde 1 olmak üzere maksimum 4 kere çekilecek. %10 indirimli ve 15 TL kargo bedeli olacaktır.
periods
​string · maxLength: 255

Abonelik periyot sayısı

Example: 1
periodFrequency
​string · enum · maxLength: 255

Periyot sıklığı

Enum values:
Daily
Weekly
Monthly
Yearly
Example: Monthly
dispatchCounts
​string · maxLength: 255

Gönderim sayısı seçenekleri (virgülle ayrılmış)

Example: 1,2,3,4
shippingAmount
​number · float · min: 0

Ek kargo ücreti

Example: 15
discount
​integer · min: 0

İndirim tutarı veya oranı

Example: 10
chosenPeriod
​integer · min: 0

Müşteri tarafından seçilen periyot

Example: Monthly
chosenDispatchCount
​integer · min: 0

Müşteri tarafından seçilen gönderim sayısı

Example: 4
paymentToken
​string

Ödeme token'ı (kart saklama için)

Example: 7ea3e413cd9ef6074a01714qwe1f6e12
firstInstallmentRate
​number · float · min: 0

İlk taksit oranı

Example: 1
​OrderItemSummary
​SubscriptionSummary
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00

CommonPref

Firma ile ilgili genel tercih ve iletişim bilgilerini temsil eder.
companyName
​string · maxLength: 255 · required

Firma Adı

Example: Firma Adınız
companyOfficialName
​string · maxLength: 255 · required

Firma Resmi Adı

Example: Firma Resmi Adınız
companyWebsite
​string · required

Firmanın web sitesi adresi.

Example: Buraya web sitesi adresi yazınız
companyRepresentative
​string · minLength: 3 · maxLength: 60 · required

Yetkili Kişi

companyPhoneNumber
​string · minLength: 7 · maxLength: 30 · required

Firma Telefon Numarası

Example: 0216002200
companyPhoneNumber2
​string · minLength: 7 · maxLength: 30 · required

Firma Telefon Numarası 2

Example: 0216002200
companyFaxNumber
​string · maxLength: 32 · required

Faks Numarası

Example: 0216002200
companyEmail
​string · email · required

Firma E-mail Adresi

Example: development@ideasoft.com.tr
orderEmail
​string · email · required

Sipariş bildirimlerinin gönderileceği e-posta adresi.

Example: development@ideasoft.com.tr
dealerPaymentSystemEmail
​string · email · required

Bayi ödeme sistemi ile ilgili e-posta adresi.

Example: development@ideasoft.com.tr
companyAddress
​string · minLength: 1 · maxLength: 500 · required

Firma Açık Adresi

Example: Firma Adresi
companyPostalCode
​string · required

Firma Posta Kodu

​CountrySummary · required
companyLocationName
​string · maxLength: 255 · required

Firmanın bulunduğu şehir adı.

Example: İstanbul
companyIdentityRegistrationNumber
​string · minLength: 0 · maxLength: 25 · required

Firma Sicil Numarası

companyTaxNumber
​string · minLength: 1 · maxLength: 255 · required

Firma Vergi Numarası

Example: 123123123
companyTaxOffice
​string · maxLength: 255 · required

Firma vergi dairesi adı

companyKepAddress
​string · minLength: 6 · maxLength: 60 · required

Firma Kep Adresi

companyMersisNumber
​string · minLength: 7 · maxLength: 30 · required

Firma Mersis No

contactUs
​string · required

İletişim alanı bilgisi.

ideapayAgreement
​string · required

Alışverişsiz Ödeme Sistemi Sözleşmesi Metni

notificationForm
​string · required

Ön Bilgilendirme Formu metni.

userAgreement
​string · required

Üyelik Sözleşmesi metni

personalDataAgreement
​string · required

KVKK Metni

paymentAgreement
​string · required

Satış Sözleşmesi metni.

refundProcedure
​string · required

İade ve İptal Prosedürü metni

salesCondition
​string · required

Satış Koşulları Metni

​LocationSummary
companyTown
​string · maxLength: 255

İlçe

favicon
​string

Tarayıcıların adres çubuğunun yanında küçük bir simge olarak gösterilir. Tüm çözünürlükte en iyi sonucu vermesi için 196x196 px boyutunda olması önerilir.

faviconAttachment
​string · writeOnly

faviconAttachment

mailLogoUrl
​string

Sistemden otomatik olarak gönderilen e-maillerde yer alacak olan logo URL'i.

mailLogoAttachment
​string · writeOnly

E-posta logosu eklemesi.

CommonFileTranslation

language
​string · required
notificationForm
​string
userAgreement
​string
personalDataAgreement
​string
paymentAgreement
​string
refundProcedure
​string
salesCondition
​string

CombineProduct

Kombin ürün ilişki objesi
​ManualRelationSummary · required
id
​integer

İlişki için benzersiz kimlik

Example: 123

Collection

id
​integer · required
name
​string · maxLength: 255 · required
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999
showcaseSortOrder
​integer · max: 500
displayShowcaseContent
​integer · enum
Enum values:
0
1
2
showcaseContent
​string
showcaseContentDisplayType
​integer · enum
Enum values:
1
2
3
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
showcaseFooterContent
​string
showcaseFooterContentDisplayType
​integer · enum
Enum values:
1
2
3
pageTitle
​string · maxLength: 255
metaKeywords
​string
metaDescription
​string
canonicalUrl
​string
​SeoSettingSummary
createdAt
​string · date-time
updatedAt
​string · date-time

ClosingProduct

id
​integer · required
​CountrySummary · required
contextId
​integer · required
context
​string · minLength: 1 · maxLength: 255
createdAt
​string · date-time

ClientWebhook

topic
​string · enum · maxLength: 255 · required

Webhook’un tetiklendiği olay.

Enum values:
product/delete
product/update
product/create
order/create
order/update
order/delete
payment/create
payment/update
Example: product/create
address
​string · maxLength: 255 · required

Olay gerçekleştiğinde POST isteği gönderilecek hedef URI.

status
​integer · enum · required

Webhook aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Webhook kimlik değeri.

​ClientSummary
createdAt
​string · date-time

Webhook oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Webhook güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

ClientPermission

scope
​string · maxLength: 65535 · required

Hangi izin olduğunu belirtir

Example: catalog_read
​ClientSummary · required
​UserSummary · required
id
​integer

Permission kimlik değeri

Example: 123
enabledByStore
​integer · enum

Mağaza sahibi tarafından aktif edilip edilmediği (0 = kapalı, 1 = açık)

Enum values:
0
1
Example: 1
installedByAppStore
​integer · enum

Bu iznin App Store’dan yüklenip yüklenmediği (0 = hayır, 1 = evet)

Enum values:
0
1
Example: 0
createdAt
​string · date-time

Oluşturulma tarihi

Example: 2025-10-02T12:34:56+03:00
updatedAt
​string · date-time

Güncellenme tarihi

Example: 2025-10-02T13:00:00+03:00

Client

name
​string · maxLength: 255 · required

Client adı.

Example: IdeasoftApp
id
​integer

Client nesnesine ait benzersiz kimlik numarası.

Example: 1
randomId
​string · minLength: 1 · maxLength: 255

Client için rastgele oluşturulmuş benzersiz kimlik.

secret
​string · minLength: 1 · maxLength: 255

Client gizli anahtarı. API erişimlerinde kullanılır.

​object

Client'ın yönlendirme URI'ları.

​object

Client için izin verilen yetkilendirme türleri.

createdAt
​string · date-time

Client nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Client nesnesinin son güncellenme zamanı.

Example: 2022-10-20T10:15:30+03:00
predefined
​boolean

Client'ın ön tanımlı olup olmadığını belirtir

Example: false

CheckoutDesignPref

Ödeme sayfası tasarım ve görünüm ayarları
useSecurityStick
​integer · enum

Güvenlik çubuğu göster

Enum values:
0
1
Example: 1
darkMode
​integer · enum

Karanlık mod (sepet sonrası tüm sipariş aşamaları için)

Enum values:
0
1
Example: 0
​FooterSummary
​object[] · maxItems: 10

Sayfa altı link listesi (maksimum 10)

CategoryMapping

​CategorySummary · required

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

type
​string · enum · maxLength: 255 · required
Enum values:
fibabanka
payWithIyzico
toslaIsimShoppingLoan
garantipay-v2
targetCategoryId
​string · maxLength: 255 · required
id
​integer
targetCategoryPath
​string · maxLength: 255

Category

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
id
​integer · required

Kategoriye ait benzersiz kimlik numarası. Sistem tarafından otomatik oluşturulur.

Example: 123
name
​string · maxLength: 255 · required

Kategori nesnesi için isim değeri.

Example: Kırtasiye
slug
​string · minLength: 1 · maxLength: 255

Slug değeri ilgili nesnenin Url değeridir.

Example: kirtasiye
sortOrder
​integer · min: 0 · max: 999

Kategori nesnesi için sıralama değeri.

Example: 999
showcaseSortOrder
​integer · max: 500
status
​integer · enum

Kategorinin aktiflik durumunu belirtir. Seçenekler: | 0: Pasif — kategori yayınlanmaz. | 1: Aktif — kategori mağazada görünür.

Enum values:
0
1
Example: 1
distributor
​string · maxLength: 255

Her zaman null değer alır. Pratikte kullanımı yoktur.

Example:
distributorCode
​string · maxLength: 255

Her zaman null değer alır. Pratikte kullanımı yoktur.

percent
​number · float · min: 0

Kategori nesnesinin fiyat katsayısı.

Example: 1
imageFile
​string · maxLength: 255

Kategori nesnesinin görselinin dosya adı. Geçerli dosya tipleri: .JPG, .PNG, .GIF

Example: kalem.jpg
displayShowcaseContent
​integer · enum

Kategori ü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.

Enum values:
0
1
2
Example: 2
showcaseContent
​string

Kategori nesnesinin üst içeriği. Admin paneli üzerinden düzenlenebilir.

Example: Üst içerik metni.
showcaseContentDisplayType
​integer · enum

Kategori 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.

Enum values:
1
2
3
Example: 2
displayShowcaseFooterContent
​integer · enum

Kategori 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.

Enum values:
0
1
2
showcaseFooterContent
​string

Kategori nesnesinin alt içeriği. Admin paneli üzerinden düzenlenebilir.

showcaseFooterContentDisplayType
​integer · enum

Kategori 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.

Enum values:
1
2
3
hasChildren
​integer · enum

Kategorinin alt kategorilere sahip olup olmadığını belirtir. Seçenekler: | 0: Var | 1: Yok

Enum values:
0
1
pageTitle
​string · maxLength: 255

Sayfanın arama motorları tarafından tespit edilebilecek başlık yazısı.

Example: Kırtasiye Ürünleri
metaDescription
​string

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string

İlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-de&#x11F;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..

Example: kategoriler/idea-kalem
tree
​string

tree

attachment
​string · writeOnly

attachment

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

​object

Alt kategori olan kategori listesi.

imageUrl
​string

Kategori nesnesinin görselinin URL'i

Example: test.myideasoft.com/test/aa/01/myassets/categories/2/Screenshot
isCombine
​integer · enum

Kategori 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

Enum values:
0
1
isSearchable
​integer · enum
Enum values:
0
1
​SeoSettingSummary
createdAt
​string · date-time

Kategorinin oluşturulma zamanı (ISO 8601 formatında).

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

CartItemSubscription

Sepet kalemi abonelik bilgisi objesi
chosenPeriod
​integer · required

Seçilen abonelik periyodu

chosenDispatchCount
​integer · required

Seçilen gönderim sayısı

Example: 12
​SubscriptionSummary · required
id
​integer

Abonelik için benzersiz kimlik

Example: 123
​object · writeOnly

CartItemAttribute

Sepet kalemine ait özellikleri temsil eder.
name
​string · maxLength: 255 · required

Özelliğin adı (örn. Renk, Boyut).

Example: Renk
value
​string · maxLength: 255 · required

Özelliğin değeri (örn. Kırmızı, Büyük).

Example: Kırmızı
id
​integer

Sepet kalemi özelliğine ait benzersiz kimlik numarası.

Example: 123
productCustomizationFieldPath
​string · maxLength: 255

Bu özelliğin ürün özelleştirme alanı yolu.

​object · writeOnly

CartItem

quantity
​number · float · min: 0 · required

Bu ürünün sepetteki adedi.

Example: 15
​ProductSummary · required

Ürün detay objesi

id
​integer

Sepet kaleminin benzersiz kimlik değeri.

Example: 123
productName
​string

Sepette yer alan ürünün adı.

Example: Kalem 2B
isProductPromotioned
​integer · enum

Ürünün bir promosyon kapsamında olup olmadığını belirtir. Seçenekler: | 0: Promosyon uygulanmamış. | 1: Promosyon uygulanmış.

Enum values:
0
1
Example: 1
price
​number · float

Sepet kaleminin birim fiyatı.

Example: 49.9
sku
​string
​object · writeOnly
​CartItemSubscriptionSummary

Sepet kalemi abonelik bilgisi objesi

Ürüne eklenen ek özellikler.

Ürüne özel yapılan özelleştirmeler (ör. yazı, renk).

updatedAt
​string · date-time

Sepet kaleminin son güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Sepet kaleminin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

Cart

id
​integer

Sepet kimlik değeri

Example: 1
sessionId
​string · maxLength: 255

Sepet oturum kimliği

Example: v7ztzjyow1wgsg4wc4csg0w4oc4o8skok4c0sg800cgwcgo8o28qc2rxchf
​MemberSummary

Üye hesap bilgilerini içeren obje

​CouponSummary
​PromotionSummary
subTotal
​number · float
couponDiscount
​number · float
amountWithCouponDiscount
​number · float
taxAmount
​number · float
amountWithTax
​number · float
promotionDiscount
​number · float
amountWithPromotionDiscount
​number · float

Sepet kalemi nesnelerini barındıran liste.

updatedAt
​string · date-time
createdAt
​string · date-time

Brand

Marka objesi
id
​integer · required

Marka için benzersiz kimlik

Example: 123
name
​string · maxLength: 255 · required

Marka adı

Example: Idea Kalem
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası

Example: 999
distributorCode
​string · maxLength: 255

Tedarikçi kodu

Example: TED-123
distributor
​string · maxLength: 255

Tedarikçi adı

Example: Super Tedarik
imageFile
​string · maxLength: 255

Marka logo dosya adı (JPG, PNG, GIF)

Example: kalem.jpg
showcaseContent
​string

Marka sayfası üst içerik metni (HTML)

Example: <p>Üst içerik metni</p>
displayShowcaseContent
​integer · enum

Üst içerik gösterim durumu

Enum values:
0
1
Example: 1
showcaseFooterContent
​string
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
metaDescription
​string

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
metaKeywords
​string

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
imageUrl
​string

Marka logo URL'i

Example: //test.myideasoft.com/test/a/01/marka/marka.jpg
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded logo verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
​SeoSettingSummary
isSearchable
​integer · enum
Enum values:
0
1
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

BlogTag

id
​integer · required

Blog etiketi nesnesinin benzersiz kimlik değeri.

Example: 123
title
​string · maxLength: 255 · required

Blog etiketi başlığı.

Example: Teknoloji
slug
​string · minLength: 1 · maxLength: 255

Etiket için oluşturulan benzersiz URL değeri. Mağaza URL’nize eklenerek sayfanın linkini oluşturur.

Example: teknoloji
pageTitle
​string · maxLength: 255
metaKeywords
​string · maxLength: 65535
metaDescription
​string · maxLength: 65535
canonicalUrl
​string · minLength: 1 · maxLength: 255

Bu değer, mağazanızdaki ilgili blog etiketi sayfasına eklenecek <link rel="canonical" href="https://www.magaza-adiniz.com/{canonical-url}" /> HTML etiketinde kullanılır. Alan adı (domain) kısmı sistem tarafından otomatik eklenir, sadece {canonical-url} kısmını belirlemeniz yeterlidir.

Example: teknoloji-yazilari
status
​integer · enum

Blog etiketinin aktiflik durumu. Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
Example: 1
createdAt
​string · date-time

Blog etiketi nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Blog etiketi nesnesinin son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

BlogCommentPref

status
​integer · enum · required

Blog yorum ayarının aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
appId
​string · maxLength: 255

Uygulama kimliği

BlogCategory

id
​integer · required

Blog kategorisi nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
title
​string · maxLength: 255 · required

Blog kategorisi başlığını belirtir.

Example: Yılbaşı Fırsatları
slug
​string · minLength: 1 · maxLength: 255

Kategori için SEO uyumlu URL (slug) değeri.

Example: yilbasi
pageTitle
​string · maxLength: 255

Blog kategorisi nesnesinin sayfa başlığı bilgisi.

Example: E-Ticaret
metaKeywords
​string · maxLength: 65535

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 65535

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
canonicalUrl
​string · maxLength: 65535

Bu değer, mağazanızdaki ilgili blog kategori sayfasına eklenecek <link rel="canonical" href="https://www.magaza-adiniz.com/{canonical-url}" /> HTML etiketinde kullanılır. Alan adı (domain) kısmı sistem tarafından otomatik eklenir, sadece {canonical-url} kısmını belirlemeniz yeterlidir.

Example: marka/idea-kalem
blockVisibility
​integer · enum

Blog kategori blokunun görünürlük durumu. (0 = Gizli, 1 = Görünür) Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
status
​integer · enum

Blog kategorisinin aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 1
hasChildren
​integer · enum

Blog kategorisi nesnesinin alt kategori barındırıp barındırmadığını gösterir. Bu değer otomatik oluşturulur.(0 = Hayır, 1 = Evet) Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 1
​object

Alt kategoriler listesi.

createdAt
​string · date-time

Blog kategorisi nesnesinin oluşturulma tarihi.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Blog kategorisi nesnesinin güncellenme tarihi.

Example: 2022-04-20T14:33:45+03:00

Blog

Blog içeriğini ve ilgili meta bilgilerini temsil eder.
title
​string · maxLength: 255 · required

Blog başlığı. Kullanıcıya ve SEO’ya uygun, dikkat çekici bir başlık olmalıdır.

Example: Yeni Ürün Lansmanı
excerpt
​string · maxLength: 65535 · required

Blog içeriğinin kısa özeti veya öne çıkan kısmı.

Example: Yeni ürünümüzle ilgili tüm detayları burada bulabilirsiniz.
blockVisibility
​integer · enum · required

Blogun vitrin veya blokta görünme durumu (0 = gizli, 1 = görünür).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Blogun aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
​BlogCategorySummary[] · required

Blogun ait olduğu kategoriler

Example: E-Ticaret
id
​integer

Blog nesnesine ait benzersiz kimlik numarası.

Example: 123
slug
​string · minLength: 1 · maxLength: 255

Blog sayfasının URL’de kullanılacak slug değeri.

Example: yeni-urun-lansmani
imageFileName
​string · maxLength: 255

Blog görselinin dosya adı. Site hızı ve SEO için JPG formatı önerilir.

Example: banner.jpg
imageExtension
​string · enum

Blog görselinin dosya uzantısı.

Enum values:
jpg
png
gif
jpeg
JPG
PNG
GIF
JPEG
Example: jpg
imageUrl
​string

Blog görselinin tam URL adresi.

Example: //test.myideasoft.com/test/a/01/blog/blog.jpg
content
​string · maxLength: 65535

Blog içeriği, HTML formatında olabilir.

Example: <p>Bu hafta yeni ürün lansmanı gerçekleşti...</p>
pageTitle
​string · maxLength: 255

Blog sayfasının başlık etiketi (SEO için önemlidir).

Example: Blog 1
metaKeywords
​string · maxLength: 65535

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 65535

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
canonicalUrl
​string · maxLength: 65535

İlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-de&#x11F;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.

Example: marka/idea-kalem
attachment
​string · writeOnly

Blog nesnesinin görselinin base64 formatına çevrilmiş resim kodu. PUT ve POST istekleri gerçekleştirlirken başında data:image/jpeg;base64, ibaresi bulunmak zorundadır. GET isteği esnasında bu değer görüntülenmeyecektir.

Blog ile ilgili etiketler, arama ve filtreleme için kullanılır.

Example: E-Ticaret
​SeoSettingSummary
createdAt
​string · date-time

Blog nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Blog nesnesinin son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

Block

name
​string · maxLength: 255 · required

Blok adı. Yönetim panelinde görüntülenecek isimdir.

Example: Ürün Grupları
position
​string · enum · required

Blok konumu. Sayfada hangi alanda yer alacağını belirtir. Seçenekler: | left: Sol tarafta gösterilir. | right: Sağ tarafta gösterilir.

Enum values:
left
right
frame
​integer · enum · required

Blok çerçeve durumu. Blok görsel olarak bir çerçeve içinde gösterilsin mi? Seçenekler: | 0: Çerçevesiz. | 1: Çerçeveli.

Enum values:
0
1
status
​integer · enum · required

Blok aktiflik durumu. Aktif olan blok mağazada gösterilir. Seçenekler: | 0: Pasif (gösterilmez). | 1: Aktif (gösterilir).

Enum values:
0
1
id
​integer

Blok nesnesi kimlik değeri. Her blok için benzersizdir.

Example: 1
sortOrder
​integer

Blok sıralama değeri. Sayfadaki blokların hangi sırada görüntüleneceğini belirler.

Example: 999
module
​string

Blok’un bağlı olduğu modül. Örneğin marka, kategori veya kampanya.

Example: brand
content
​string · maxLength: 65535

Blok içeriği. HTML veya düz metin olabilir.

Example: Bir test bloğudur.
predefined
​integer · enum

Blok’un sistem tarafından ön tanımlı olup olmadığını belirtir. Seçenekler: | 0: Sonradan kullanıcı tarafından eklenmiş blok. | 1: Sistem tarafından ön tanımlı blok.

Enum values:
0
1

Blacklist

ip
​string · maxLength: 100 · required

Engellenen IP adresi.

Example: 192.0.2.1
id
​integer

Engellenen IP kimlik değeri.

Example: 5
createdAt
​string · date-time

Engellenme zamanı.

Example: 2022-04-28T15:41:07+03:00

BillingAddress

firstname
​string · maxLength: 255 · required

Müşterinin ismi.

Example: John
surname
​string · maxLength: 255 · required

Müşterinin soy ismi.

Example: Doe
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Müşterinin ülke bilgisi.

Example: Türkiye
location
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin şehir bilgisi.

Example: İstanbul
subLocation
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin ilçe bilgisi.

Example: Üsküdar
address
​string · minLength: 5 · maxLength: 255 · required

Müşterinin adres bilgisi.

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20} · required

Müşterinin mobil telefon numarası.

Example: +90 (555) 555 55 55
invoiceType
​string · enum · required

Fatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.

Enum values:
individual
corporate
Example: individual
id
​integer

Fatura adresi nesnesi kimlik değeri.

Example: 123
phoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
​OrderSummary

Sipariş detay objesi

taxNo
​string · maxLength: 64

Fatura için vergi numarası.

Example: 4996725041
taxOffice
​string · maxLength: 255

Fatura için vergi dairesi.

Example: Üsküdar
identityRegistrationNumber
​string · minLength: 11 · maxLength: 11

Müşterinin T.C. Kimlik numarası.

Example: 11111111111
name
​string · maxLength: 255 · required

Banner nesnesinin görünen adı.

Example: ana banner123
targetBlankStatus
​integer · enum · required

Banner bağlantısının yeni sekmede açılıp açılmayacağını belirten durum bilgisidir.( 0 = Aynı sekmede aç, 1 = Yeni sekmede aç) Seçenekler: | 0: Pasif (aynı sekmede açılır). | 1: Aktif (yeni sekmede açılır).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Banner nesnesinin aktif olup olmadığını belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
id
​integer

Banner nesnesine ait benzersiz kimlik (ID) değeri.

Example: 5
imageFile
​string

Banner nesnesine ait görselin dosya adıdır. Site hızı ve seo skorunuz için yüklemiş olduğunuz görselin JPG formatında olmasını öneriyoruz.

Example: banner.jpg
imageUrl
​string

Banner görselinin tam URL adresidir.

Example: //test.myideasoft.com/test/a/01/banner/banner.jpg
targetUrl
​string

Banner tıklandığında yönlendirme yapılacak bağlantı (URL) bilgisidir.

Example: https://www.ideasoft.com.tr/yardim/
altAttribute
​string · maxLength: 255

Banner nesnesine ait görselin alt etiketi (alternatif metin) değeridir.

Example: İdeasoft Yardım
attachment
​string · writeOnly

Banner dosyasına ait ek/medya nesnesi bilgisidir.

updatedAt
​string · date-time

Banner nesnesinin son güncellenme tarihi.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Banner nesnesinin oluşturulma tarihi.

Example: 2022-04-20T14:33:45+03:00

Bank

Banka bilgi objesi
name
​string · maxLength: 255 · required

Banka adı

Example: T. İş Bankası
id
​integer

Banka için benzersiz kimlik

Example: 36

Asset

Tema dosya objesi
key
​string · maxLength: 255 · required

Dosya yolu/anahtarı

Example: configs/settings_data.json
contentType
​string · maxLength: 255

MIME içerik tipi

Example: application/json
createdAt
​string · date-time

Dosya oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Dosya son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
attachment
​string

Dosya içeriği (base64 encoded veya düz metin)

AppSettingPref

appId
​string · required
​object · required

ActiveCart

state
​string · maxLength: 255 · required
priceWithTax
​number · float · required
​PreOrderInfoSummary
​MemberSummary

Üye hesap bilgilerini içeren obje

customerFirstname
​string · maxLength: 255
customerSurname
​string · maxLength: 255
customerEmail
​string · maxLength: 255
updatedAt
​string · date-time

AbandonedOrder

sessionId
​string · maxLength: 255 · required

Terk edilen sepetin son durumunu belirten benzersiz kimlik değeri

Example: 8u9th2f89cgs8sw4c8wsgwgscc84kookgs4ok0gwo4sos8g4ckz8wbuviwcv
mailStatus
​integer · enum · required

Terk edilen sipariş hatırlatma e-postasının gönderilme durumu Seçenekler: | 0: Gönderilmedi | 1: Gönderildi

Enum values:
0
1
customerFirstname
​string · maxLength: 255 · required

Müşterinin adı

Example: John
customerSurname
​string · maxLength: 255 · required

Müşterinin soyadı

Example: Doe
customerEmail
​string · email · required

Müşterinin e-posta adresi

Example: johndoe@ideasoft.com.tr
priceWithTax
​number · float · required
​PreOrderInfoSummary
​MemberSummary

Üye hesap bilgilerini içeren obje

updatedAt
​string · date-time

Terk edilen sipariş nesnesinin güncellenme zamanı

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Terk edilen sipariş nesnesinin oluşturulma zamanı

Example: 2022-04-20T14:33:45+03:00

AbandonedCart

Terk edilmiş sepet objesi
sessionId
​string · maxLength: 255 · required

Oturum kimliği

Example: 8u9th2f89cgs8sw4c8wsgwgscc84kookgs4ok0gwo4sos8g4ckz8wbuviwcv
mailStatus
​integer · enum · required

Hatırlatma e-postası gönderim durumu

Enum values:
0
1
Example: 0
​MemberSummary · required

Üye hesap bilgilerini içeren obje

priceWithTax
​number · float · required
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00

CountResponse

Kayıt sayısı yanıtı.
total_count
​integer · required

Filtrelere uyan toplam kayıt sayısı.

Error

Hata yanıtı.
code
​integer · required

HTTP durum kodu.

errorMessage
​string · required

Hata mesajı. x-ideasoft-locale istek başlığına göre çevrilir.

errorCode
​integer · required

Uygulamaya özgü hata kodu. Doğrulama hatalarında 300001, tanımsız hatalarda 0.

errors
​

Doğrulama hataları. Admin API alan adı → mesaj nesnesi, Store API {alan adı: mesaj} nesnelerinden oluşan dizi döner.

redirectUri
​string

Yalnız OAuth yönlendirme hatalarında dönen yönlendirme adresi.

OAuthError

OAuth yetkilendirme hatası (erişim belirteci eksik, geçersiz veya süresi dolmuş).
error
​string · required

OAuth hata kodu (örn. access_denied, invalid_grant).

error_description
​string

Hata açıklaması.

SeoDetailSummary

pageTitle
​string · maxLength: 300 · required

Sayfa başlığı.

Example: Sayfa 1
metaKeywords
​string · maxLength: 800 · required

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 800 · required

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
useAdvancedSeoOption
​integer · enum

Gelişmiş SEO ayarlarının kullanımı Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
changeFreq
​string · enum

Sayfanın değişim sıklığı. Seçenekler: | daily: Günlük. | hourly: Saatlik. | weekly: Haftalık. | yearly: Yıllık. | monthly: Aylık. | always: Her zaman. | never: Hiçbir zaman.

Enum values:
daily
hourly
weekly
yearly
monthly
always
never
Example: weekly
priority
​string · enum

Öncelik değeri Seçenekler: | 0: 0 | 1: 1 | 0.1: 0.1 | 0.2: 0.2 | 0.3: 0.3 | 0.4: 0.4 | 0.5: 0.5 | 0.6: 0.6 | 0.7: 0.7 | 0.8: 0.8 | 0.9: 0.9

Enum values:
0
0.1
0.2
0.3
0.3
0.4
0.5
0.6

WhatsappSummary

Whatsapp sipariş sistemi ayarlarını temsil eder.
status
​integer · enum

WhatsApp sipariş sisteminin aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
phoneNumber
​string · minLength: 7 · maxLength: 32

WhatsApp üzerinden mesajların gönderileceği telefon numarası.

message
​string

Mesaj

position
​string · enum

WhatsApp widget’ının sayfa üzerinde gösterileceği konum.

Enum values:
sağ
sol
Example: sol
showInHomepage
​integer · enum

WhatsApp widget’ının anasayfada gösterilip gösterilmeyeceği (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1

WatermarkSummary

status
​integer · enum

Filigran kullanım durumu. Ürün görsellerine filigran uygulanabilmesi için Görsel Optimizasyonu ayarının açık olması gerekir. 0 = Pasif, 1 = Aktif

Enum values:
0
1
Example: 1
type
​string · enum

Filigran tipi. Metin veya görsel olarak uygulanabilir. Bu ayar aktif edilmeden önce yüklenen ürünler etkilenmez. text = Metin, image = Görsel

Enum values:
text
image
Example: text
text
​string

Filigran olarak kullanılacak yazı.

Example: Örnek Filigran
textRotation
​string · enum

Filigran yazısının eğim değeri. centered_horizontal = Ortalanmış yatay, cross = Çapraz

Enum values:
centered_horizontal
cross
Example: cross
textOpacity
​string · enum

Filigran yazısının şeffaflık değeri. less = Az belirgin, normal = Normal, much = Çok belirgin

Enum values:
less
normal
much
Example: normal
textColor
​string · enum

Filigran yazısının rengi. black = Siyah, white = Beyaz

Enum values:
black
white
Example: white
imageRotation
​string · enum

Filigran görselinin eğim değeri. cross = Çapraz, straight = Ortalanmış yatay

Enum values:
cross
straight
Example: cross
imageLocation
​string · enum

Filigran görselinin konumu. left_top = Sol üst, right_top = Sağ üst, left_bottom = Sol alt, right_bottom = Sağ alt, middle = Orta

Enum values:
left_top
right_top
left_bottom
right_bottom
middle
Example: right_bottom
imageOpacity
​string · enum

Filigran görselinin şeffaflık değeri. less = Az belirgin, normal = Normal, much = Çok belirgin, full = Tam belirgin

Enum values:
less
normal
much
full
Example: normal
imageUrl
​string

Uygulanacak filigran resminin URL'si.

Example: https://example.com/watermark.png
attachment
​string · writeOnly

Uygulanacak filigran resmi dosyası.

Example: watermark.png

OrderRefundSummary

Sipariş iade bilgisi objesi
dayLimit
​integer · min: 0 · required

İade için gün limiti

Example: 14
dateOption
​string · enum · required
Enum values:
order_date
delivery_date
status
​integer · enum

İade durumu

Enum values:
0
1
Example: 0

MercanSuperAppSummary

status
​integer · enum
Enum values:
0
1
clientId
​string
clientSecret
​string
returnUrl
​string

GiftPackageSummary

status
​integer · enum
Enum values:
0
1
type
​string · enum
Enum values:
free
paid
price
​number · float
imageUrl
​string
attachment
​string · writeOnly

FacebookMessengerSummary

status
​integer · enum

Facebook Messenger kullanım durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
facebookPage
​string

Facebook sayfası bağlantısı.

showInHomepage
​integer · enum

Ana sayfada gösterim durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
position
​string · enum

Messenger bileşeninin sayfadaki pozisyonu. Seçenekler: | right: Sağ. | left: Sol.

Enum values:
right
left

CriticalStockSummary

quantity
​integer · min: 0 · required

Kritik stok seviyesi; bu miktarın altına düşerse stok uyarısı tetiklenir.

Example: 5
status
​integer · enum

Kritik stok kontrolünün aktif olup olmadığını belirtir. Seçenekler: | 0: Kritik stok pasif; uyarılar gönderilmez. | 1: Kritik stok aktif; belirlenen miktar altında uyarı oluşturulur.

Enum values:
0
1
Example: 1
email
​string

SubModel-ExtraPref-AbandonedCartSummary

firstDeliveryTime
​integer · enum · required
Enum values:
20
30
45
60
180
360
1440
status
​integer · enum
Enum values:
0
1

SignupPreferenceSummary

varKey
​string · enum
Enum values:
use_gender
use_gender_required
use_repeat_password
use_repeat_password_required
use_cell_phone
use_cell_phone_required
member_signup_birthday_field
member_signup_birthday_field_required
varValue
​integer · enum
Enum values:
0
1

CreatorSummary

Nesneyi oluşturan kullanıcıyı temsil eder.
id
​integer · required

Oluşturan kişinin benzersiz kimlik numarası.

Example: 123
username
​string

Oluşturan kişinin kullanıcı adı veya sistemde görünen adı.

type
​string · enum

Oluşturan kişinin tipi (üye veya kullanıcı).

Enum values:
user
member
Example: user

LogoSummary

align
​string · enum · required

Logonun sayfa üzerindeki hizalama konumu. Seçenekler: | left: Sol | middle: Orta | right: Sağ

Enum values:
left
middle
right
Example: middle
imageUrl
​string

Logo imajı dosyasının tam URL adresi.

Example: https://cdn.site.com/uploads/logo.png
attachment
​string · writeOnly

Logo dosyasına ait dosya bilgisi

FooterSummary

align
​string · enum · required

Görselin yatay hizalaması. Seçenekler: | left: Sol | middle: Orta | right: Sağ

Enum values:
left
middle
right
imageUrl
​string

Sayfa alt kısmında gösterilecek görselin URL değeri.

Example: https://www.magaza-adiniz.com/uploads/footer-banner.png
attachment
​string · writeOnly

Görselin sayfaya eklenme biçimi (örn. arka plan resmi).

Example: fixed

SubModel-CheckoutDesignPref-BannerSummary

align
​string · enum · required
Enum values:
left
middle
right
imageUrl
​string
attachment
​string · writeOnly

UserRolePermissionSummary

Kullanıcı rolüne ait izinleri temsil eder. Her rol için hangi işlemlere izin verildiğini belirler.
name
​string · maxLength: 255 · required

Kullanıcı rolü nesnesi ismi.

Example: product
createPermission
​integer · enum · required

Oluşturma işlemi için izin durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
readPermission
​integer · enum · required

Okuma işlemi için izin durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
updatePermission
​integer · enum · required

Güncelleme işlemi için izin durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
deletePermission
​integer · enum · required

Silme işlemi için izin durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Kullanıcı rolü izin kaydının benzersiz kimlik değeri.

Example: 101
​object

UserRole nesnesi (özet). Tüm alanlar için UserRole şemasına bakın.

createdAt
​string · date-time

Kullanıcı rolü izin kaydının oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Kullanıcı rolü izin kaydının son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

UserRoleSummary

name
​string · maxLength: 255 · required

Rol adı.

Example: Yönetici
id
​integer

Kullanıcı rolü nesnesi kimlik değeri.

Example: 12
predefined
​integer · enum

Değiştirilemez kullanıcı rolü durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
​object[]
userCount
​integer

Role sahip kullanıcı sayısı.

Example: 4
createdAt
​string · date-time

Kullanıcı rolü nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kullanıcı rolü nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

UserSummary

id
​integer

Kullanıcı nesnesinin benzersiz kimlik değeri.

Example: 123
firstname
​string · maxLength: 255

Kullanıcının adı.

Example: John
surname
​string · maxLength: 255

Kullanıcının soyadı.

Example: Doe
email
​string · email · maxLength: 255

Kullanıcının sisteme giriş ve bildirimler için kullandığı e-posta adresi.

Example: johndoe@ideasoft.com.tr
password
​string · maxLength: 255 · writeOnly · pattern: (?=.*[0-9])(?=.*[A-Z…

Kullanıcının kimlik doğrulamasında kullanılan şifre (hashlenmiş olarak saklanır).

username
​string · minLength: 4 · maxLength: 16

Sistemde kullanıcı adı olarak kullanılan benzersiz değer.

Example: yonetici
status
​integer · enum

Kullanı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ş.

Enum values:
0
1
2
Example: 1
createdAt
​string · date-time

Kullanıcı hesabının oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kullanıcı hesabında yapılan son güncellemenin zamanı.

Example: 2018-02-21T15:01:03+0300
isCustomerRepresentative
​integer · enum

Kullanıcının müşteri temsilcisi olup olmadığını belirtir. Seçenekler: | 0: Müşteri temsilcisi değil. | 1: Müşteri temsilcisi.

Enum values:
0
1
Example: 0
isOwner
​integer · enum
Enum values:
0
1
​object[]
​object

UserRole nesnesi (özet). Tüm alanlar için UserRole şemasına bakın.

mfaStatus
​integer · enum
Enum values:
0
1

TownGroupSummary

name
​string · required

İlçe grubu nesnesinin adı.

Example: Standart İlçeler
id
​integer

İlçe grubu nesnesinin benzersiz kimlik değeri.

Example: 123
status
​integer · enum

İlçe grubunun aktiflik durumu. true = Aktif, false = Pasif

Enum values:
0
1
Example: true

TownSummary

İlçe nesnesi
id
​integer · required

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · required

İlçe adı.

Example: Üsküdar
status
​integer · enum

İlçenin aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
​object

Location nesnesi (özet). Tüm alanlar için Location şemasına bakın.

​object

TownGroup nesnesi (özet). Tüm alanlar için TownGroup şemasına bakın.

TagSummary

SEO+ etiket nesnesi
id
​integer · required

SEO+ etiketi nesnesine ait benzersiz kimlik numarası

Example: 123
name
​string · maxLength: 255 · required

SEO+ etiketi nesnesi adı.

Example: ideasoft
slug
​string · maxLength: 255 · required
count
​integer · min: 0

SEO+ etiketinin kaç kez kullanıldığı bilgisi.

Example: 2
pageTitle
​string · maxLength: 255

SEO+ etiketi nesnesinin etiket başlığı.

Example: Kırmızı Kalem
metaDescription
​string

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye

TabbedMidblockSummary

id
​integer · required

Tablı vitrin blokları nesnesi kimlik değeri.

Example: 101
name
​string · maxLength: 255 · required

Blok adı.

Example: Yeni Ürünler
status
​integer · enum

Tablı vitrin bloğu aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
sortOrder
​integer · min: 0 · max: 99

Sıra numarası.

Example: 3
productCountPerRow
​integer · enum

Satırdaki ürün sayısı. Seçenekler: | 1: 1 | 2: 2 | 3: 3 | 4: 4 | 5: 5

Enum values:
1
2
3
4
5
rowCountPerPage
​integer · enum

Sayfadaki satır sayısı. Seçenekler: | 1: 1 | 2: 2 | 3: 3 | 4: 4 | 5: 5

Enum values:
1
2
3
4
5

SubscriptionSummary

id
​integer · required

Abonelik nesnesi kimlik değeri

name
​string · maxLength: 255 · required

Abonelik nesnesi adı

periods
​string · maxLength: 255

Abonelik periyodu

periodFrequency
​string · enum

Abonelik periyodu sıklığı Seçenekler: | daily: Günlük | weekly: Haftalık | monthly: Aylık

Enum values:
daily
weekly
monthly
dispatchCounts
​string · maxLength: 255

Periyot içindeki sevk sayısı. Örneğin 30 günde bir en fazla 1, 2, 3 veya 4 defa abone olunabilir

Example: 1,2,3,4
continuousSending
​integer · enum

Sürekli gönderim. Kullanıcı abonelikten çıkmadığı sürece gönderim devam eder Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
description
​string

Açıklama

status
​string · enum

Abonelik nesnesi aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
active
passive
discount
​integer · min: 0

İndirim

shippingAmount
​number · float · min: 0

Kargo ücreti

createdAt
​string · date-time

Abonelik nesnesinin oluşturulma zamanı

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Abonelik nesnesinin güncellenme zamanı

Example: 2018-02-21T15:01:03+03:00

SpecValueSummary

id
​integer · required

Ürün özelliği değeri nesnesinin benzersiz kimlik (ID) değeri.

Example: 101
name
​string · maxLength: 255 · required

Özelliğe ait görünen ad.

Example: Kırmızı
sortOrder
​integer · min: 0 · max: 999 · required

Özellik değerinin listeleme sırası (artan olarak sıralanır).

Example: 1
slug
​string · minLength: 1 · maxLength: 255

Özellik için oluşturulmuş URL uyumlu kısa ad (slug).

Example: kirmizi
logo
​string

Özellik değerine ait logo dosyasının adı veya yolu.

Example: color_red.svg
status
​integer · enum

Ö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).

Enum values:
0
1
imageUrl
​string

Özellik değerine ait görselin tam URL bilgisi.

Example: https://cdn.site.com/spec/color/red.png
attachment
​string · writeOnly

Özellik değerine ait görsel dosyası (upload edilen ham dosya bilgisi).

size
​integer · enum · writeOnly

Özellik görseli/logosu için kullanılan boyut değeri (px). Seçenekler: | 16: 16px | 24: 24px | 32: 32px

Enum values:
16
24
32
​object

SpecName nesnesi (özet). Tüm alanlar için SpecName şemasına bakın.

​object

SpecGroup nesnesi (özet). Tüm alanlar için SpecGroup şemasına bakın.

updatedAt
​string · date-time

Özellik değerinin son güncellenme tarihi (ISO 8601 formatında).

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Özellik değerinin oluşturulma tarihi (ISO 8601 formatında).

Example: 2018-02-21T09:36:03+0300

SpecNameSummary

Ürün özelliği nesnesi
id
​integer · required

Ürün özelliğine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 255 · required

Ürün özelliği adı.

Example: Kapasite
slug
​string · minLength: 1 · maxLength: 255

URL’de kullanılan özellik slug değeri.

Example: kapasite
choiceType
​string · enum

Özellik tipini belirtir.

Enum values:
singular
plural
Example: singular
sortOrder
​integer · min: 0 · max: 999

Ürün özelliği sıralaması.

Example: 999
status
​integer · enum

Ürün özelliği aktiflik durumunu belirtir (0 = Pasif, 1 = Aktif).

Enum values:
0
1
Example: 1
​object

SpecGroup nesnesi (özet). Tüm alanlar için SpecGroup şemasına bakın.

​object[]

SpecGroupSummary

Ürün özellik grubu objesi
id
​integer · required

Özellik grubu için benzersiz kimlik

Example: 123
name
​string · maxLength: 255 · required

Özellik grubu adı

Example: Cep Telefonları
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası

Example: 999
status
​integer · enum

Grup aktiflik durumu

Enum values:
0
1
Example: 1
​object[]

SliderSettingSummary

sliderEffect
​string · enum · required

Slayt geçiş tipi. Seçenekler: | slide: Kaydırma efekti | fade: Kaybolma efekti

Enum values:
slide
fade
sliderWidth
​number · float · required

Slider genişliği (px).

sliderHeight
​number · float · required

Slider yüksekliği (px).

autoStartTime
​number · float · required

Resimlerin değişme süresi (milisaniye cinsinden).

effectTime
​number · float · required

Resmin görüntülenme süresi (milisaniye cinsinden).

autoStart
​integer · enum · required

Otomatik başlatma durumu. Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
definition
​integer · enum · required

Açıklama alanı gösterilsin. Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
definitionEffectTime
​number · float · required

Açıklama alanının oluşturulma süresi (ms).

definitionVerticalPosition
​string · enum · required

Açıklama alanının dikey konumu. Seçenekler: | top: Yukarı | bottom: Aşağı

Enum values:
top
bottom
definitionHorizontalPosition
​string · enum · required

Açıklama alanının yatay konumu. Seçenekler: | left: Sol | right: Sağ

Enum values:
left
right
definitionVerticalSpace
​integer · enum · required

Açıklama alanının dikey kenar boşluğu (px). Seçenekler: | 5: 5 px | 10: 10 px | 15: 15 px | 20: 20 px | 25: 25 px | 30: 30 px

Enum values:
5
10
15
20
25
30
definitionHorizontalSpace
​integer · enum · required

Açıklama alanının yatay kenar boşluğu (px). Seçenekler: | 5: 5 px | 10: 10 px | 15: 15 px | 20: 20 px | 25: 25 px | 30: 30 px

Enum values:
5
10
15
20
25
30
definitionFontFamilySelect
​string · enum · required

Açıklama yazı tipi. Seçenekler: | arial: Arial | tahoma: Tahoma | verdana: Verdana | georgia: Georgia | trebuchet: Trebuchet | courier: Courier | timesnewroman: Times New Roman

Enum values:
arial
tahoma
verdana
georgia
trebuchet
courier
timesnewroman
definitionFontColorSelect
​string · enum · required

Açıklama yazı rengi. Seçenekler: | white: Beyaz | black: Siyah | red: Kırmızı | green: Yeşil | blue: Mavi | purple: Mor | yellow: Sarı | silver: Gümüş | orange: Turuncu | brown: Kahverengi | cyan: Camgöbeği

Enum values:
white
black
red
green
blue
purple
yellow
silver
definitionFontFamilySize
​integer · min: 10 · max: 30 · required

Açıklama yazı boyutu (px).

definitionBackgroundColor
​string · required

Açıklama yazı arka plan rengi.

showButton
​integer · enum · required

İleri/Geri butonları gösterilsin. Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
previousNextColor
​string · required

İleri/Geri buton rengi.

previousNextSize
​integer · required

İleri/Geri buton büyüklüğü (px).

previousNextOpacity
​integer · min: 0 · max: 100 · required

İleri/Geri buton şeffaflık oranı (1-100 arası).

pagination
​integer · enum · required

Slider altında geçiş butonları aktif mi? Seçenekler: | 0: Hayır | 1: Evet

Enum values:
0
1
bulletActiveFontColor
​string · required

Geçiş butonları aktif yazı rengi.

bulletPassiveFontColor
​string · required

Geçiş butonları pasif yazı rengi.

bulletActiveColor
​string · required

Geçiş butonları aktif arka plan rengi.

bulletPassiveColor
​string · required

Geçiş butonları pasif arka plan rengi.

paginationNumeric
​integer · enum · required

Slider altında geçiş butonları numerik olsun mu? Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1

SliderItemSummary

index
​integer · min: 1 · max: 10

Slider kaleminin indeksi

link
​string

Slider kaleminin yönlendirme linki

sortOrder
​integer · min: 1 · max: 10

Slider kaleminin sırası

targetBlankStatus
​integer · enum

Slider kaleminin yeni sayfada açılma durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
status
​integer · enum

Slider kaleminin aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
imageUrl
​string

Slider kaleminin imaj URL'i

attachment
​string · writeOnly

Slider kalemine ait eklenti dosyası

description
​string

Slider kaleminin açıklaması

ShippingProviderSummary

Kargo sağlayıcısı nesnesi
id
​integer

Kargo sağlayıcısının benzersiz kimlik numarası.

Example: 123
code
​string · maxLength: 64

Kargo sağlayıcısı kodu. Benzersiz olmalıdır.

Example: idea
name
​string · maxLength: 255

Kargo sağlayıcısının görünen adı.

Example: Idea Cargo
trackingUrl
​string · maxLength: 1024

Kargo takip url.

Example: https://app.kargonomi.com.tr/kargo-takip
trackingFormMethod
​string · enum

Kargo takibi için kullanılan HTTP metodu (GET veya POST).

Enum values:
get
post
Example: get
payload
​string · maxLength: 65535

Kargo takip kodunun gönderildiği sorgu veya form şablonu.

Example: q={tracking_code}&val=1
settings
​object

Kargo sağlayıcısına özel ek yapılandırma ayarları.

Example: {"apiKey":"abc123xyz","region":"TR","supportsCashOnDelivery":true}

ShippingCompanySummary

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
id
​integer · required

Kargo firması nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 128 · required

Kargo firması nesnesi adı.

Example: Idea Cargo
status
​string · enum

Kargo firmasının aktiflik durumu. Pasif firmalar sistemde görünmez.

Enum values:
active
passive
Example: active
extraPrice
​number · float · min: 0

Kargo 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.

Example: 5
extraVolumetricWeightPrice
​number · float · min: 0

Kargo 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.

Example: 10
freeShipmentOrderPrice
​number · float · min: 0

Alışveriş sepeti toplamı belirlediğiniz Ücretsiz kargo limitini geçtiğinde müşterileriniz ücretsiz kargo hizmetinden faydalanabilirler.(Örn: X Lira üzeri ücretsiz Kargo!)

Example: 100
freeShipmentVolumetricWeightLimit
​number · float · min: 0

Ü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.

Example: 1
sortOrder
​integer · min: 0 · max: 999

Kargo firmalarının listelenme sırasını belirler.

Example: 999
paymentType
​string · enum

Kargo ödemesinin tipini belirtir.

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
companyCode
​string · maxLength: 255

API tarafından otomatik oluşturulan kargo firması kodu.

Example: CMP12KD
​object

ShippingProvider nesnesi (özet). Tüm alanlar için ShippingProvider şemasına bakın.

​object[]
createdAt
​string · date-time

Kargo firması nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Kargo firması nesnesinin son güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

ShippingAddressSummary

Teslimat adresi objesi
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Ülke adı

Example: Türkiye
location
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Şehir adı

Example: İstanbul
subLocation
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

İlçe adı

Example: Üsküdar
address
​string · minLength: 5 · maxLength: 255 · required

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
id
​integer

Adres için benzersiz kimlik

Example: 123
firstname
​string · maxLength: 255

Alıcı adı

Example: Ahmet
surname
​string · maxLength: 255

Alıcı soyadı

Example: Yılmaz
phoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Cep telefonu numarası

Example: +90 (555) 555 55 55
zipCode
​string · maxLength: 64
​object

Order nesnesi (özet). Tüm alanlar için Order şemasına bakın.

SeoSettingSummary

​object · required

SEO ayarları nesnesi JSON formatında değeri.

Example: {"title": "Kaliteli Kalemler", "description": "En iyi fiyatlar"}
id
​integer

SEO ayarları nesnesi kimlik değeri.

Example: 123
context
​string · enum · maxLength: 255

SEO ayarları nesnesi içeriği. Seçenekler: | product: Ürün.

Enum values:
product
brand
blog
category
page
collection
contextItemId
​integer

SEO ayarları nesnesi içerik kalemi kimlik değeri.

Example: 999
updatedAt
​string · date-time

SEO ayarları nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00
createdAt
​string · date-time

SEO ayarları nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00

SelectionGroupSummary

id
​integer · required

Ek özellik grubu nesnesi kimlik değeri.

Example: 123
title
​string · maxLength: 255 · required

Ek özellik grubu ismi.

Example: Renk Seçenekleri
sortOrder
​integer

Ek özellik grubu sırası.

Example: 1
​object[]

SelectionSummary

title
​string · maxLength: 255 · required

Ek özelliğin başlığı veya adı; ürün sayfasında kullanıcıya gösterilir.

Example: Renk Seçeneği
id
​integer

Ek özellik nesnesinin benzersiz kimlik değeri.

Example: 123
sortOrder
​integer

Ek özelliğin sıralama önceliği; küçük değerler önce, büyük değerler sonra listelenir.

Example: 1
​object

SelectionGroup nesnesi (özet). Tüm alanlar için SelectionGroup şemasına bakın.

RegionSummary

id
​integer · required

Teslimat bölgesi kimlik değeri.

Example: 1
name
​string

Teslimat bölgesi ismi.

Example: Marmara
​object[]

PurchaseLimitationItemSummary

Satın alma limiti kalemi objesi
id
​integer

Limit kalemi için benzersiz kimlik

Example: 456
​object

PurchaseLimitation nesnesi (özet). Tüm alanlar için PurchaseLimitation şemasına bakın.

​object

Brand nesnesi (özet). Tüm alanlar için Brand şemasına bakın.

​object

Category nesnesi (özet). Tüm alanlar için Category şemasına bakın.

​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

​object

MemberGroup nesnesi (özet). Tüm alanlar için MemberGroup şemasına bakın.

createdAt
​string · date-time

Satın alma limiti kalemi nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Satın alma limiti kalemi nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

PurchaseLimitationSummary

id
​integer · required

Satın alma limiti nesnesine ait benzersiz kimlik (ID) değeri.

name
​string · maxLength: 255 · required

Satın alma limiti nesnesine ait isim.

minimumLimit
​number · float · min: 0

Belirlenen en düşük satın alma limiti.

maximumLimit
​number · float · min: 0

Belirlenen en yüksek satın alma limiti.

type
​string · enum

Satı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..

Enum values:
product
category
brand
status
​integer · enum

Satın alma limitinin aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 0
​object[]
updatedAt
​string · date-time

Satın alma limiti nesnesinin güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Satın alma limiti nesnesinin oluşturulma tarihi.

Example: 2018-02-21T09:36:03+0300

PromotionPriceRangeSummary

Promosyon fiyat aralığı objesi (basamaklı indirim)
fromQty
​integer · min: 0

Başlangıç adeti

toQty
​integer · min: 0

Bitiş adeti (fromQty'den büyük olmalı)

discountAmount
​integer · min: 0

İndirim miktarı (₺ veya %)

createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300

PromotionSummary

id
​integer · required

Promosyon nesnesi kimlik değeri.

name
​string · maxLength: 255 · required

Promosyon adı.

Example: Sepette %20 İndirim
type
​string · enum

Promosyon tipi.

Enum values:
cart
product
category_and_brand
Example: cart
maxUsage
​integer · min: 0

Promosyonun maksimum kullanım sayısı.

Example: 1000
currentUsage
​integer · min: 0

Şu ana kadar toplam kullanım sayısı.

Example: 250
useDateFilter
​integer · enum

Tarih aralığı özelliği kullanılsın mı?

Enum values:
0
1
Example: 1
startDate
​string · date-time

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time
​object[]
​object

MemberGroup nesnesi (özet). Tüm alanlar için MemberGroup şemasına bakın.

minimumCheckoutLimit
​number · float

Kullanım alışveriş sınırı.

Example: 200
​object

Category nesnesi (özet). Tüm alanlar için Category şemasına bakın.

​object[]
​object

Brand nesnesi (özet). Tüm alanlar için Brand şemasına bakın.

​object[]
​object[]
​object[]
minimumPurchaseQuantityOfMainProducts
​integer · min: 0

Ana ürün minimum satın alma zorunluluğu miktarı.

Example: 2
promotionValidityControl
​string · enum

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
promotionFeatureType
​string · enum

Promosyon özelliği tipi.

Enum values:
free
discountPrice
discountPercentage
fixedPrice
cartDiscountPercentage
Example: discountPercentage
promotionFeatureValue
​number · float · min: 0

Promosyon özelliğine ait promosyon miktarı.

Example: 20
​object[]
promotionalProductQuantity
​integer · min: 0

Promosyonlu ürün miktarı.

Example: 1
description
​string

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255
urlBlankStatus
​integer · enum
Enum values:
0
1
imageFile
​string · maxLength: 255
imageUrl
​string
attachment
​string · writeOnly
status
​integer · enum

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999999
freeShipping
​integer · enum

Ücretsiz kargo durumu.

Enum values:
0
1
Example: 1
applyToDiscountProduct
​integer · enum

İndirimli ürünlerde geçerli olsun mu?

Enum values:
0
1
Example: 0
createdAt
​string · date-time

Promosyon nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Promosyon nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00

ProductToCollectionSummary

​object · required

Collection nesnesi (özet). Tüm alanlar için Collection şemasına bakın.

id
​integer
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

sortOrder
​integer · max: 500

ProductSpecialInfoSummary

Ürünlere eklenebilen özel bilgi alanlarını temsil eder. Bu alanlar ürün detay sayfasında açıklama, teknik bilgi veya özel metin göstermek için kullanılır.
title
​string · minLength: 1 · maxLength: 255 · required

Özel bilgi alanı başlığı.

Example: Özel Bilgi Başlığı
content
​string · required

Özel bilgi alanı içeriği.

Example: Bu ürünle ilgili özel bilgileri içeren metindir.
status
​integer · enum · required

Özel bilgi alanı aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 0
id
​integer

Özel bilgi alanı kaydının benzersiz kimlik değeri.

Example: 123
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

ProductProtectionSummary

isPriceProtected
​integer · enum · required

Ürün fiyatının koruma durumu. Seçenekler: | 0: Korumasız | 1: Korumalı

Enum values:
0
1
Example: 0
isStockProtected
​integer · enum · required

Ürün stokunun koruma durumu. Seçenekler: | 0: Korumasız | 1: Korumalı

Enum values:
0
1
Example: 0
id
​integer

Ürün koruma nesnesi kimlik değeri.

Example: 123
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

ProductPriceSummary

Ürün fiyatlandırma bilgilerini içeren obje
type
​integer · enum · required

Fiyat tipi (alternatif fiyat seçenekleri)

Enum values:
2
3
4
5
6
Example: 2
value
​number · float · min: 0 · required

Ürünün fiyat değeri

Example: 10.99
id
​integer

Ürün fiyatı için benzersiz kimlik

Example: 123
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

ProductImageSummary

Ürün görseli objesi
id
​integer

Görsel için benzersiz kimlik

Example: 123
filename
​string · maxLength: 255 · pattern: ^[a-z0-9-]+$

Dosya adı (uzantısız)

Example: ornek-urun-gorseli
extension
​string · enum

Dosya uzantısı

Enum values:
jpg
jpeg
png
gif
webp
JPG
JPEG
PNG
Example: jpg
sortOrder
​integer · min: 1 · max: 8

Görsel sırası (1-8 arası, 1 ana görsel)

Example: 1
thumbUrl
​string · uri

Küçük boyut (thumbnail) görsel URL'i

Example: https://cdn.example.com/thumbs/product-123.jpg
originalUrl
​string · uri

Orijinal boyut görsel URL'i

Example: https://cdn.example.com/products/product-123.jpg
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded görsel verisi (sadece POST işlemlerinde kullanılır)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

alt
​string · maxLength: 150

ProductExtraInfoSummary

Ürün ile ilgili ekstra bilgileri temsil eder.
value
​string · required

Ekstra bilgi değeri

​object · required

ExtraInfo nesnesi (özet). Tüm alanlar için ExtraInfo şemasına bakın.

id
​integer

Ekstra bilgi nesnesine ait benzersiz kimlik numarası.

Example: 123
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

ProductExtraFieldSummary

id
​integer · required
varKey
​string · maxLength: 255 · required
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

varValue
​string

ProductDetailSummary

details
​string · required

Detay bilgisi.

Example: <div><strong><br /><table style="border-collapse:collapse;width:100%;"><tbody><tr><td>&nbsp;Özellik</td><td>Tipi&nbsp;</td></tr><tr><td>&nbsp;Uç tipi</td><td>&nbsp;2B</td></tr></tbody></table></strong></div><br/>
id
​integer

Ürün detayı nesnesi kimlik değeri.

Example: 123
sku
​string · maxLength: 255

Ürünün stok kodu.

Example: KAL-1234
extraDetails
​string

Ürün ekstra detaylı bilgi.

Example: Ekstra detay.
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

ProductCustomizationGroupSummary

name
​string · maxLength: 255 · required

Ürün özelleştirme grubu nesnesi adı.

id
​integer

Ürün özelleştirme grubu nesnesi kimlik değeri.

sortOrder
​integer · min: 0 · max: 999

Ürün özelleştirme grubu sıralama değeri.

​object[]
updatedAt
​string · date-time

Ürün özelleştirme grubu nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Ürün özelleştirme grubu nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

ProductCustomizationFieldSummary

Ürün özelleştirme form alanı tanımı
name
​string · maxLength: 255 · required

Alan adı/başlığı

Example: Hediye Mesajı
isRequired
​integer · enum · required

Alan zorunluluğu

Enum values:
0
1
Example: 0
type
​string · enum · required

Form alanı tipi

Enum values:
checkbox
dropdown
file
radio
textarea
textbox
Example: textarea
placeHolder
​string · maxLength: 255 · required

Alan için yer tutucu metin

Example: Hediye mesajınızı buraya yazın...
info
​string · maxLength: 255 · required

Alan hakkında açıklayıcı bilgi

Example: Maksimum 200 karakter
id
​integer

Alan için benzersiz kimlik

Example: 789
sortOrder
​integer · min: 0 · max: 999

Sıralama değeri (küçükten büyüğe)

Example: 1
​object

productCustomizationGroup nesnesi (özet). Tüm alanlar için productCustomizationGroup şemasına bakın.

​object[]

Seçim alanları için seçenek listesi

settings
​object

Alan için ek ayarlar

ProductCountDownSummary

useCountDown
​integer · enum · required

Geriye Sayım Özelliği kullanımının aktif veya pasif olup olmadığı bilgisini tutar.(0 = kapalı, 1 = açık) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 0
id
​integer

Ürün geri sayım nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
startDate
​string · date-time

Geri sayımın başlangıç tarihi belirtir.

Example: 2018-02-21T09:36:03+0300
endDate
​string · date-time

Geri sayımın sona ereceği tarihi belirtir.

Example: 2018-02-26T09:36:03+0300
expireDate
​string · date-time

Geri sayımın ürün için geçersiz olacağı tarihi belirtir.

Example: 2018-02-26T09:36:03+0300
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

ProductCommentImageSummary

filename
​string · maxLength: 255 · required
extension
​string · enum · required
Enum values:
jpg
png
jpeg
JPG
PNG
JPEG
id
​integer
thumbUrl
​string · writeOnly
originalUrl
​string
attachment
​string · writeOnly
​object

productComment nesnesi (özet). Tüm alanlar için productComment şemasına bakın.

ProductCommentSummary

status
​integer · enum · required

Ürün yorumu durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
rank
​integer · enum · required

Ürün yorumunda ürüne verilen puan. Seçenekler: | 1: 1 puan. | 2: 2 puan. | 3: 3 puan. | 4: 4 puan. | 5: 5 puan.

Enum values:
1
2
3
4
5
Example: 5
isAnonymous
​integer · enum · required

Ürün yorumu yapan kişinin anonim olup olmadığı bilgisi. Seçenekler: | 0: Anonim değil. | 1: Anonim.

Enum values:
0
1
Example: 0
id
​integer

Ürün yorumu nesnesi kimlik değeri.

Example: 123
title
​string · maxLength: 255

Ürün yorumu başlığı.

Example: Çok kaliteli bir ürün.
content
​string · maxLength: 65535

Ürün yorumu içeriği.

Example: Ürünü çok beğendim. Tarif edildiği gibi çıktı ve kargo süreci çok hızlıydı.
​object[]
​object

Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.

​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

createdAt
​string · date-time

Ürün yorumu nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Ürün yorumu nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300
next
​string · writeOnly
prev
​string · writeOnly

ProductButtonSummary

Ürün buton ve rozet gösterim ayarları objesi
id
​integer

Buton ayarları için benzersiz kimlik

Example: 123
fastShipping
​integer · enum

Hızlı gönderi rozeti

Enum values:
0
1
Example: 0
sameDayShipping
​integer · enum

Aynı gün kargo rozeti

Enum values:
0
1
Example: 0
threeDaysDelivery
​integer · enum

3 günde teslimat rozeti

Enum values:
0
1
Example: 0
fiveDaysDelivery
​integer · enum

5 günde teslimat rozeti

Enum values:
0
1
Example: 0
sevenDaysDelivery
​integer · enum

7 günde teslimat rozeti

Enum values:
0
1
Example: 0
freeShipping
​integer · enum

Ücretsiz kargo butonu

Enum values:
0
1
Example: 0
deliveryFromStock
​integer · enum

Stoktan teslim rozeti

Enum values:
0
1
Example: 0
preOrderedProduct
​integer · enum

Ön siparişli ürün rozeti

Enum values:
0
1
Example: 0
limitedStock
​integer · enum

Sınırlı stok rozeti

Enum values:
0
1
Example: 0
askStock
​integer · enum

Stok sorunuz rozeti

Enum values:
0
1
Example: 0
campaignedProduct
​integer · enum

Kampanyalı ürün rozeti

Enum values:
0
1
Example: 0
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

ProductSummary

Ürün detay objesi
id
​integer · required

Ürün için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Ürün adı

Example: Kalem
fullName
​string · maxLength: 255

Tam ürün adı (varyantlar için ana ürün + varyant adı)

Example: Kalem Kırmızı
slug
​string · minLength: 1 · maxLength: 255 · pattern: ^[a-z0-9-]+$

URL dostu benzersiz tanımlayıcı

Example: kalem
sku
​string · maxLength: 255

Stok kodu (benzersiz)

Example: KAL-1234
barcode
​string · maxLength: 255 · pattern: ^[0-9]{8,14}$

Ürün barkodu

Example: 869456789874
stockAmount
​number · decimal · min: 0

Mevcut stok miktarı

Example: 100
price1
​number · decimal · min: 0

Ana satış fiyatı (Fiyat 1)

Example: 10.99
​object

Currency nesnesi (özet). Tüm alanlar için Currency şemasına bakın.

discount
​number · decimal · min: 0

İndirim değeri (tip'e göre ₺ veya %)

Example: 5
discountType
​integer · enum

İndirim tipi

Enum values:
0
1
Example: 1
moneyOrderDiscount
​number · decimal · min: 0 · max: 99

Havale/EFT indirim yüzdesi

Example: 10
buyingPrice
​number · decimal · min: 0

Alış fiyatı

Example: 5.5
marketPriceDetail
​string · maxLength: 255

Piyasa fiyatı açıklaması

Example: Diğer mağazalarda 15 TL
taxIncluded
​integer · enum

Fiyatlara KDV dahil mi?

Enum values:
0
1
Example: 1
tax
​integer · decimal · min: 0

KDV oranı (%)

Example: 20
warranty
​integer · min: 0

Garanti süresi (ay)

Example: 24
volumetricWeight
​number · decimal · min: 0

Desi (hacimsel ağırlık)

Example: 1.5
stockTypeLabel
​string · enum

Stok birim tipi

Enum values:
Piece
cm
Dozen
gram
kg
Person
Package
metre
Example: Piece
customShippingDisabled
​integer · enum

Özel kargo ücreti kullanılsın mı?

Enum values:
0
1
Example: 0
customShippingCost
​number · decimal · min: 0

Özel kargo ücreti (customShippingDisabled=0 ise)

Example: 5
distributor
​string · maxLength: 255

Tedarikçi adı

Example: superTedarik
hasGift
​integer · enum

Ürün hediyeli mi?

Enum values:
0
1
Example: 0
gift
​string · maxLength: 255

Hediye açıklaması

Example: Silgi hediyeli
status
​integer · enum

Ürün aktiflik durumu

Enum values:
0
1
Example: 1
hasOption
​integer · enum · readOnly

Varyant var mı? (sistem otomatik atar)

Enum values:
0
1
Example: 0
shortDetails
​string · maxLength: 512

Kısa ürün açıklaması

Example: Yumuşak uçlu, kırmızı renkli kalem.
searchKeywords
​string · maxLength: 255

Arama anahtar kelimeleri (virgülle ayrılmış)

Example: kırmızı, kalem, kırtasiye
installmentThreshold
​string · maxLength: 10

Maksimum taksit sayısı ('-' = limit yok)

Example: 12
homeSortOrder
​integer | null · max: 500

Anasayfa vitrini sırası (null = vitrin dışı)

Example: 1
popularSortOrder
​integer | null · max: 500

Popüler ürünler vitrini sırası

Example: 1
brandSortOrder
​integer | null · max: 500

Marka vitrini sırası

Example: 1
featuredSortOrder
​integer | null · max: 500

Sponsor ürünler vitrini sırası

Example: 1
campaignedSortOrder
​integer | null · max: 500

Kampanyalı ürünler vitrini sırası

Example: 1
newSortOrder
​integer | null · max: 500

Yeni ürünler vitrini sırası

Example: 1
discountedSortOrder
​integer | null · max: 500

İndirimli ürünler vitrini sırası

Example: 1
categoryShowcaseStatus
​integer · enum

Kategori vitrininde gösterim durumu

Enum values:
0
1
Example: 1
collectionShowcaseStatus
​integer · enum
Enum values:
0
1
midblockSortOrder
​integer | null · max: 9999

Vitrin blokları sırası

Example: 1
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Kırmızı Kalem
metaDescription
​string

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri.
metaKeywords
​string

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: urun/kalem
​

Ana ürün objesi (varyantlar için)

​object

Brand nesnesi (özet). Tüm alanlar için Brand şemasına bakın.

​object

ProductDetail nesnesi (özet). Tüm alanlar için ProductDetail şemasına bakın.

​object

ProductButton nesnesi (özet). Tüm alanlar için ProductButton şemasına bakın.

​object

ProductCountDown nesnesi (özet). Tüm alanlar için ProductCountDown şemasına bakın.

​object

ProductSpecialInfo nesnesi (özet). Tüm alanlar için ProductSpecialInfo şemasına bakın.

​object

SpecGroup nesnesi (özet). Tüm alanlar için SpecGroup şemasına bakın.

​object

ProductProtection nesnesi (özet). Tüm alanlar için ProductProtection şemasına bakın.

​object[]
​object[]
​object[]
​object[]
​object[]
​object[]
​object[]
​object[]
​object[]
​object[]
​object[]
​object[]
​object[]
​object

Midblock nesnesi (özet). Tüm alanlar için Midblock şemasına bakın.

​object

SeoSetting nesnesi (özet). Tüm alanlar için SeoSetting şemasına bakın.

​object[]
​object[]
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
​object[]
​object

DigitalProduct nesnesi (özet). Tüm alanlar için DigitalProduct şemasına bakın.

targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer
next
​string · writeOnly
prev
​string · writeOnly

PreOrderInfoSummary

id
​integer

Sipariş öncesi bilgisi nesnesinin kimlik değeri

Example: 123
sessionId
​string · maxLength: 255

Üyenin son oturumunun benzersiz kimlik değeri

Example: oibtkn9rspcdbmphf8iceondg1
customerFirstname
​string · maxLength: 255

Müşterinin adı

Example: John
customerSurname
​string · maxLength: 255

Müşterinin soyadı

Example: Doe
customerEmail
​string · email

Müşterinin e-posta adresi

Example: johndoe@ideasoft.com.tr
shippingAddressName
​string · maxLength: 255
shippingFirstname
​string · maxLength: 255

Teslimat yapılacak kişinin adı

Example: John
shippingSurname
​string · maxLength: 255

Teslimat yapılacak kişinin soyadı

Example: Doe
shippingAddress
​string · maxLength: 65535

Teslimat adresi detayları

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
shippingPhoneNumber
​string · maxLength: 32 · pattern: \D*(?:\d\D*){10,12}

Teslimat yapılacak kişinin telefon numarası

Example: +90 (216) 326 04 77
shippingMobilePhoneNumber
​string · maxLength: 32 · pattern: \D*(?:\d\D*){10,12}

Teslimat yapılacak kişinin mobil telefon numarası

Example: +90 (555) 555 55 55
shippingLocationName
​string · maxLength: 128

Teslimat şehri

Example: İstanbul
shippingTown
​string · maxLength: 128

Teslimat ilçesi

Example: Üsküdar
shippingIdentityRegistrationNumber
​string · maxLength: 32
shippingZipCode
​string · maxLength: 64
differentBillingAddress
​integer · enum

Teslimat adresinden farklı bir fatura adresi var mı Seçenekler: | 0: Yok | 1: Var

Enum values:
0
1
Example: 0
billingAddressName
​string · maxLength: 255
billingFirstname
​string · maxLength: 255

Fatura kesilecek kişinin adı

Example: John
billingSurname
​string · maxLength: 255

Fatura kesilecek kişinin soyadı

Example: Doe
billingAddress
​string · maxLength: 65535

Fatura adresi detayları

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
billingPhoneNumber
​string · maxLength: 32 · pattern: \D*(?:\d\D*){10,12}

Fatura kesilecek kişinin telefon numarası

Example: +90 (216) 326 04 77
billingMobilePhoneNumber
​string · maxLength: 32 · pattern: \D*(?:\d\D*){10,12}

Fatura kesilecek kişinin mobil telefon numarası

Example: +90 (555) 555 55 55
billingLocationName
​string · maxLength: 128

Fatura adresi şehri

Example: İstanbul
billingTown
​string · maxLength: 128

Fatura adresi ilçesi

Example: Üsküdar
billingInvoiceType
​string · enum

Fatura tipi Seçenekler: | individual: Bireysel | corporate: Kurumsal

Enum values:
individual
corporate
Example: individual
billingIdentityRegistrationNumber
​string · maxLength: 32

TC kimlik numarası (bireysel faturalarda)

Example: 11111111111
billingTaxOffice
​string · maxLength: 255

Fatura kesilen kişi/kurumun vergi dairesi

Example: Üsküdar
billingTaxNo
​string · maxLength: 128

Fatura kesilen kişi/kurum vergi numarası

Example: 9325912620
billingZipCode
​string · maxLength: 128
isEinvoiceUser
​integer · enum

Yöneticinin e-fatura kullanıp kullanmadığı Seçenekler: | 0: Hayır | 1: Evet

Enum values:
0
1
Example: 1
useGiftPackage
​integer · enum

Müşteri hediye paketi isteyip istemediği Seçenekler: | 0: Hayır | 1: Evet

Enum values:
0
1
Example: 0
giftNote
​string · maxLength: 65535

Hediye notu

Example: Doğum günün kutlu olsun.
imageFile
​string · maxLength: 128

Sipariş öncesi görsel dosya adı (jpg, jpeg, png, gif)

Example: kalem.jpg
deliveryDate
​string · date-time

Müşterinin talep ettiği teslimat tarihi

Example: 2018-02-21T18:30:00+0000
deliveryTime
​string · maxLength: 128

API tarafından oluşturulan teslimat saati aralığı

Example: 18:00-19:00
createdAt
​string · date-time

Sipariş öncesi bilgisi nesnesinin oluşturulma zamanı

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Sipariş öncesi bilgisi nesnesinin güncellenme zamanı

Example: 2018-02-21T15:01:03+0300
​object

Country nesnesi (özet). Tüm alanlar için Country şemasına bakın.

​object

Location nesnesi (özet). Tüm alanlar için Location şemasına bakın.

​object

ShippingCompany nesnesi (özet). Tüm alanlar için ShippingCompany şemasına bakın.

​object

Country nesnesi (özet). Tüm alanlar için Country şemasına bakın.

​object

Location nesnesi (özet). Tüm alanlar için Location şemasına bakın.

​object

MemberAddress nesnesi (özet). Tüm alanlar için MemberAddress şemasına bakın.

​object

MemberAddress nesnesi (özet). Tüm alanlar için MemberAddress şemasına bakın.

PosCampaignSummary

POS kampanya tanımı objesi
id
​integer · required

Kampanya için benzersiz kimlik

Example: 67
name
​string · maxLength: 255 · required

Kampanya adı

Example: 3 Taksit %5 İndirim
​object

PosAccount nesnesi (özet). Tüm alanlar için PosAccount şemasına bakın.

​object[]
status
​integer · enum

Kampanya aktiflik durumu

Enum values:
0
1
Example: 1

PosAccountSummary

id
​integer · required

Sanal POS hesabı kimlik değeri.

bank
​integer · writeOnly

Banka bilgisi.

cardName
​string · maxLength: 255

Kart adı.

cardLogo
​string · maxLength: 255 · writeOnly

Kart logosu.

status
​integer · enum · writeOnly

Sanal POS hesabının aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
settings
​string · writeOnly

Sanal POS yapılandırma ayarları.

permit
​integer · enum · writeOnly

Hesap izni durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
threedStatus
​integer · enum · writeOnly

3D Secure aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif. | 2: Kısmi aktif.

Enum values:
0
1
2
paynet
​integer · enum · writeOnly

Paynet entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
segment
​integer · enum · writeOnly

Segment durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
payu
​integer · enum · writeOnly

PayU entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
ipara
​integer · enum · writeOnly

iPara entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
turkPara
​integer · enum · writeOnly

TürkPara entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
hepsiPay
​integer · enum · writeOnly

HepsiPay entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
boschSanalPos
​integer · enum · writeOnly

Bosch Sanal POS durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
payTr
​integer · enum · writeOnly

PayTR entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
paytrek
​integer · enum · writeOnly

Paytrek entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
wirecard
​integer · enum · writeOnly

Wirecard entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
sipay
​integer · enum · writeOnly

Sipay entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
moka
​integer · enum · writeOnly

Moka entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
vepara
​integer · enum · writeOnly

Vepara entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
faturamatik
​integer · enum · writeOnly

Faturamatik entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
paratika
​integer · enum · writeOnly

Paratika entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
akode
​integer · enum · writeOnly

Akode entegrasyon durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
papel
​integer · enum · writeOnly
Enum values:
0
1
posFix
​integer · enum · writeOnly
Enum values:
0
1
qnbPay
​integer · enum · writeOnly
Enum values:
0
1
trPos
​integer · enum · writeOnly
Enum values:
0
1
paycell
​integer · enum · writeOnly
Enum values:
0
1
posMode
​string · enum · maxLength: 8 · writeOnly

POS çalışma modu. Seçenekler: | test: Test modu. | prod: Canlı (üretim) modu.

Enum values:
test
prod
authType
​string · enum · maxLength: 8 · writeOnly

Otorizasyon tipi. Seçenekler: | Auth: Tam otorizasyon. | PreAuth: Ön otorizasyon.

Enum values:
Auth
PreAuth
extraRateMinimumLimit
​number · float · writeOnly

Ek oran için minimum limit.

installmentLimit
​number · float · writeOnly

Maksimum taksit sayısı.

threedType
​string · enum · maxLength: 8 · writeOnly

3D Secure türü. Seçenekler: | 3D: 3D. | 3DPAY: 3D Pay. | 3D_FULL: 3D Full. | 3DHOSTING: 3D Hosting. | 3D_OOS_PAY: 3D OOS Pay.

Enum values:
3D
3DPAY
3D_FULL
3DHOSTING
3D_OOS_PAY
sortOrder
​integer · min: 0 · max: 999 · writeOnly

Sıralama değeri.

PollAnswerSummary

name
​string · maxLength: 255 · required

Anket cevabının metin değeri

id
​integer

Anket cevabı nesnesinin kimlik değeri

vote
​integer

Bu cevaba verilen oy sayısı

sortOrder
​integer · min: 0 · max: 999

Anket cevabının sıralama numarası

​object

Anket ve anket sonuçları objesi — pollQuestion nesnesi (özet). Tüm alanlar için pollQuestion şemasına bakın.

PaymentTypeSummary

id
​integer · required

Ödeme tipi nesnesi kimlik değeri.

Example: 123
name
​string

Ödeme tipinin adı.

Example: Havale
sortOrder
​integer · min: 0 · max: 999

Ödeme tipinin sıralama değeri.

PaymentProxySettingSummary

id
​integer · required

Ödeme proxy ayarı nesnesinin benzersiz kimlik değeri.

Example: 123
varValue
​string · maxLength: 255 · required

Ödeme proxy ayarı için değişken değeri.

Example: 12702123
varKey
​string

Ödeme proxy ayarı için değişken anahtarı.

Example: client_id
​object

PaymentProxy nesnesi (özet). Tüm alanlar için PaymentProxy şemasına bakın.

PaymentProxySummary

id
​integer · required

Ödeme yönlendiricisi nesnesinin benzersiz kimlik (ID) değeri.

Example: 5
code
​string

Ödeme yönlendiricisini temsil eden sistemsel kod (sabit string).

Example: Masterpass
name
​string

Ödeme yönlendiricisinin görünen adı.

Example: Masterpass
status
​integer · enum

Ödeme yönlendiricisinin aktiflik durumu. Seçenekler: | 0: Devre dışı (kullanılamaz). | 1: Etkin (ödeme yönlendirme kullanılabilir).

Enum values:
0
1
​object[]
updatedAt
​string · date-time

Ödeme yönlendiricisinin son güncellenme zamanı (ISO 8601 formatında).

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Ödeme yönlendiricisinin oluşturulma zamanı (ISO 8601 formatında).

Example: 2022-04-20T14:33:45+03:00

PaymentProviderSettingSummary

Ödeme sağlayıcısına ait yapılandırma ayarlarını temsil eder.
id
​integer · required

Ödeme sağlayıcı ayarına ait benzersiz kimlik numarası.

Example: 123
varValue
​string · maxLength: 255 · required

Ödeme altyapısı sağlayıcısı ayarı nesnesi için değişken değeri.

Example: PALIKJXZQ
varKey
​string

Ödeme altyapısı sağlayıcısı ayarı nesnesi için değişken anahtarı.

Example: agentId
​object

PaymentProvider nesnesi (özet). Tüm alanlar için PaymentProvider şemasına bakın.

PaymentProviderSummary

id
​integer · required

Ödeme altyapısı sağlayıcısı nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
code
​string

Ödeme altyapısı sağlayıcısı için ön tanımlanmış kod değeri.

Example: MoneyOrder
name
​string

Ödeme altyapısı sağlayıcısı için isim değeri.

Example: Havale
status
​integer · enum

Ödeme altyapısı sağlayıcısının aktif veya pasif olup olmadığı bilgisini tutar.(0 = pasif, 1 = aktif)

Enum values:
0
1
Example: 1
​object[]
​object[]
​object

PaymentType nesnesi (özet). Tüm alanlar için PaymentType şemasına bakın.

PaymentGatewaySettingSummary

varKey
​string · maxLength: 255 · required
varValue
​string · required
id
​integer

Ödeme kanalı ayarı nesnesi kimlik değeri.

Example: 123
​object

PaymentGateway nesnesi (özet). Tüm alanlar için PaymentGateway şemasına bakın.

PaymentGatewaySummary

id
​integer · required

Ödeme kanalı nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Ödeme kanalı için sistemde ön tanımlı kod değeri.

Example: ideabank
name
​string · maxLength: 255 · required

Ödeme kanalı ismi.

Example: Idea Bank
sortOrder
​integer · min: 0 · max: 999

Ödeme kanalının listelerdeki sıralama değeri.

Example: 999
status
​string · enum

Ödeme kanalının aktiflik durumu. Seçenekler: | active: Ödeme kanalı aktif. | passive: Ödeme kanalı pasif.

Enum values:
active
passive
Example: active
legacyTableName
​string · maxLength: 512
legacyTableId
​integer · min: 1
​object

PaymentProvider nesnesi (özet). Tüm alanlar için PaymentProvider şemasına bakın.

​object[]
​object[]
​object

ExtraInstallment nesnesi (özet). Tüm alanlar için ExtraInstallment şemasına bakın.

updatedAt
​string · date-time

Ödeme kanalı nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Ödeme kanalı nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00

PaymentBddkCategorySummary

bddkCategoryName
​string · maxLength: 255 · required
installment
​integer · min: 0 · required
id
​integer
​object

PaymentProvider nesnesi (özet). Tüm alanlar için PaymentProvider şemasına bakın.

extraField
​string · maxLength: 255

PageSummary

Sayfa nesnesi
id
​integer · required

Sayfa nesnesine ait benzersiz kimlik değeri.

Example: 101
title
​string · maxLength: 255 · required

Sayfanın başlığı. Kullanıcıya görünür ve SEO açısından önemlidir.

Example: Mesafeli Satış Sözleşmesi
type
​string · enum

Sayfanın türü. Sistem, sayfanın normal içerik sayfası mı yoksa haber sayfası mı olduğunu bu alana göre belirler.

Enum values:
page
article
Example: page
slug
​string · maxLength: 255

Sayfa URL'sinde kullanılacak SEO dostu kısa metin. Boşluk yerine tire (-) kullanılır.

Example: mesafeli-satis-sozlesmesi
scoop
​string · maxLength: 255

Sayfa için kısa özet veya teaser metni. Haber sayfalarında öne çıkan özet olarak kullanılabilir.

Example: Bu sayfa, Mesafeli Satış Sözleşmesi ile ilgili bilgilendirme sağlar.
content
​string

Sayfanın HTML veya zengin metin formatındaki içeriği.

Example: <p>Mesafeli Satış Sözleşmesi hakkında detaylı bilgi burada yer alır.</p>
status
​integer · enum

Sayfanın aktiflik durumu. Pasif sayfalar kullanıcıya gösterilmez. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
blockStatus
​integer · enum

Sayfanın blok içerik durumunu belirler. Pasifse bloklar gösterilmez. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
sortOrder
​integer · min: 0 · max: 9999

Sayfanın listelerde veya menülerde gösterim sırasını belirler.

Example: 10
pageTitle
​string · maxLength: 255

Sayfa başlığı

Example: Sayfa 1
metaDescription
​string

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string

İlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-de&#x11F;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.

Example: sayfa/idea-haber
​object

SeoSetting nesnesi (özet). Tüm alanlar için SeoSetting şemasına bakın.

updatedAt
​string · date-time

Sayfanın en son güncellenme zamanı.

Example: 2025-10-17T09:00:00+03:00
createdAt
​string · date-time

Sayfanın oluşturulma zamanı.

Example: 2023-05-10T12:30:00+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

PackageItemSummary

Paket kalemi objesi
id
​integer · required

Paket kalemi için benzersiz kimlik

Example: 234
name
​string · maxLength: 255 · required

Paket kalemi adı

Example: Ana Ürün
choiceType
​string · enum

Seçim tipi

Enum values:
singular
plural
Example: singular
isRequired
​integer · enum

Zorunlu alan mı?

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 1 · max: 20

Görüntüleme sırası

Example: 999
​object

Package nesnesi (özet). Tüm alanlar için Package şemasına bakın.

​object

Category nesnesi (özet). Tüm alanlar için Category şemasına bakın.

​object[]
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00

PackageSummary

id
​integer · required

Paket nesnesi kimlik değeri.

Example: 123
name
​string · maxLength: 255 · required

Paket nesnesi ismi.

Example: Ofis Seti
slug
​string · maxLength: 255

Slug değeri, ilgili nesnenin URL değeridir.

Example: ofis-seti
description
​string

Paket nesnesi açıklama alanı.

Example: Ofis malzemeleri içeren avantajlı paket.
​object[]
status
​integer · enum

Paket aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
pageTitle
​string · maxLength: 255

Sayfa başlığı.

Example: Ofis Seti - Kaliteli Ürünler
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
metaDescription
​string

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
updatedAt
​string · date-time

Paket nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Paket nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00

OrderRefundRequestItemSummary

paybackStatus
​integer · enum · required

Geri ödeme durumu Seçenekler: | 0: Hayır | 1: Evet

Enum values:
0
1
id
​integer

Sipariş iptal talebi kalemi nesnesi kimlik değeri.

Example: 123
​object

ManualRelation nesnesi (özet). Tüm alanlar için ManualRelation şemasına bakın.

amount
​number · float

Talep edilen ürün miktarı.

Example: 1
reason
​string · maxLength: 1024

Sipariş iptal talebi sebebi. Tanımlı dört seçenekten biri seçilmelidir.

Example: Ürünü iade etmek istiyorum.
details
​string · maxLength: 1024

Talebin detaylı açıklaması.

Example: Ürünü iade etmek istiyorum. Çünkü ürünü beğenmedim.
createdAt
​string · date-time

Sipariş iptal talebi kalemi nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Sipariş iptal talebi kalemi nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

OrderItemSubscriptionSummary

Sipariş kalemi ile ilişkili abonelik bilgilerini temsil eder.
id
​integer

Sipariş kalemi aboneliğine ait benzersiz kimlik numarası.

Example: 123
​object

Subscription nesnesi (özet). Tüm alanlar için Subscription şemasına bakın.

OrderItemCustomizationSummary

Sipariş kalemi özelleştirme değerleri objesi
id
​integer

Özelleştirme için benzersiz kimlik

Example: 123
productCustomizationGroupId
​integer

Ürün özelleştirme grubu kimliği

Example: 45
productCustomizationGroupName
​string · maxLength: 255

Özelleştirme grup adı

Example: Sertifika Özelleştirme
productCustomizationGroupSortOrder
​integer

Grup sıralama değeri

Example: 999
productCustomizationFieldId
​integer

Özelleştirme alanı kimliği

Example: 123
productCustomizationFieldType
​string · enum · maxLength: 255

Alan tipi

Enum values:
text
textarea
file
dropdown
radio
checkbox
Example: text
productCustomizationFieldName
​string · maxLength: 255

Alan adı

Example: Sertifika Düzenlenen Kişi
productCustomizationFieldValue
​string · maxLength: 255

Müşterinin girdiği değer

Example: Ahmet Yılmaz
productCustomizationFieldPath
​string · uri · maxLength: 255

Dosya tipi alanlar için dosya yolu

Example: /uploads/customizations/certificate.pdf
cartItemAttributeId
​integer

İlişkili sepet kalemi özellik kimliği

Example: 789
isCloudFile
​integer

Dosyanın bulut depolama kullanıp kullanmadığı

cloudContentUrl
​string · uri

Bulut depolama dosya URL'i

Example: https://cdn.example.com/file.pdf
​object

orderItem nesnesi (özet). Tüm alanlar için orderItem şemasına bakın.

OrderItemSummary

productName
​string · maxLength: 255 · required

Siparişteki ürünün adı.

Example: Kalem
productSku
​string · maxLength: 255 · required

Ürünün stok kodu (SKU).

Example: KAL-1234
productPrice
​number · float · min: 0 · required

Ürünün birim fiyatı.

Example: 15
productCurrency
​string · maxLength: 32 · required

Ü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ı

Example: TL
productQuantity
​number · float · min: 0 · required

Siparişteki ürün adedi (stok tipi cinsinden).

Example: 1
productTax
​number · float · min: 0 · required

Ürünün vergi oranı (yüzde cinsinden).

Example: 18
productDiscount
​number · float · min: 0 · required

Ürüne uygulanan standart indirim miktarı.

Example: 5
id
​integer

Sipariş kaleminin benzersiz kimlik (ID) değeri.

Example: 123
productBarcode
​string · maxLength: 255

Ürünün barkod numarası.

Example: 869456789874
productMoneyOrderDiscount
​number · float · min: 0

Havale/EFT ile ödemede uygulanan indirim miktarı.

Example: 5
productWeight
​number · float · min: 0

Ürünün ağırlığı (kg veya ilgili stok tipi birimi).

Example: 1.2
productStockTypeLabel
​string · maxLength: 255

Ürünün stok tipi etiketi (ör. adet, kg, paket).

Example: Adet
isProductPromotioned
​integer · enum

Ürünün promosyon olup olmadığını belirten değer. Seçenekler: | 0: Ürün promosyon değil | 1: Ürün promosyon

Enum values:
0
1
Example: 0
discount
​number · float · min: 0

Ürüne uygulanan hediye çeki indirim değeri.

Example: 5
​object

Order nesnesi (özet). Tüm alanlar için Order şemasına bakın.

​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

​object[]
​object

OrderItemSubscription nesnesi (özet). Tüm alanlar için OrderItemSubscription şemasına bakın.

OrderDetailSummary

varKey
​string · maxLength: 255 · required

Sipariş detayı için değişken anahtarı (örn. ödeme veya teslimat bilgisi)

Example: bank_account_detail
varValue
​string · maxLength: 65535 · required

Değişkene ait değer, genellikle JSON formatında detaylı bilgi içerir

Example: {"branch_name":"Tuzla/İstanbul","branch_code":"238","account_name":"Ideasoft Kurumsal","account_code":"123123","account_type":"Kurumsal","uses_iban":"0"}
id
​integer

Sipariş detayı nesnesinin kimlik değeri

Example: 123
​object

Order nesnesi (özet). Tüm alanlar için Order şemasına bakın.

OrderCustomTaxLineSummary

Sipariş özel vergi satırı objesi
name
​string · maxLength: 255 · required

Özel vergi adı

Example: Özel Tüketim Vergisi
value
​number · decimal · min: 0 · required

Vergi tutarı

Example: 15.5
currency
​string · maxLength: 255 · pattern: ^[A-Z]{3}$ · required

Para birimi kodu

Example: TRY
id
​integer

Vergi satırı için benzersiz kimlik

Example: 789
​object

Order nesnesi (özet). Tüm alanlar için Order şemasına bakın.

OrderSummary

Sipariş detay objesi
id
​integer · required

Sipariş için benzersiz kimlik

Example: 123
customerFirstname
​string · maxLength: 255

Müşteri adı

Example: Ahmet
customerSurname
​string · maxLength: 255

Müşteri soyadı

Example: Yılmaz
customerEmail
​string · email

Müşteri e-posta adresi

Example: ahmet.yilmaz@example.com
customerPhone
​string

Müşteri telefon numarası

Example: +90 (216) 326 04 77
paymentTypeName
​string · maxLength: 128

Ödeme yöntemi adı

Example: Havale
paymentProviderCode
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı kodu (sistem otomatik atar)

Example: MoneyOrder
paymentProviderName
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı adı (sistem otomatik atar)

Example: Havale
paymentGatewayCode
​string · maxLength: 255 · readOnly

Ödeme gateway kodu (sistem otomatik atar)

Example: ideabank_1
paymentGatewayName
​string · maxLength: 255 · readOnly

Ödeme gateway adı (sistem otomatik atar)

Example: IdeaBank
bankName
​string · maxLength: 128 · readOnly

Banka adı (sistem otomatik atar)

Example: IdeaBank
clientIp
​string · ipv4 · maxLength: 40

Müşterinin IP adresi

Example: 192.168.1.1
userAgent
​string · maxLength: 1024

Tarayıcı ve cihaz bilgisi

Example: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.167 Safari/537.36
currency
​string · enum

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
currencyRates
​string · maxLength: 65535

İşlem anındaki döviz kurları (JSON string)

Example: {"TL":[1,1],"USD":[3.7698,3.7766],"EUR":[4.6575,4.6659],"GBP":[5.2597,5.2872]}
amount
​number · decimal · min: 0

Vergi hariç toplam tutar

Example: 100
couponDiscount
​number · decimal · min: 0

Hediye çeki indirim tutarı

Example: 0
taxAmount
​number · decimal · min: 0

Toplam vergi tutarı

Example: 18
totalCustomTaxAmount
​number · decimal · min: 0

Özel vergi toplam tutarı

Example: 0
promotionDiscount
​number · decimal · min: 0

Promosyon indirim tutarı

Example: 0
generalAmount
​number · decimal · min: 0

Genel toplam (ürün + vergi + kargo + ek hizmet - indirimler)

Example: 125
shippingAmount
​number · decimal · min: 0

Kargo ücreti

Example: 15
additionalServiceAmount
​number · decimal · min: 0

Ek hizmet bedeli (hediye paketi vb.)

Example: 0
finalAmount
​number · decimal · min: 0

Son ödeme tutarı (taksit farkı dahil)

Example: 125
sumOfGainedPoints
​number · decimal · min: 0

Kazanılan toplam puan

Example: 200
installment
​integer · min: 0

Taksit sayısı

Example: 3
installmentRate
​number · decimal · min: 0

Taksit oranı (1.0 = vade farkı yok)

Example: 1.05
extraInstallment
​integer · min: 0

Ekstra kampanya taksit sayısı

Example: 0
transactionId
​string · maxLength: 255

Benzersiz işlem numarası

Example: c88728ce28151
hasUserNote
​integer · enum

Müşteri notu var mı?

Enum values:
0
1
Example: 0
status
​string · enum

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: waiting_for_approval
paymentStatus
​string · enum

Ödeme işlem durumu

Enum values:
in_transaction
failed
success
Example: success
errorMessage
​string · maxLength: 65535

Hata mesajı (başarısız işlemler için)

Example: Limit yetersiz
sessionId
​string · maxLength: 255 · writeOnly

Oturum kimliği

Example: abc123def456
deviceType
​string · enum

Sipariş verildiği cihaz tipi

Enum values:
desktop
mobile
tablet
Example: desktop
referrer
​string · maxLength: 65535

Yönlendiren web sitesi URL'i

Example: www.referrer.com
invoicePrintCount
​integer · min: 0

Fatura çıktısı alınma sayısı

Example: 1
useGiftPackage
​integer · enum

Hediye paketi tercihi

Enum values:
0
1
Example: 0
giftNote
​string

Hediye notu

Example: Doğum günün kutlu olsun
giftAmount
​number · float · min: 0
memberGroupName
​string · maxLength: 255

Üye grubu adı

Example: Üyeliksiz alışveriş
usePromotion
​integer · enum

Promosyon kullanım durumu

Enum values:
0
1
Example: 0
shippingProviderCode
​string · maxLength: 255 · readOnly

Kargo sağlayıcı kodu (sistem otomatik atar)

Example: idea
shippingProviderName
​string · maxLength: 255 · readOnly

Kargo sağlayıcı adı (sistem otomatik atar)

Example: Idea Cargo
shippingCompanyName
​string · maxLength: 255 · readOnly

Kargo firması adı (sistem otomatik atar)

Example: Idea Cargo
shippingPaymentType
​string · enum

Kargo ödeme tipi

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
shippingTrackingCode
​string · maxLength: 255

Kargo takip kodu

Example: 123123IDEA
source
​string · maxLength: 255

Sipariş kaynağı (yazılım/platform)

Example: IdeaShop Payment
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​object

Maillist nesnesi (özet). Tüm alanlar için Maillist şemasına bakın.

​object

Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.

​object[]
​object[]
​object[]
​object

ShippingAddress nesnesi (özet). Tüm alanlar için ShippingAddress şemasına bakın.

​object

BillingAddress nesnesi (özet). Tüm alanlar için BillingAddress şemasına bakın.

​object

FraudOrder nesnesi (özet). Tüm alanlar için FraudOrder şemasına bakın.

​object

Promotion nesnesi (özet). Tüm alanlar için Promotion şemasına bakın.

autoPayback
​integer · enum · writeOnly

Otomatik iade durumu

Enum values:
0
1
Example: 0
orderItemCount
​integer
lastShipmentStatus
​integer
next
​string · writeOnly
prev
​string · writeOnly

OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)
title
​string · maxLength: 255 · required

Varyant grubu başlığı

Example: Renk
id
​integer

Varyant grubu için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255

URL dostu benzersiz tanımlayıcı

Example: renk
sortOrder
​integer · min: 0 · max: 9999

Görüntüleme sırası

Example: 999
predefined
​integer · enum · writeOnly

Sistem öntanımlı mı?

Enum values:
0
1
Example: 0
filterStatus
​integer · enum

Filtre menüsünde göster

Enum values:
0
1
Example: 1
aggregator
​integer · enum

Filtre menüde gruplanma durumu

Enum values:
0
1
Example: 0
​object[]

OptionSummary

id
​integer · required

Varyant nesnesinin kimlik değeri

Example: 123
title
​string · maxLength: 255 · required

Varyant başlığı. Örneğin, Varyant Grubu renk ise bu değer "Kırmızı" olabilir.

Example: Kırmızı 1
sortOrder
​integer · min: 0 · max: 9999 · required

Varyantın sıralama değeri

Example: 999
slug
​string · minLength: 1 · maxLength: 255

Slug değeri, ilgili varyantın URL'de kullanılacak değeri

Example: kirmizi-1
logo
​string

Varyant logosu

attachment
​string · writeOnly

Varyant logosunun dosya bilgisi

imageUrl
​string

Varyant imajının URL adresi

size
​integer · enum · writeOnly

Varyant logosu boyutu (piksel) Seçenekler: | 16: 16 px | 24: 24 px | 32: 32 px | 64: 64 px | 128: 128 px

Enum values:
16
24
32
64
128
256
512
​object

OptionGroup nesnesi (özet). Tüm alanlar için OptionGroup şemasına bakın.

updatedAt
​string · date-time

Varyantın güncellenme zamanı

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Varyantın oluşturulma zamanı

Example: 2022-04-20T14:33:45+03:00

OfferedProductSummary

Tavsiye edilen ürün ilişki objesi
​object · required

ManualRelation nesnesi (özet). Tüm alanlar için ManualRelation şemasına bakın.

id
​integer

İlişki için benzersiz kimlik

Example: 234
​object

ManualRelation nesnesi (özet). Tüm alanlar için ManualRelation şemasına bakın.

MidblockSummary

Vitrin bloğu objesi
id
​integer · required

Vitrin bloğu için benzersiz kimlik

Example: 567
name
​string · maxLength: 255 · required

Vitrin bloğu adı

Example: Yeni Ürünler
status
​integer · enum

Blok aktiflik durumu

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 0

Görüntüleme sırası

Example: 1
productCountPerRow
​integer · enum

Satırda gösterilecek ürün sayısı

Enum values:
1
2
3
4
5
Example: 4
type
​string · enum · required

Menü öğesinin tipi; hangi türde içerik gösterileceğini belirler. Seçenekler: | url: Harici veya dahili bağlantı. | page: Site içi sayfa. | category: Ürün kategorisi.

Enum values:
url
page
category
collection
title
​string · maxLength: 255 · required

Menüde görünecek başlık veya ad.

Example: Test Menü Nesnesi - 1
hasChildren
​integer · enum · required
Enum values:
0
1
id
​integer

Menü öğesinin benzersiz kimlik değeri.

Example: 1
url
​string · maxLength: 255

Menü öğesinin tıklanınca gidilecek bağlantı adresi (type=url için geçerlidir).

Example: https://test.myideasoft.ide/sayfa/mesafeli-satis-sozlesmesi
targetBlankStatus
​integer · enum

Bağlantının yeni sekmede açılıp açılmayacağını belirtir. Seçenekler: | 0: Aynı sekmede açılır. | 1: Yeni sekmede açılır.

Enum values:
0
1
rowOrder
​integer · enum

Menü öğesinin satır sırasını belirler; üstten alta sıralamada kullanılır.

Enum values:
1
2
Example: 1
sortOrder
​integer · min: 0 · max: 99

Menü öğesi içindeki genel sıralama numarası; küçük değer önce gösterilir.

Example: 1
​object

Category nesnesi (özet). Tüm alanlar için Category şemasına bakın.

​object

Collection nesnesi (özet). Tüm alanlar için Collection şemasına bakın.

​object

Page nesnesi (özet). Tüm alanlar için Page şemasına bakın.

tree
​string
​object

MenuItem nesnesi (özet). Tüm alanlar için MenuItem şemasına bakın.

​object
level
​integer

MemberGroupSummary

id
​integer · required

Üye grubu nesnesinin kimlik değeri

Example: 123
name
​string · maxLength: 255 · required

Üye grubu ismi

Example: Üyeler
priceIndex
​integer · min: 1 · max: 5

Üye grubunun fiyat indeksi (örn. Fiyat 2 için 1)

Example: 1
priceRatio
​number · float · min: 0 · max: 5

Üye grubunun fiyat indeksi ile çarpanı

Example: 1
currentAccountStatus
​integer · enum

Hesabın aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
ideapayStatus
​integer · enum

Ideapay aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
​object

Üye grubuna izin verilen ödeme kanalları

Example: Custom, CreditCard, MailOrder ...

MemberAddressSummary

Üye adresi objesi
id
​integer

Adres için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Adres tanımlayıcı adı

Example: Ev
type
​string · enum

Adres tipi

Enum values:
shipping
billing
Example: shipping
firstname
​string · maxLength: 255

Adı

Example: Ahmet
surname
​string · maxLength: 255

Soyadı

Example: Yılmaz
address
​string · maxLength: 65535

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
zipCode
​string · maxLength: 64
subLocationName
​string · maxLength: 255

İlçe adı

Example: Üsküdar
locationName
​string · maxLength: 255

Şehir adı

Example: İstanbul
phoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 7 · maxLength: 32 · pattern: \D*(?:\d\D*){7,12}

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
taxNumber
​string · maxLength: 255 · pattern: ^[0-9]{10}$

Vergi numarası (kurumsal faturalar için)

Example: 1966712049
taxOffice
​string · maxLength: 255

Vergi dairesi (kurumsal faturalar için)

Example: Üsküdar
invoiceType
​string · enum · maxLength: 255

Fatura tipi

Enum values:
individual
corporate
Example: individual
isEinvoiceUser
​boolean · enum

E-fatura kullanıcısı mı?

Enum values:
Example: true
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​object

Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.

​object

Country nesnesi (özet). Tüm alanlar için Country şemasına bakın.

​object

Location nesnesi (özet). Tüm alanlar için Location şemasına bakın.

​object

Town nesnesi (özet). Tüm alanlar için Town şemasına bakın.

MemberSummary

Üye hesap bilgilerini içeren obje
id
​integer · required

Üye için benzersiz kimlik

Example: 123
firstname
​string · maxLength: 255

Üyenin adı

Example: Ahmet
surname
​string · maxLength: 255

Üyenin soyadı

Example: Yılmaz
email
​string · email

Üyenin e-posta adresi

Example: ahmet.yilmaz@example.com
password
​string · password · maxLength: 255 · writeOnly

Üye hesap şifresi (şifrelenmiş)

gender
​string · enum

Cinsiyet bilgisi

Enum values:
male
female
unspecified
Example: male
birthDate
​string · date-time

Doğum tarihi

Example: 1988-02-21T00:00:00+0000
phoneNumber
​string · maxLength: 32

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · maxLength: 32

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
status
​string · enum

Üye hesap durumu

Enum values:
queue
active
passive
suspended
Example: active
kvkkStatus
​integer · enum

KVKK (kişisel verilerin korunması) onay durumu

Enum values:
0
1
Example: 1
commercialName
​string · maxLength: 255

Kurumsal üyelik için şirket adı

Example: Ideasoft Yazılım San. ve Tic. A.Ş.
taxNumber
​string · minLength: 10 · maxLength: 255

Vergi numarası

Example: 1966712049
taxOffice
​string · maxLength: 255

Vergi dairesi

Example: Üsküdar
address
​string

Adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
​object

Country nesnesi (özet). Tüm alanlar için Country şemasına bakın.

​object

Location nesnesi (özet). Tüm alanlar için Location şemasına bakın.

locationName
​string

Şehir adı

otherLocation
​string · maxLength: 255

Alternatif şehir bilgisi

Example: Diğer şehir
district
​string · maxLength: 255

İlçe bilgisi

Example: Üsküdar
zipCode
​string · maxLength: 50

Posta kodu

Example: 34704
​object

MemberGroup nesnesi (özet). Tüm alanlar için MemberGroup şemasına bakın.

​object

CurrentAccount nesnesi (özet). Tüm alanlar için CurrentAccount şemasına bakın.

deviceType
​string · enum

Üyelik oluştururken kullanılan cihaz tipi

Enum values:
bilgisayar
mobil
Example: mobil
deviceInfo
​string · maxLength: 65535

Detaylı cihaz bilgisi (user agent)

lastIp
​string · ipv4 · maxLength: 255

Son giriş yapılan IP adresi

Example: 192.168.1.1
pointAmount
​number · decimal

Toplam kazanılan puan miktarı

Example: 10500
​object[]
allowedToPhone
​integer · enum

Telefon ile iletişim izni

Enum values:
0
1
Example: 1
allowedToCampaigns
​integer · enum

Kampanya bildirimleri için izin

Enum values:
0
1
Example: 1
allowedToSms
​integer · enum

SMS bildirimleri için izin

Enum values:
0
1
Example: 1
lastLoginDate
​string · date-time

Son giriş yapılan tarih ve zaman

lastMailSentDate
​string · date-time

Son e-posta gönderim tarihi

allowedToPhoneUpdatedAt
​string · date-time

Telefon izni son güncellenme zamanı

allowedToCampaignsUpdatedAt
​string · date-time

Kampanya izni son güncellenme zamanı

allowedToSmsUpdatedAt
​string · date-time

SMS izni son güncellenme zamanı

createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00

ManualRelationSummary

id
​integer · required

Nesne ilişkisi nesnesi kimlik değeri. Parent veya child olarak kullanılan nesneler arasındaki bağı tanımlamak için kullanılır.

name
​string

Nesne ilişkisi nesnesi ismi

title
​string · writeOnly

Nesne ilişkisi nesnesi başlığı

slug
​string
hasImage
​integer
status
​integer
newSortOrder
​integer

MaillistGroupSummary

id
​integer · required

Mail listesi grubunun benzersiz kimlik değeri.

name
​string · required

Mail listesi grubunun adı.

MaillistSummary

id
​integer · required

Mail listesi nesnesinin benzersiz kimlik değeri.

Example: 123
name
​string · maxLength: 255

Mail listesi nesnesinin adı.

Example: Mail listesi 1
email
​string

Mail adresi.

Example: mail@example.com
lastMailSentDate
​string · date-time

Son gönderim tarihi.

Example: 2022-04-18T09:15:30+03:00
creatorIpAddress
​string

Mail listesini oluşturan kullanıcının IP adresi.

Example: 10.10.10.1
​object

MaillistGroup nesnesi (özet). Tüm alanlar için MaillistGroup şemasına bakın.

createdAt
​string · date-time

Mail listesi nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Mail listesi nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

LocationSummary

id
​integer · required

Şehir nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string

Şehir nesnesi için isim değeri.

Example: İstanbul
status
​integer · enum

Şehir nesnesinin aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
​object

Country nesnesi (özet). Tüm alanlar için Country şemasına bakın.

​object

Region nesnesi (özet). Tüm alanlar için Region şemasına bakın.

LabelSummary

Kişisel etiket nesnesi
id
​integer · required

Kişisel etiket nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 255 · required

Kişisel etiket Adı

slug
​string · minLength: 1 · maxLength: 255

Etiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.

Example: indirimli-urunler
sortOrder
​integer · min: 0 · max: 999

Kişisel etiket nesnesi için sıralama değeri.

Example: 10
status
​integer · enum

Etiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.

Enum values:
0
1
Example: 1
hasChildren
​integer · enum

Kişisel etiket nesnesinin alt etiket barındırma durumu. Bu değer otomatik oluşturulur.

Enum values:
0
1
Example: 0
pageTitle
​string · maxLength: 255

Kişisel etiket nesnesi sayfa başlığı.

Example: Etiket 1
metaDescription
​string
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
tree
​string

Etiket hiyerarşisi ağacı. Üst ve alt etiketler arasındaki ilişkileri gösterir.

​object

Label nesnesi (özet). Tüm alanlar için Label şemasına bakın.

​object

Bu etiketin sahip olduğu alt etiketlerin listesi.

updatedAt
​string · date-time

Kişisel etiket nesnesinin son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kişisel etiket nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00

InstallmentRateSummary

installment
​integer · min: 1 · max: 36 · required

Taksit oranına ait taksit sayısı.

Example: 3
rate
​number · float · required

Taksit oranı değeri. Ödeme tutarı bu oranla çarpılır.

Example: 1.05
id
​integer

Taksit oranı nesnesinin benzersiz kimlik değeri.

Example: 1
​object

PaymentGateway nesnesi (özet). Tüm alanlar için PaymentGateway şemasına bakın.

FraudRiskSummary

Sipariş doğrulama için dolandırıcılık risk değerlendirme objesi
id
​integer · required

Dolandırıcılık risk kaynağı için benzersiz kimlik

Example: 12345
firstname
​string · maxLength: 255

Sipariş ile ilişkili ad

Example: Ahmet
surname
​string · maxLength: 255

Sipariş ile ilişkili soyad

Example: Yılmaz
email
​string · email

Sipariş için kullanılan e-posta adresi

Example: ahmet.yilmaz@example.com
phoneNumber
​string · minLength: 10 · maxLength: 20 · pattern: \D*(?:\d\D*){10,12}

Sipariş ile ilişkili telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · minLength: 10 · maxLength: 20 · pattern: \D*(?:\d\D*){10,12}

Sipariş ile ilişkili cep telefonu numarası

Example: +90 (555) 555 55 55
identityRegistrationNumber
​string · minLength: 11 · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
ip
​string · ipv4 · pattern: \b(?:\d{1,3}\.){3}\d…

Siparişin verildiği IP adresi

Example: 192.168.1.1
taxNo
​string · minLength: 10 · maxLength: 11

Vergi kimlik numarası

Example: 1234567890
note
​string · maxLength: 255

Risk değerlendirmesi hakkında ek notlar

Example: Yüksek risk kriteri tespit edildi
updatedAt
​string · date-time

Kaydın son güncellenme tarihi ve zamanı

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kaydın oluşturulma tarihi ve zamanı

Example: 2022-04-20T14:33:45+03:00

FraudOrderSummary

​object · required

FraudRisk nesnesi (özet). Tüm alanlar için FraudRisk şemasına bakın.

id
​integer

Riskli sipariş nesnesi kimlik değeri.

​object

Order nesnesi (özet). Tüm alanlar için Order şemasına bakın.

FormSettingSummary

varKey
​string · enum · required

Form alanı ayar seçeneği Seçenekler: | attributes: Form alanı özelliği

Enum values:
attributes
varValue
​string · required

Form alanı ayar seçeneği değeri

FormOptionSummary

name
​string · maxLength: 255 · required

Form alanı seçeneği kimlik değeri

Example: gender
marked
​integer · enum · required

Form alanı işaretlenme durumu

Enum values:
0
1
Example: 1
value
​string · maxLength: 255

Form alanı seçeneği değeri

Example: male

FormFieldSummary

type
​string · enum · maxLength: 255 · required

Form alanının tipi (ör. text, select, checkbox, radio, textarea vb.).

Enum values:
textbox
textarea
dropdown
radiobox
checkbox
info
name
​string · maxLength: 255 · required

Form alanının benzersiz ismi veya anahtar adı.

isRequired
​integer · enum · required

Form alanının zorunlu olup olmadığını belirler. Seçenekler: | 0: Devre dışı (alan doldurulması opsiyonel). | 1: Etkin (alan doldurulması zorunlu).

Enum values:
0
1
​object[] · required
​object[] · required

FilterMenuSettingSummary

Filtre bloğu ayarlarını temsil eder.
id
​integer

Filtre bloğu seçeneğine ait benzersiz kimlik numarası.

Example: 101
varKey
​string · maxLength: 255

Filtre bloğu seçeneğinin anahtar değeri.

Example: brand_sort_order_type
varValue
​string · maxLength: 255

Filtre bloğu seçeneğinin değerini belirtir.

Example: count
​object

filterMenu nesnesi (özet). Tüm alanlar için filterMenu şemasına bakın.

ExtraInstallmentSummary

Ekstra taksit seçeneği objesi
minLimit
​number · decimal · min: 0 · required

Taksit için minimum tutar limiti

Example: 100
rangeStart
​integer · min: 0 · max: 35 · required

Taksit sayısı aralığı alt değer

Example: 3
rangeEnd
​integer · min: 0 · max: 36 · required

Taksit sayısı aralığı üst değer

Example: 6
installment
​integer · min: 0 · max: 36 · required

Ekstra taksit sayısı (banka kampanyası)

Example: 3
id
​integer

Ekstra taksit için benzersiz kimlik

Example: 890
​object

PaymentGateway nesnesi (özet). Tüm alanlar için PaymentGateway şemasına bakın.

ExtraInfoSummary

Ek bilgi alanı tanımı objesi
id
​integer · required

Ek bilgi için benzersiz kimlik

Example: 78
name
​string · maxLength: 255 · required

Ek bilgi alanı adı

Example: Ürün Kılavuzu
sortOrder
​integer · min: 0 · max: 99

Görüntüleme sırası (küçükten büyüğe)

Example: 1

EntityMetaFieldSummary

Metafield nesnesi
customizationFieldId
​integer · required

Bu metafield'ın ait olduğu özelleştirme alanının kimlik numarası.

Example: 5
varKey
​string · maxLength: 255 · required

Metafield nesnesi seçeneği

varValue
​string · maxLength: 255 · required

Metafield nesnesi seçeneğinin değeri

id
​integer · writeOnly

Metafield nesnesine ait benzersiz kimlik numarası.

Example: 101
createdAt
​string · date-time · writeOnly

Metafield nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time · writeOnly

Metafield nesnesinin son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

DistributorSummary

Tedarikçi bilgileri objesi
id
​integer · required

Tedarikçi için benzersiz kimlik

Example: 501
name
​string · maxLength: 150 · required

Tedarikçi şirket adı

Example: ABC Tedarik Ltd. Şti.
email
​string · email · maxLength: 100

Tedarikçi iletişim e-posta adresi

Example: info@abctedarik.com
phone
​string · maxLength: 100

Tedarikçi telefon numarası

Example: +90 (212) 555 00 00
contactPerson
​string · maxLength: 200

Yetkili kişi adı soyadı

Example: Mehmet Demir

DigitalProductFileSummary

filename
​string · maxLength: 255 · required
extension
​string · required
id
​integer
url
​string
path
​string · writeOnly
attachment
​string · writeOnly
​object

Ürün detay objesi — product nesnesi (özet). Tüm alanlar için product şemasına bakın.

DigitalProductSummary

id
​integer
digitalProductFileName
​string · maxLength: 255
​object[]

CustomizationFieldOptionSummary

Özel form alanı seçenek objesi
name
​string · maxLength: 255 · required

Seçenek görünen adı

Example: Küçük Boy
value
​string · maxLength: 255 · required

Seçenek değeri

Example: small
id
​integer

Seçenek için benzersiz kimlik

Example: 123
​object

Özel form alanı tanımı — customizationField nesnesi (özet). Tüm alanlar için customizationField şemasına bakın.

updatedAt
​string · date-time · writeOnly

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time · writeOnly

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300

CustomizationFieldSummary

Özel form alanı tanımı
name
​string · maxLength: 255 · required

Alan adı/başlığı

Example: Özel Mesaj
isRequired
​integer · enum · required

Alan zorunluluğu

Enum values:
0
1
Example: 0
type
​string · enum · required

Form alanı tipi

Enum values:
checkbox
dropdown
file
radio
textarea
textbox
Example: textbox
id
​integer

Özel form alanı için benzersiz kimlik

Example: 123
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası (küçükten büyüğe)

Example: 999
placeHolder
​string · maxLength: 255

Alan için yer tutucu metin

Example: Mesajınızı buraya yazın...
info
​string · maxLength: 255

Alan hakkında açıklayıcı bilgi

Example: Maksimum 500 karakter girebilirsiniz
​object

Özel form grup tanımı objesi — customizationGroup nesnesi (özet). Tüm alanlar için customizationGroup şemasına bakın.

​object[]
settings
​object

Alan için ek yapılandırma ayarları

updatedAt
​string · date-time · writeOnly

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time · writeOnly

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300

CurrentAccountSummary

balance
​number · float · required

Cari hesap bakiyesi.

Example: 155.5
riskLimit
​number · float · min: 0 · required

Cari hesap için risk limiti.

Example: 155.5
id
​integer

Cari hesap nesnesi kimlik değeri.

Example: 123
​object

Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.

code
​string · maxLength: 255

Cari hesap için düzenlenebilir kod değeri.

Example: cari-hesap-kod-ornegi
title
​string · maxLength: 255

Cari hesap başlığı.

Example: Cari Hesap Başlığı
createdAt
​string · date-time

Cari hesap nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Cari hesap nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

CurrencySummary

id
​integer · required

Kur kimlik değeri.

Example: 123
label
​string

Kur etiketi.

Example: Türk Lirası
abbr
​string

Kur kısaltması.

Example: TL
buyingPrice
​number · float · min: 0

Kur alış fiyatı.

Example: 1
sellingPrice
​number · float · min: 0

Kur satış fiyatı.

Example: 1
status
​integer · enum

Kur aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
permissionStatus
​integer · enum

Kur kullanım izni durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
isPrimary
​integer · enum

Kurun birincil kur olup olmadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
isEffective
​integer · enum

Kurun efektif kur olarak kullanılıp kullanılmadığı. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
updatedAt
​string · date-time

Kurun güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300

CouponSummary

id
​integer · required

Hediye çeki nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Hediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.

Example: TESTKUPON123
currentUsage
​integer · min: 0

Hediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.

Example: 10
maxUsage
​integer · min: 1

Hediye çekinin toplam kullanım limiti.

Example: 100
maxUsagePerMember
​integer · min: 1

Bir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.

Example: 5
startDate
​string · date-time

Hediye çekinin geçerli olmaya başladığı tarih.

Example: 2015-04-16T00:00:00+03:00
endDate
​string · date-time

Hediye çekinin geçerlilik bitiş tarihi.

Example: 2015-05-16T00:00:00+03:00
​object

Creator nesnesi (özet). Tüm alanlar için Creator şemasına bakın.

minimumCheckoutLimit
​number · float

Kuponun kullanılabilmesi için gereken minimum sepet tutarı.

Example: 100
minimumCheckoutLimitTaxIncluded
​integer · enum

Minimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
discountType
​string · enum

Kupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.

Enum values:
fixed
percentage
Example: percentage
discountValue
​number · float

Kuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)

Example: 20
discountTaxIncluded
​integer · enum

İndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
filterType
​string · enum

Kuponun hangi ürün/kategori/marka/üyelerde geçerli olacağını belirtir. Seçenekler: | all: Tüm kategori ve markalarda geçerli. | product: Belirli ürünlerde geçerli. | category: Belirli kategorilerde geçerli. | brand: Belirli markalarda geçerli. | member: Belirli üyelere özel.

Enum values:
all
product
category
brand
member
Example: category
​object[]
​object[]
​object[]
​object[]
​object

MemberGroup nesnesi (özet). Tüm alanlar için MemberGroup şemasına bakın.

status
​integer · enum

Hediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
cargoFree
​integer · enum

Kuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
useDiscountedProducts
​integer · enum

Kuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
filterValidityType
​integer · enum

Kupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
Example: 1
couponWithoutMembership
​integer · enum
Enum values:
0
1
createdAt
​string · date-time

Hediye çekinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Hediye çekinin son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

CountrySummary

id
​integer

Ülke nesnesinin benzersiz kimlik (ID) değeri.

Example: 123
name
​string

Ülkenin adı.

Example: Türkiye
code
​string

ISO 3166-1 alpha-2 ülke kodu (2 harfli).

Example: TR
status
​integer · enum

Ülkenin aktiflik durumu. Seçenekler: | 0: Devre dışı (ülke kullanılmaz) | 1: Etkin (ülke kullanılabilir)

Enum values:
0
1
Example: 1
exportStatus
​integer · enum
Enum values:
0
1
selectedLanguage
​string
selectedCurrency
​string

ContractSummary

Abonelik sözleşmesi objesi
id
​integer · required

Abonelik için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Abonelik planı adı

Example: Aylık Kahve Aboneliği
status
​string · enum

Abonelik aktiflik durumu

Enum values:
0
1
Example: 1
description
​string

Abonelik plan açıklaması

Example: 30 günde 1 olmak üzere maksimum 4 kere çekilecek. %10 indirimli ve 15 TL kargo bedeli olacaktır.
periods
​string · maxLength: 255

Abonelik periyot sayısı

Example: 1
periodFrequency
​string · enum · maxLength: 255

Periyot sıklığı

Enum values:
Daily
Weekly
Monthly
Yearly
Example: Monthly
dispatchCounts
​string · maxLength: 255

Gönderim sayısı seçenekleri (virgülle ayrılmış)

Example: 1,2,3,4
shippingAmount
​number · float · min: 0

Ek kargo ücreti

Example: 15
discount
​integer · min: 0

İndirim tutarı veya oranı

Example: 10
chosenPeriod
​integer · min: 0

Müşteri tarafından seçilen periyot

Example: Monthly
chosenDispatchCount
​integer · min: 0

Müşteri tarafından seçilen gönderim sayısı

Example: 4
paymentToken
​string

Ödeme token'ı (kart saklama için)

Example: 7ea3e413cd9ef6074a01714qwe1f6e12
firstInstallmentRate
​number · float · min: 0

İlk taksit oranı

Example: 1
​object

OrderItem nesnesi (özet). Tüm alanlar için OrderItem şemasına bakın.

​object

Subscription nesnesi (özet). Tüm alanlar için Subscription şemasına bakın.

createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00

CombineProductSummary

Kombin ürün ilişki objesi
​object · required

ManualRelation nesnesi (özet). Tüm alanlar için ManualRelation şemasına bakın.

id
​integer

İlişki için benzersiz kimlik

Example: 123
​object

ManualRelation nesnesi (özet). Tüm alanlar için ManualRelation şemasına bakın.

CollectionSummary

id
​integer · required
name
​string · maxLength: 255 · required
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999
showcaseSortOrder
​integer · max: 500
displayShowcaseContent
​integer · enum
Enum values:
0
1
2
showcaseContent
​string
showcaseContentDisplayType
​integer · enum
Enum values:
1
2
3
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
showcaseFooterContent
​string
showcaseFooterContentDisplayType
​integer · enum
Enum values:
1
2
3
pageTitle
​string · maxLength: 255
metaKeywords
​string
metaDescription
​string
canonicalUrl
​string
​object

SeoSetting nesnesi (özet). Tüm alanlar için SeoSetting şemasına bakın.

createdAt
​string · date-time
updatedAt
​string · date-time

ClientSummary

name
​string · maxLength: 255 · required

Client adı.

Example: IdeasoftApp
id
​integer

Client nesnesine ait benzersiz kimlik numarası.

Example: 1
randomId
​string · minLength: 1 · maxLength: 255

Client için rastgele oluşturulmuş benzersiz kimlik.

secret
​string · minLength: 1 · maxLength: 255

Client gizli anahtarı. API erişimlerinde kullanılır.

​object

Client'ın yönlendirme URI'ları.

​object

Client için izin verilen yetkilendirme türleri.

createdAt
​string · date-time

Client nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Client nesnesinin son güncellenme zamanı.

Example: 2022-10-20T10:15:30+03:00
predefined
​boolean

Client'ın ön tanımlı olup olmadığını belirtir

Example: false

CategorySummary

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
id
​integer · required

Kategoriye ait benzersiz kimlik numarası. Sistem tarafından otomatik oluşturulur.

Example: 123
name
​string · maxLength: 255 · required

Kategori nesnesi için isim değeri.

Example: Kırtasiye
slug
​string · minLength: 1 · maxLength: 255

Slug değeri ilgili nesnenin Url değeridir.

Example: kirtasiye
sortOrder
​integer · min: 0 · max: 999

Kategori nesnesi için sıralama değeri.

Example: 999
showcaseSortOrder
​integer · max: 500
status
​integer · enum

Kategorinin aktiflik durumunu belirtir. Seçenekler: | 0: Pasif — kategori yayınlanmaz. | 1: Aktif — kategori mağazada görünür.

Enum values:
0
1
Example: 1
distributor
​string · maxLength: 255

Her zaman null değer alır. Pratikte kullanımı yoktur.

Example:
distributorCode
​string · maxLength: 255

Her zaman null değer alır. Pratikte kullanımı yoktur.

percent
​number · float · min: 0

Kategori nesnesinin fiyat katsayısı.

Example: 1
imageFile
​string · maxLength: 255

Kategori nesnesinin görselinin dosya adı. Geçerli dosya tipleri: .JPG, .PNG, .GIF

Example: kalem.jpg
displayShowcaseContent
​integer · enum

Kategori ü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.

Enum values:
0
1
2
Example: 2
showcaseContent
​string

Kategori nesnesinin üst içeriği. Admin paneli üzerinden düzenlenebilir.

Example: Üst içerik metni.
showcaseContentDisplayType
​integer · enum

Kategori 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.

Enum values:
1
2
3
Example: 2
displayShowcaseFooterContent
​integer · enum

Kategori 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.

Enum values:
0
1
2
showcaseFooterContent
​string

Kategori nesnesinin alt içeriği. Admin paneli üzerinden düzenlenebilir.

showcaseFooterContentDisplayType
​integer · enum

Kategori 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.

Enum values:
1
2
3
hasChildren
​integer · enum

Kategorinin alt kategorilere sahip olup olmadığını belirtir. Seçenekler: | 0: Var | 1: Yok

Enum values:
0
1
pageTitle
​string · maxLength: 255

Sayfanın arama motorları tarafından tespit edilebilecek başlık yazısı.

Example: Kırtasiye Ürünleri
metaDescription
​string

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string

İlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-de&#x11F;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..

Example: kategoriler/idea-kalem
tree
​string

tree

attachment
​string · writeOnly

attachment

​object

Category nesnesi (özet). Tüm alanlar için Category şemasına bakın.

​object

Alt kategori olan kategori listesi.

imageUrl
​string

Kategori nesnesinin görselinin URL'i

Example: test.myideasoft.com/test/aa/01/myassets/categories/2/Screenshot
isCombine
​integer · enum

Kategori 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

Enum values:
0
1
isSearchable
​integer · enum
Enum values:
0
1
​object

SeoSetting nesnesi (özet). Tüm alanlar için SeoSetting şemasına bakın.

createdAt
​string · date-time

Kategorinin oluşturulma zamanı (ISO 8601 formatında).

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

CartItemSubscriptionSummary

Sepet kalemi abonelik bilgisi objesi
chosenPeriod
​integer · required

Seçilen abonelik periyodu

chosenDispatchCount
​integer · required

Seçilen gönderim sayısı

Example: 12
​object · required

Subscription nesnesi (özet). Tüm alanlar için Subscription şemasına bakın.

id
​integer

Abonelik için benzersiz kimlik

Example: 123
​object

cartItem nesnesi (özet). Tüm alanlar için cartItem şemasına bakın.

CartItemAttributeSummary

Sepet kalemine ait özellikleri temsil eder.
name
​string · maxLength: 255 · required

Özelliğin adı (örn. Renk, Boyut).

Example: Renk
value
​string · maxLength: 255 · required

Özelliğin değeri (örn. Kırmızı, Büyük).

Example: Kırmızı
id
​integer

Sepet kalemi özelliğine ait benzersiz kimlik numarası.

Example: 123
productCustomizationFieldPath
​string · maxLength: 255

Bu özelliğin ürün özelleştirme alanı yolu.

​object

cartItem nesnesi (özet). Tüm alanlar için cartItem şemasına bakın.

CartItemSummary

quantity
​number · float · min: 0 · required

Bu ürünün sepetteki adedi.

Example: 15
​object · required

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

id
​integer

Sepet kaleminin benzersiz kimlik değeri.

Example: 123
productName
​string

Sepette yer alan ürünün adı.

Example: Kalem 2B
isProductPromotioned
​integer · enum

Ürünün bir promosyon kapsamında olup olmadığını belirtir. Seçenekler: | 0: Promosyon uygulanmamış. | 1: Promosyon uygulanmış.

Enum values:
0
1
Example: 1
price
​number · float

Sepet kaleminin birim fiyatı.

Example: 49.9
sku
​string
​object

cart nesnesi (özet). Tüm alanlar için cart şemasına bakın.

​object

CartItemSubscription nesnesi (özet). Tüm alanlar için CartItemSubscription şemasına bakın.

​object[]
​object[]
updatedAt
​string · date-time

Sepet kaleminin son güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300
createdAt
​string · date-time

Sepet kaleminin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

CartSummary

id
​integer

Sepet kimlik değeri

Example: 1
sessionId
​string · maxLength: 255

Sepet oturum kimliği

Example: v7ztzjyow1wgsg4wc4csg0w4oc4o8skok4c0sg800cgwcgo8o28qc2rxchf
​object

Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.

​object

Coupon nesnesi (özet). Tüm alanlar için Coupon şemasına bakın.

​object

Promotion nesnesi (özet). Tüm alanlar için Promotion şemasına bakın.

subTotal
​number · float
couponDiscount
​number · float
amountWithCouponDiscount
​number · float
taxAmount
​number · float
amountWithTax
​number · float
promotionDiscount
​number · float
amountWithPromotionDiscount
​number · float
​object[]
updatedAt
​string · date-time
createdAt
​string · date-time

BrandSummary

Marka objesi
id
​integer · required

Marka için benzersiz kimlik

Example: 123
name
​string · maxLength: 255 · required

Marka adı

Example: Idea Kalem
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası

Example: 999
distributorCode
​string · maxLength: 255

Tedarikçi kodu

Example: TED-123
distributor
​string · maxLength: 255

Tedarikçi adı

Example: Super Tedarik
imageFile
​string · maxLength: 255

Marka logo dosya adı (JPG, PNG, GIF)

Example: kalem.jpg
showcaseContent
​string

Marka sayfası üst içerik metni (HTML)

Example: <p>Üst içerik metni</p>
displayShowcaseContent
​integer · enum

Üst içerik gösterim durumu

Enum values:
0
1
Example: 1
showcaseFooterContent
​string
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
metaDescription
​string

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
metaKeywords
​string

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
imageUrl
​string

Marka logo URL'i

Example: //test.myideasoft.com/test/a/01/marka/marka.jpg
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded logo verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
​object

SeoSetting nesnesi (özet). Tüm alanlar için SeoSetting şemasına bakın.

isSearchable
​integer · enum
Enum values:
0
1
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

BlogTagSummary

id
​integer · required

Blog etiketi nesnesinin benzersiz kimlik değeri.

Example: 123
title
​string · maxLength: 255 · required

Blog etiketi başlığı.

Example: Teknoloji
slug
​string · minLength: 1 · maxLength: 255

Etiket için oluşturulan benzersiz URL değeri. Mağaza URL’nize eklenerek sayfanın linkini oluşturur.

Example: teknoloji
pageTitle
​string · maxLength: 255
metaKeywords
​string · maxLength: 65535
metaDescription
​string · maxLength: 65535
canonicalUrl
​string · minLength: 1 · maxLength: 255

Bu değer, mağazanızdaki ilgili blog etiketi sayfasına eklenecek <link rel="canonical" href="https://www.magaza-adiniz.com/{canonical-url}" /> HTML etiketinde kullanılır. Alan adı (domain) kısmı sistem tarafından otomatik eklenir, sadece {canonical-url} kısmını belirlemeniz yeterlidir.

Example: teknoloji-yazilari
status
​integer · enum

Blog etiketinin aktiflik durumu. Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
Example: 1
createdAt
​string · date-time

Blog etiketi nesnesinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Blog etiketi nesnesinin son güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00

BlogCategorySummary

id
​integer · required

Blog kategorisi nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
title
​string · maxLength: 255 · required

Blog kategorisi başlığını belirtir.

Example: Yılbaşı Fırsatları
slug
​string · minLength: 1 · maxLength: 255

Kategori için SEO uyumlu URL (slug) değeri.

Example: yilbasi
pageTitle
​string · maxLength: 255

Blog kategorisi nesnesinin sayfa başlığı bilgisi.

Example: E-Ticaret
metaKeywords
​string · maxLength: 65535

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 65535

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
canonicalUrl
​string · maxLength: 65535

Bu değer, mağazanızdaki ilgili blog kategori sayfasına eklenecek <link rel="canonical" href="https://www.magaza-adiniz.com/{canonical-url}" /> HTML etiketinde kullanılır. Alan adı (domain) kısmı sistem tarafından otomatik eklenir, sadece {canonical-url} kısmını belirlemeniz yeterlidir.

Example: marka/idea-kalem
blockVisibility
​integer · enum

Blog kategori blokunun görünürlük durumu. (0 = Gizli, 1 = Görünür) Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
status
​integer · enum

Blog kategorisinin aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 1
​object

BlogCategory nesnesi (özet). Tüm alanlar için BlogCategory şemasına bakın.

hasChildren
​integer · enum

Blog kategorisi nesnesinin alt kategori barındırıp barındırmadığını gösterir. Bu değer otomatik oluşturulur.(0 = Hayır, 1 = Evet) Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 1
​object

Alt kategoriler listesi.

createdAt
​string · date-time

Blog kategorisi nesnesinin oluşturulma tarihi.

Example: 2022-04-20T14:33:45+03:00
updatedAt
​string · date-time

Blog kategorisi nesnesinin güncellenme tarihi.

Example: 2022-04-20T14:33:45+03:00

BillingAddressSummary

firstname
​string · maxLength: 255 · required

Müşterinin ismi.

Example: John
surname
​string · maxLength: 255 · required

Müşterinin soy ismi.

Example: Doe
country
​string · maxLength: 128 · pattern: [\D\s]* · required

Müşterinin ülke bilgisi.

Example: Türkiye
location
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin şehir bilgisi.

Example: İstanbul
subLocation
​string · maxLength: 128 · pattern: [a-zA-Z0-9ğüşöçİıĞÜŞ… · required

Müşterinin ilçe bilgisi.

Example: Üsküdar
address
​string · minLength: 5 · maxLength: 255 · required

Müşterinin adres bilgisi.

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20} · required

Müşterinin mobil telefon numarası.

Example: +90 (555) 555 55 55
invoiceType
​string · enum · required

Fatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.

Enum values:
individual
corporate
Example: individual
id
​integer

Fatura adresi nesnesi kimlik değeri.

Example: 123
phoneNumber
​string · minLength: 7 · maxLength: 20 · pattern: \D*(?:\d\D*){7,20}

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
​object

Order nesnesi (özet). Tüm alanlar için Order şemasına bakın.

taxNo
​string · maxLength: 64

Fatura için vergi numarası.

Example: 4996725041
taxOffice
​string · maxLength: 255

Fatura için vergi dairesi.

Example: Üsküdar
identityRegistrationNumber
​string · minLength: 11 · maxLength: 11

Müşterinin T.C. Kimlik numarası.

Example: 11111111111