İçeriğe geç
Store API

UserLevel

id
​integer
label
​string
roles
​string

User

email
​string · email · maxLength: 255 · required

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

Example: johndoe@ideasoft.com.tr
username
​string · maxLength: 255 · required

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

Example: yonetici
status
​integer · enum · required

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
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
phoneNumber
​string · maxLength: 255
createdAt
​string · date-time · writeOnly

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

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

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

Example: 2018-02-21T15:01:03+0300
isOwner
​integer · enum
Enum values:
0
1
mfaSecret
​string · maxLength: 1024 · writeOnly
mfaResetKey
​string · maxLength: 256 · writeOnly
mfaMethod
​string · maxLength: 50 · writeOnly
mfaOtpCode
​string · maxLength: 50 · writeOnly
mfaOtpCodeSentAt
​string · date-time · writeOnly
​object · writeOnly
userRole
​object · writeOnly

TownGroup

name
​string · maxLength: 255 · required

İlçe grubu nesnesinin adı.

Example: Standart İlçeler
id
​integer

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

Example: 123
status
​boolean · maxLength: 255

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

Example: true

Town

İlçe nesnesi
name
​string · maxLength: 255 · required

İlçe adı.

Example: Üsküdar
id
​integer

İlçe nesnesine ait benzersiz kimlik numarası.

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

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

Enum values:
0
1
​LocationSummary
​TownGroupSummary

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
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:
self
standard
Example: standard
preset
​string

Temaya ait varsayılan renk

Example:
directoryName
​string

Temanın bulunduğu dizin adı.

Example: tpl-chalcedon
revision
​integer
version
​integer

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

assetJson
​string · writeOnly
renderJson
​string · writeOnly
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
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

Tag

SEO+ etiket nesnesi
id
​integer

SEO+ etiketi nesnesine ait benzersiz kimlik numarası

Example: 123
name
​string · maxLength: 255

SEO+ etiketi nesnesi adı.

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

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

Example: 2
pageTitle
​string · maxLength: 65535

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

Example: Kırmızı Kalem
metaDescription
​string · maxLength: 65535

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

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

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

Subscription

id
​integer

Abonelik nesnesi kimlik değeri

periods
​string

Abonelik periyodu

periodFrequency
​string

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

dispatchCounts
​string

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

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

name
​string

Abonelik nesnesi adı

description
​string

Açıklama

status
​string

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

discount
​integer

İndirim

shippingAmount
​number · float

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

SpecValue

name
​string · maxLength: 255 · required

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

Example: Kırmızı
id
​integer

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

Example: 101
slug
​string · maxLength: 255

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

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

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

Example: 1
logo
​string · enum

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

Enum values:
jpg
png
gif
jpeg
webp
avif
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
attachment
​string · writeOnly

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

size
​integer · writeOnly

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

​SpecGroupSummary

Ürün özellik grubu objesi

​SpecNameSummary

Ürün özelliği nesnesi

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

SpecToProduct

​SpecGroupSummary · required

Ürün özellik grubu objesi

​SpecNameSummary · required

Ürün özelliği nesnesi

​SpecValueSummary · required
id
​integer

Ürün özellik ürün bağı nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
​ProductSummary

Ürün detay objesi

SpecName

Ürün özelliği nesnesi
name
​string · maxLength: 255 · required

Ürün özelliği adı.

Example: Kapasite
id
​integer

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

Example: 123
slug
​string · maxLength: 255

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

Example: kapasite
choiceType
​string · enum · maxLength: 255

Ö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

SpecGroup

Ürün özellik grubu objesi
name
​string · maxLength: 255 · required

Özellik grubu adı

Example: Cep Telefonları
id
​integer

Özellik grubu için benzersiz kimlik

Example: 123
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

ShippingRate

volumetricWeightStart
​number · float · required

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

Example: 0
volumetricWeightEnd
​number · float · 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
id
​integer

Kargo oranı nesnesi kimlik değeri.

Example: 123
​RegionSummary
​ShippingCompanySummary

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

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
​object · writeOnly

Kargo sağlayıcısı nesnesi

ShippingProvider

Kargo sağlayıcısı nesnesi
code
​string · maxLength: 64 · required

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

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

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

Example: Idea Cargo
id
​integer

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

Example: 123
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}
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

ShippingCompany

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
name
​string · maxLength: 128 · required

Kargo firması nesnesi adı.

Example: Idea Cargo
id
​integer

Kargo firması nesnesine ait benzersiz kimlik numarası.

Example: 123
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

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

Example: 999
companyCode
​string · maxLength: 255

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

Example: CMP12KD
paymentType
​string · enum

Kargo ödemesinin tipini belirtir.

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
​ShippingProviderSummary

Kargo sağlayıcısı nesnesi

​CountrySummary[]

Ülkeler nesnesi listesi

createdAt
​string · date-time · writeOnly

Kargo firması nesnesinin oluşturulma zamanı.

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

Kargo firması nesnesinin son güncellenme zamanı.

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

ShippingAddress

Teslimat adresi objesi
firstname
​string · maxLength: 255 · required

Alıcı adı

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

Alıcı soyadı

Example: Yılmaz
country
​string · maxLength: 128 · required

Ülke adı

Example: Türkiye
location
​string · maxLength: 128 · required

Şehir adı

Example: İstanbul
address
​string · maxLength: 65535 · required

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · maxLength: 32 · required

Cep telefonu numarası

Example: +90 (555) 555 55 55
id
​integer

Adres için benzersiz kimlik

Example: 123
subLocation
​string · maxLength: 128

İlçe adı

Example: Üsküdar
phoneNumber
​string · maxLength: 32

Sabit telefon numarası

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

ShipmentItem

Sevkiyat kalemi objesi
amount
​integer · min: 0 · required

Gönderilen miktar (stok tipi cinsinden)

Example: 2
price
​number · float · min: 0 · required

Birim fiyat

Example: 20
currency
​string · enum · maxLength: 255 · required

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
dm3
​number · float · min: 0 · required

Desi (hacimsel ağırlık)

Example: 1.5
status
​integer · enum · required

Sevkiyat kalemi aktiflik durumu

Enum values:
0
1
Example: 1
​OrderItemSummary · required
id
​integer

Sevkiyat kalemi için benzersiz kimlik

Example: 123
rootProductId
​integer · min: 0

Ana ürün kimliği (varyantlar için)

Example: 123
productLabel
​string · maxLength: 255

Ürün adı/başlığı

Example: Kırmızı Kalem
tax
​integer · min: 0

KDV oranı (%)

Example: 18
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
​ProductSummary

Ürün detay objesi

​ShipmentSummary

Shipment

id
​integer

Teslimat nesnesi kimlik değeri.

Example: 123
barcode
​string · maxLength: 255

Teslimat barkodu.

Example: 12345678ASD
waybillNo
​string · maxLength: 255

Teslimat fatura numarası.

Example: A-1002
invoiceKey
​string · maxLength: 255

Teslimat irsaliye makbuzu numarası.

Example: A-1231
cargoOffice
​string · maxLength: 255

Teslimatın kargo şubesi

Example: Üsküdar
code
​string · maxLength: 255

Teslimat kodu. Kargo takip kodu.

Example: KOD123456
deliveryType
​string · maxLength: 255

Teslimat tipi

Example: deliveryType
invoiceIncluded
​integer · enum

Faturanın pakete dahillik durumunu belirtir.

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

Kapıda ödeme hizmeti bedeli.

Example: 5
createdAt
​string · date-time

Teslimat nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
status
​integer · enum

Teslimat nesnesinin aktiflik durumunu belirten değer.

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

Barkod resmi.

trackingUrl
​string · maxLength: 255

Takip linki.

SelectionToProduct

​SelectionSummary · required
​ProductSummary · required

Ürün detay objesi

id
​integer

Ek özellik ürün bağı nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123

SelectionGroup

title
​string · maxLength: 255 · required

Ek özellik grubu ismi.

Example: Renk Seçenekleri
sortOrder
​integer · required

Ek özellik grubu sırası.

Example: 1
id
​integer

Ek özellik grubu nesnesi kimlik değeri.

Example: 123

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
sortOrder
​integer · required

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

Example: 1
id
​integer

Ek özellik nesnesinin benzersiz kimlik değeri.

Example: 123
​SelectionGroupSummary

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 · writeOnly

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

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

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

Example: 2018-02-21T15:01:03+0300
client
​object · writeOnly

Region

name
​string · maxLength: 255 · required

Teslimat bölgesi ismi.

Example: Marmara
id
​integer

Teslimat bölgesi kimlik değeri.

Example: 1
​CountrySummary[]

Teslimat bölgesine ait ülkeler listesi.

createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

QuickCart

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

Sepet adı

Example: Ofis Malzemeleri Paketi
url
​string · maxLength: 2048 · required

Benzersiz URL tanımlayıcısı

Example: ofis-malzemeleri-paketi
id
​integer

Hızlı sepet için benzersiz kimlik

Example: 321
shortUrl
​string · maxLength: 255
createdAt
​string · date-time · writeOnly

Oluşturulma tarihi

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

Son güncellenme tarihi

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

PurchaseLimitationItem

Satın alma limiti kalemi objesi
id
​integer

Limit kalemi için benzersiz kimlik

Example: 456
​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.

​MemberGroupSummary
​ProductSummary

Ürün detay objesi

createdAt
​string · date-time · writeOnly

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

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

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

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

PurchaseLimitation

name
​string · required

Satın alma limiti nesnesine ait isim.

type
​string · enum · required

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
id
​integer

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

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.

status
​boolean · enum

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

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

Satın alma limiti nesnesinin oluşturulma tarihi.

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

Satın alma limiti nesnesinin güncellenme tarihi.

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

PromotionToCategory

​PromotionSummary · required
​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

PromotionToBrand

​PromotionSummary · required
​BrandSummary · required

Marka objesi

id
​integer

PromotionPriceRange

Promosyon fiyat aralığı objesi (basamaklı indirim)
id
​integer
​PromotionSummary
fromQty
​integer

Başlangıç adeti

toQty
​integer

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

discountAmount
​integer

İndirim miktarı (₺ veya %)

status
​boolean
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

Promotion

name
​string · required

Promosyon adı.

Example: Sepette %20 İndirim
id
​integer

Promosyon nesnesi kimlik değeri.

startDate
​string · date-time · writeOnly

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time · writeOnly
useDateFilter
​integer · enum · writeOnly

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

Enum values:
0
1
Example: 1
usageLimit
​integer · writeOnly
timesUsed
​integer · writeOnly
conditions
​string · writeOnly
freeShipping
​integer · enum · writeOnly

Ücretsiz kargo durumu.

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

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

Enum values:
0
1
Example: 0
minimumCheckoutLimit
​number · float · writeOnly

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

Example: 200
baseCategoryId
​integer · writeOnly
baseCategoryTree
​string · writeOnly
baseBrandId
​integer · writeOnly
baseProducts
​string · writeOnly
promotionValidityControl
​string · enum · writeOnly

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
minimumPurchaseQuantity
​integer · writeOnly
membersId
​string · writeOnly
memberGroupId
​integer · writeOnly
description
​string · writeOnly

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255 · writeOnly
urlBlankStatus
​boolean · writeOnly
imageFile
​string · maxLength: 255 · writeOnly
attachment
​string · writeOnly
promotionFeatureType
​string · enum · writeOnly

Promosyon özelliği tipi.

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

Promosyon özelliğine ait promosyon miktarı.

Example: 20
promotionalProducts
​string · writeOnly

Promosyonlu ürün nesnesi listesi

promotionalProductQuantity
​integer · writeOnly

Promosyonlu ürün miktarı.

Example: 1
useLabel
​boolean · writeOnly
status
​integer · enum · writeOnly

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​boolean · writeOnly
sortOrder
​integer · min: 1 · max: 999999 · writeOnly
createdAt
​string · date-time · writeOnly

Promosyon nesnesinin oluşturulma zamanı.

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

Promosyon nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00
​PromotionPriceRangeSummary[] · writeOnly
​PromotionToCategorySummary[] · writeOnly
​PromotionToBrandSummary[] · writeOnly

ProductToTag

​ProductSummary · required

Ürün detay objesi

​TagSummary · required

SEO+ etiket nesnesi

id
​integer

Ürün SEO+ etiketi bağı nesnesine ait benzersiz kimlik (ID) değeridir.

Example: 123

ProductToCountDown

useCountDown
​integer · enum · required

Geri sayımın aktiflik durumu bilgisini belirtir. ( 0=Pasif, 1=Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 0
id
​integer

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

Example: 123
startDate
​string · date-time

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

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

Geri sayımın bitiş tarihi.

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

Geri sayımın ürün için geçersiz olma tarihi.

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

Ürün detay objesi

ProductToCollection

​CollectionSummary · required
id
​integer
sortOrder
​integer · max: 500
​object · writeOnly

Ürün detay objesi

ProductToCategory

​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 bağı nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
sortOrder
​integer · max: 500

Ürün kategori bağının sıralama değeri. Bu değer, ürünün kategori içindeki görüntülenme sırasını belirler. Eğer vitrin sırası belirlenmek istenmiyorsa null atanabilir.

Example: 1
​ProductSummary

Ürün detay objesi

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 · maxLength: 255 · required

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

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

Özel bilgi alanı içeriği.

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

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

Example: 0
​ProductSummary · required

Ürün detay objesi

id
​integer

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

Example: 123

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
​ProductSummary · required

Ürün detay objesi

id
​integer

Ürün koruma nesnesi kimlik değeri.

Example: 123

ProductPrice

Ürün fiyatlandırma bilgilerini içeren obje
value
​number · float · min: 0 · required

Ürünün fiyat değeri

Example: 10.99
type
​integer · enum · min: 2 · max: 5 · required

Fiyat tipi (alternatif fiyat seçenekleri)

Enum values:
2
3
4
5
6
Example: 2
id
​integer

Ürün fiyatı için benzersiz kimlik

Example: 123
​ProductSummary

Ürün detay objesi

ProductImage

Ürün görseli objesi
filename
​string · maxLength: 255 · pattern: ^[a-z0-9-]+$ · required

Dosya adı (uzantısız)

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

Dosya uzantısı

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

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

Example: 1
id
​integer

Görsel için benzersiz kimlik

Example: 123
directoryName
​string · maxLength: 10
revision
​string · maxLength: 30
​ProductSummary

Ürün detay objesi

attachment
​string · pattern: ^data:image\/(jpeg|j…

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

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
alt
​string · maxLength: 150

ProductExtraField

varKey
​string · maxLength: 255 · required
id
​integer
​object · writeOnly

Ü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

ProductCommentImage

filename
​string · maxLength: 255 · required
extension
​string · enum · required
Enum values:
jpg
png
jpeg
id
​integer
directoryName
​string · maxLength: 10
​object · writeOnly
attachment
​string · writeOnly

ProductComment

title
​string · maxLength: 255 · required

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

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

Ü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ı.
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
​MemberSummary · required

Üye hesap bilgilerini içeren obje

​ProductSummary · required

Ürün detay objesi

​ProductSummary · required

Ürün detay objesi

id
​integer

Ürün yorumu nesnesi kimlik değeri.

Example: 123
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

ProductButton

Ürün buton ve rozet gösterim ayarları objesi
​ProductSummary · required

Ürün detay 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

Product

Ürün detay objesi
id
​integer

Ürün için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Ürün adı

Example: Kalem
slug
​string · maxLength: 65535 · pattern: ^[a-z0-9-]+$

URL dostu benzersiz tanımlayıcı

Example: kalem
fullName
​string · maxLength: 65535

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

Example: Kalem Kırmızı
sku
​string · maxLength: 255

Stok kodu (benzersiz)

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

Ürün barkodu

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

Ana satış fiyatı (Fiyat 1)

Example: 10.99
warranty
​integer · min: 0

Garanti süresi (ay)

Example: 24
tax
​integer · decimal · min: 0

KDV oranı (%)

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

Mevcut stok miktarı

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

Desi (hacimsel ağırlık)

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

Alış fiyatı

Example: 5.5
stockTypeLabel
​string · enum · maxLength: 255

Stok birim tipi

Enum values:
Piece
cm
Dozen
gram
kg
Person
Package
metre
Example: Piece
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
status
​integer · enum

Ürün aktiflik durumu

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

Fiyatlara KDV dahil mi?

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

Tedarikçi adı

Example: superTedarik
isGifted
​integer · enum
Enum values:
0
1
gift
​string · maxLength: 255

Hediye açıklaması

Example: Silgi hediyeli
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
marketPriceDetail
​string · maxLength: 255

Piyasa fiyatı açıklaması

Example: Diğer mağazalarda 15 TL
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
midblockSortOrder
​integer | null · writeOnly

Vitrin blokları sırası

Example: 1
metaKeywords
​string · maxLength: 65535

SEO meta anahtar kelimeler

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

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri.
pageTitle
​string · maxLength: 65535

SEO sayfa başlığı

Example: Kırmızı Kalem
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
​BrandSummary

Marka objesi

​object · writeOnly

Vitrin bloğu objesi

​CurrencySummary
​

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

Alternatif fiyatlar listesi

Ürün görselleri listesi

​ProductToCategorySummary[]
​ProductToCollectionSummary[]
​ProductExtraFieldSummary[]
​DigitalProductSummary
targetKeyword
​string · maxLength: 255

Preference

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
varValue
​string

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

PreOrderInfo

sessionId
​string · maxLength: 255 · required

Üyenin son oturumunun benzersiz kimlik değeri

Example: oibtkn9rspcdbmphf8iceondg1
customerFirstname
​string · maxLength: 255 · required

Müşterinin adı

Example: John
customerSurname
​string · maxLength: 255 · required

Müşterinin soyadı

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

Müşterinin e-posta adresi

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

Teslimat yapılacak kişinin adı

Example: John
shippingSurname
​string · maxLength: 255 · required

Teslimat yapılacak kişinin soyadı

Example: Doe
shippingAddress
​string · maxLength: 65535 · required

Teslimat adresi detayları

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
shippingPhoneNumber
​string · maxLength: 32 · required

Teslimat yapılacak kişinin telefon numarası

Example: +90 (216) 326 04 77
shippingMobilePhoneNumber
​string · maxLength: 32 · required

Teslimat yapılacak kişinin mobil telefon numarası

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

Teslimat şehri

Example: İstanbul
shippingTown
​string · maxLength: 128 · required

Teslimat ilçesi

Example: Üsküdar
billingFirstname
​string · maxLength: 255 · required

Fatura kesilecek kişinin adı

Example: John
billingSurname
​string · maxLength: 255 · required

Fatura kesilecek kişinin soyadı

Example: Doe
billingAddress
​string · maxLength: 65535 · required

Fatura adresi detayları

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
billingPhoneNumber
​string · maxLength: 32 · required

Fatura kesilecek kişinin telefon numarası

Example: +90 (216) 326 04 77
billingMobilePhoneNumber
​string · maxLength: 32 · required

Fatura kesilecek kişinin mobil telefon numarası

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

Fatura adresi şehri

Example: İstanbul
billingTown
​string · maxLength: 128 · required

Fatura adresi ilçesi

Example: Üsküdar
billingInvoiceType
​string · enum · required

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

Enum values:
individual
corporate
Example: individual
​CountrySummary · required
​LocationSummary · required
​ShippingCompanySummary · required

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

​CountrySummary · required
​LocationSummary · required
id
​integer

Sipariş öncesi bilgisi nesnesinin kimlik değeri

Example: 123
differentBillingAddress
​integer · enum · writeOnly

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

Enum values:
0
1
Example: 0
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
billingZipCode
​string · maxLength: 64
billingTaxNo
​string · maxLength: 128

Fatura kesilen kişi/kurum vergi numarası

Example: 9325912620
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
shippingZipCode
​string
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
​MemberAddressSummary

Üye adresi objesi

​MemberAddressSummary

Üye adresi objesi

PaymentType

name
​string · maxLength: 255 · required

Ödeme tipinin adı.

Example: Havale
id
​integer

Ödeme tipi nesnesi kimlik değeri.

Example: 123
sortOrder
​integer · min: 0 · writeOnly

Ödeme tipinin sıralama değeri.

PaymentProviderSetting

Ödeme sağlayıcısına ait yapılandırma ayarlarını temsil eder.
varKey
​string · maxLength: 255 · required

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

Example: agentId
varValue
​string · required

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

Example: PALIKJXZQ
id
​integer

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

Example: 123
​object · writeOnly

PaymentProvider

id
​integer

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

Example: 123
code
​string · maxLength: 255

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

Example: MoneyOrder
name
​string · maxLength: 255

Ö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
​PaymentTypeSummary

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

​PaymentBddkCategorySummary[]

PaymentGatewaySetting

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

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

Example: 123
​object · writeOnly

PaymentGateway

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
id
​integer

Ödeme kanalı nesnesinin benzersiz kimlik değeri.

Example: 123
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
sortOrder
​integer · min: 0

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

Example: 999
createdAt
​string · date-time · writeOnly

Ödeme kanalı nesnesinin oluşturulma zamanı.

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

Ödeme kanalı nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
legacyTableName
​string · maxLength: 512 · writeOnly
legacyTableId
​integer · min: 1 · writeOnly
​PaymentProviderSummary

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

PaymentBddkCategory

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

Payment

Ödeme işlemi detay objesi
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 · maxLength: 255 · required

Ödeme yapan üyenin e-posta adresi

Example: ahmet.yilmaz@example.com
paymentTypeName
​string · maxLength: 128 · required

Ödeme yöntemi adı

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

Ödeme sağlayıcı kodu

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

Ödeme sağlayıcı adı

Example: IdeaPay
paymentGatewayName
​string · maxLength: 128 · required

Ödeme gateway adı

Example: IdeaCard
paymentGatewayCode
​string · maxLength: 128 · required

Ödeme gateway kodu

Example: ideacard
deviceType
​string · enum · required

Ödemenin yapıldığı cihaz tipi

Enum values:
desktop
mobile
tablet
Example: mobile
clientIp
​string · ipv4 · maxLength: 40 · required

Müşterinin IP adresi

Example: 192.168.1.1
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
status
​string · enum · required

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: approved
id
​integer

Ödeme için benzersiz kimlik

Example: 123
memberPhone
​string · maxLength: 255

Ödeme yapan üyenin telefon numarası

Example: +90 (216) 326 04 77
bankName
​string · maxLength: 128

İşlem yapılan banka adı

Example: Idea Bank
cardHolderName
​string · maxLength: 64 · writeOnly

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
transactionId
​string · maxLength: 255

İşlem numarası

Example: 152502357
memberNote
​string · maxLength: 65535

Müşteri tarafından eklenen sipariş notu

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

Yönetici tarafından eklenen sipariş notu

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

Hatalı ödeme işlemlerinde hata mesajı

Example: Limit yetersiz
cardSavingSystem
​string · maxLength: 255

Kullanılan kart saklama sistemi

Example: ideasave
createdAt
​string · date-time

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

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

Üye hesap bilgilerini içeren obje

​object · writeOnly
​object · writeOnly
​object · writeOnly

Orders

id
​integer

Siparişe ait benzersiz kimlik (ID) değeridir.

Example: 123
customerFirstname
​string · maxLength: 255

Müşterinin adı.

Example: John
customerSurname
​string · maxLength: 255

Müşterinin soyadı.

Example: Doe
customerEmail
​string · maxLength: 255

Müşterinin e-mail adresi.

Example: johndoe@ideasoft.com.tr
customerPhone
​string · maxLength: 32

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
paymentTypeName
​string · maxLength: 128

Siparişin ödeme tipi.

Example: Havale
paymentProviderCode
​string · maxLength: 128

Siparişin ödeme altyapısı sağlayıcısının sistemdeki kod değeri. Ön tanımlıdır. API otomatik oluşturur.

Example: MoneyOrder
paymentProviderName
​string · maxLength: 128

Siparişin ödeme altyapısı sağlayıcısının adı. Ön tanımlıdır. API otomatik oluşturur.

Example: Havale
paymentGatewayCode
​string · maxLength: 255

Siparişin ödeme kanalının kodu. Ön tanımlıdır. API otomatik oluşturur.

Example: ideabank_1
paymentGatewayName
​string · maxLength: 255

Siparişin ödeme kanalının adı. Ön tanımlıdır. API otomatik oluşturur.

Example: IdeaBank
bankName
​string · maxLength: 128

Sipariş sırasında seçilen veya kullanılan banka adı. Ön tanımlıdır. API otomatik oluşturur.

Example: IdeaBank
cardHolderName
​string · maxLength: 255 · writeOnly
clientIp
​string · maxLength: 40

Siparişi oluşturan müşterinin IP adresi.

Example: 192.168.1.1
userAgent
​string · maxLength: 1024

Siparişin oluşturulduğu cihaz/tarayıcı 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 · maxLength: 32

Siparişte kullanılan kur(para birimi) kodu.

Example: TL
currencyRates
​string · maxLength: 65535

İlgili para birimleri ve alış/satış oranlarını içeren nesne, kur oranları.

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

Siparişin vergi hariç ara toplam tutarı.

Example: 1.69492
couponDiscount
​number · float · min: 0

Siparişte kullanılan hediye çeki indirimi tutarı.

Example: 0
taxAmount
​number · float · min: 0

Siparişin için hesaplanan toplam vergi tutarı.

Example: 0.30508
promotionDiscount
​number · float · min: 0

Siparişte kullanılan promosyon indirimi tutarı.

Example: 0
generalAmount
​number · float · min: 0

Siparişin genel toplam fiyat tutarı. orderAmount, couponDiscount, taxAmount, promotionDiscount, shippingAmount, additionalServiceAmount tutarlarının toplamı.

Example: 2
shippingAmount
​number · float · min: 0

Sipariş için tahsil edilen kargo/teslimat ücreti.

Example: 5
additionalServiceAmount
​number · float

Siparişe ait ek hizmet ücretlerinin toplamı.

Example: 0
finalAmount
​number · float · min: 0

Siparişin son ödeme tutarı. (generalAmount üzerine taksit/vade farkı eklendiyse dahil edilmiş hali).

Example: 2
sumOfGainedPoints
​number · float · min: 0

Siparişten müşterinin kazanacağı toplam puan miktarı.

Example: 200
installment
​integer · min: 0 · max: 18

Sipariş için seçilen taksit sayısı.

Example: 0
installmentRate
​number · float

Siparişin taksit oranı.

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

Sipariş için seçilen ek taksit sayısı.

Example: 0
transactionId
​string · maxLength: 255

Sipariş numarası.

Example: c88728ce28151
hasUserNote
​integer · enum

Siparişin müşteri notu içerip içermediğini belirtir. (0 = Yok, 1 = Var) Seçenekler: | 0: Sipariş müşteri notuna sahip değil. | 1: Sipariş müşteri notuna sahip.

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

Siparişin genel durumu. Seçenekler: | deleted: Silindi | waiting_for_approval: Onay Bekliyor | approved: Onaylandı | fulfilled: Kargoya Verildi | cancelled: İptal Edildi | delivered: Teslim Edildi | on_accumulation: Tedarik Sürecinde | waiting_for_payment: Ödeme Bekleniyor | being_prepared: Hazırlanıyor | refunded: İade Edildi | personal_status_1: Kişisel Sipariş Durumu 1 | personal_status_2: Kişisel Sipariş Durumu 2 | personal_status_3: Kişisel Sipariş Durumu 3

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: waiting_for_approval
paymentStatus
​string · enum

Ödeme işleminin sonucu/durumu. Seçenekler: | in_transaction: Sonuçlanmamış Ödemeler | failed: Hatalı Ödemeler | success: Başarılı

Enum values:
in_transaction
failed
success
Example: success
errorMessage
​string · maxLength: 65535

Sipariş ile ilgili hata mesajı (varsa).

Example: Limit yetersiz.
sessionId
​string · maxLength: 255 · writeOnly
deviceType
​string · enum

Siparişin gerçekleştiği cihaz bilgisi. Seçenekler: | desktop: Masaüstü | mobile: Mobil | tablet: Tablet

Enum values:
desktop
mobile
tablet
unknown
Example: desktop
referrer
​string · maxLength: 65535

Siparişe yönlendiren web sitesinin tam URL bilgisi. API otomatik oluşturur.

Example: https://www.referrer.com
invoicePrintCount
​integer · min: 0

Sipariş için alınan fatura çıktısı adedi.

Example: 1
useGiftPackage
​integer · enum

Hediye paketi talebi durumu. (0 = İstemiyorum, 1 = İstiyorum) Seçenekler: | 0: Hediye paketi istemiyorum | 1: Hediye paketi istiyorum

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

Müşterinin bıraktığı hediye notu (varsa).

Example: Doğum günün kutlu olsun.
giftAmount
​number · float · min: 0
memberGroupName
​string · maxLength: 255

Sipariş veren müşterinin üye grubunun adı.

Example: Üyeliksiz alışveriş
usePromotion
​integer · enum

Siparişte promosyon kullanılıp kullanılmadığını belirtir. (0 = Hayır, 1 = Evet) Seçenekler: | 0: Promosyon kullanma | 1: Promosyon kullan

Enum values:
0
1
Example: 0
shippingProviderCode
​string · maxLength: 128

Siparişin teslimat hizmeti sağlayıcısının kodu. Ön tanımlıdır. API otomatik oluşturur.

Example: idea
shippingProviderName
​string · maxLength: 128

Siparişin teslimat hizmeti sağlayıcısının adı. Ön tanımlıdır.

Example: Idea Cargo
shippingCompanyName
​string · maxLength: 128

Siparişin kargo firmasının adı. Ön tanımlıdır.

Example: Idea Cargo
shippingPaymentType
​string · enum

Siparişin kargo ödemesinin tipi. Seçenekler: | cash_on_delivery: Alıcı Ödemeli | standart_delivery: Gönderici Ödemeli | not_applicable: Bu alan için geçerli değil.

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

Siparişin kargo takip kodu.

Example: 123123IDEA
nebimTransferStatus
​integer · enum · writeOnly
Enum values:
0
1
paidFromCurrentAccount
​integer · enum
Enum values:
0
1
source
​string · maxLength: 255

Siparişin geldiği kaynak bilgisi. Siparişin kaynak yazılımını belirtir.

Example: IdeaShop Payment
createdAt
​string · date-time

Sipariş kaydının oluşturulma tarihi.

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

Sipariş kaydının güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
orderDay
​string · date-time · writeOnly
​MaillistSummary
​MemberSummary

Üye hesap bilgilerini içeren obje

​object · writeOnly
​object · writeOnly
​object · writeOnly
​object · writeOnly
​object · writeOnly

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

​object · writeOnly

Kargo sağlayıcısı nesnesi

​OrderDetailSummary[]

Sipariş detaylarının bilgisi..

​OrderItemSummary[]

Sipariş kalemlerinin listesi.

​ShippingAddressSummary

Teslimat adresi objesi

​BillingAddressSummary
autoPayback
​boolean · enum · writeOnly
Enum values:
0
1

OrderUserNote

Sipariş yönetici notu objesi
userEmail
​string · email · required

Not ekleyen yöneticinin e-posta adresi

Example: admin@example.com
note
​string · maxLength: 65535 · required

Not içeriği

Example: Kutulanırken dikkat edilecek
createdAt
​string · date-time · required

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​OrdersSummary · required
id
​integer

Not için benzersiz kimlik

Example: 123
userFirstname
​string · maxLength: 255

Yöneticinin adı

Example: Ahmet
userSurname
​string · maxLength: 255

Yöneticinin soyadı

Example: Yılmaz
​object · writeOnly

OrderRefundRequestItem

amount
​number · float · min: 0 · required

Talep edilen ürün miktarı.

Example: 1
reason
​string · maxLength: 1024 · required

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

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

Talebin detaylı açıklaması.

Example: Ürünü iade etmek istiyorum. Çünkü ürünü beğenmedim.
​OrderItemSummary · required
​OrderRefundRequestSummary · required
id
​integer

Sipariş iptal talebi kalemi nesnesi kimlik değeri.

Example: 123
paybackStatus
​integer · enum

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

Enum values:
0
1
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

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
status
​string · enum

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
fee
​number · float · min: 0

Müşteriye ödenecek tutar bilgisi.

Example: 15
shippingFee
​number · float · min: 0

Kargo tutarı.

autoPayback
​integer · enum

Otomatik geri ödeme durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
cancellationReason
​string · maxLength: 512

Sipariş iptal talebinin sebebine dair detaylı açıklama.

Example: Ürün kusurlu.
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
​MemberSummary

Üye hesap bilgilerini içeren obje

OrderItemSubscription

Sipariş kalemi ile ilişkili abonelik bilgilerini temsil eder.
id
​integer

Sipariş kalemi aboneliğine ait benzersiz kimlik numarası.

Example: 123
chosenPeriod
​integer · writeOnly
chosenDispatchCount
​integer · writeOnly
​object · writeOnly
​object · writeOnly

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

Ö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

Alan tipi

Enum values:
text
textarea
file
dropdown
radio
checkbox
Example: text
productCustomizationFieldName
​string

Alan adı

Example: Sertifika Düzenlenen Kişi
productCustomizationFieldSortOrder
​integer · writeOnly
productCustomizationFieldValue
​string

Müşterinin girdiği değer

Example: Ahmet Yılmaz
cartItemAttributeId
​integer

İlişkili sepet kalemi özellik kimliği

Example: 789
isCloudFile
​boolean · writeOnly

Dosyanın bulut depolama kullanıp kullanmadığı

cloudContentUrl
​string · uri · writeOnly

Bulut depolama dosya URL'i

Example: https://cdn.example.com/file.pdf
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly
​object · writeOnly

OrderItem

id
​integer

Sipariş kaleminin benzersiz kimlik (ID) değeri.

Example: 123
productName
​string · maxLength: 255

Siparişteki ürünün adı.

Example: Kalem
productSku
​string · maxLength: 255

Ürünün stok kodu (SKU).

Example: KAL-1234
productBarcode
​string · maxLength: 255

Ürünün barkod numarası.

Example: 869456789874
productPrice
​number · float · min: 0

Ürünün birim fiyatı.

Example: 15
productCurrency
​string · maxLength: 32

Ü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

Siparişteki ürün adedi (stok tipi cinsinden).

Example: 1
productTax
​integer · min: 0

Ürünün vergi oranı (yüzde cinsinden).

Example: 18
productDiscount
​number · float

Ürüne uygulanan standart indirim miktarı.

Example: 5
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
maxInstallment
​integer · writeOnly
priceRatio
​number · float · min: 0 · max: 5
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly
​ProductSummary

Ürün detay objesi

​DigitalProductSummary
​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

Options

Varyant seçenek objesi (renk değeri, beden değeri vb.)
title
​string · maxLength: 255 · required

Varyant değeri adı (Kırmızı, L, 42 vb.)

Example: Kırmızı
id
​integer

Varyant seçeneği için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255
sortOrder
​integer · min: 1 · max: 9999

Görüntüleme sırası

Example: 999
logo
​string · enum · pattern: ^[a-zA-Z0-9-_]+\.(jp…

Varyant görseli dosya adı (uzantı ile birlikte)

Enum values:
jpg
png
gif
jpeg
webp
avif
Example: kirmizi-logo.jpg
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded görsel verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
size
​integer · writeOnly
updatedAt
​string · date-time
createdAt
​string · date-time

OptionToProduct

parentProductId
​integer · required

Ana ürüne ait benzersiz kimlik (ID) değeridir.

Example: 123
​OptionGroupSummary · required

Varyant grubu objesi (renk, beden vb.)

​OptionsSummary · required

Varyant seçenek objesi (renk değeri, beden değeri vb.)

​ProductSummary · required

Ürün detay objesi

id
​integer

Varyant ürün bağı nesnesine ait benzersiz kimlik (ID) değeridir.

Example: 123
sortOrder
​integer · min: 0 · max: 255 · 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

Midblock

Vitrin bloğu objesi
name
​string · maxLength: 255 · required

Vitrin bloğu adı

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

Blok aktiflik durumu

Enum values:
0
1
Example: 1
sortOrder
​integer · required

Görüntüleme sırası

Example: 1
productCountPerRow
​integer · enum · required

Satırda gösterilecek ürün sayısı

Enum values:
1
2
3
4
5
Example: 4
id
​integer

Vitrin bloğu için benzersiz kimlik

Example: 567

MemberGroup

name
​string · maxLength: 255 · required

Üye grubu ismi

Example: Üyeler
id
​integer

Üye grubu nesnesinin kimlik değeri

Example: 123
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
allowedPaymentGateways
​string · maxLength: 512

MemberDetail

varKey
​string · maxLength: 255 · required
varValue
​string · maxLength: 65535 · required
id
​integer
​object · writeOnly

Üye hesap bilgilerini içeren obje

createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

MemberAddress

Üye adresi objesi
id
​integer

Adres için benzersiz kimlik

Example: 123
name
​string

Adres tanımlayıcı adı

Example: Ev
type
​string · enum

Adres tipi

Enum values:
shipping
billing
Example: shipping
firstname
​string

Adı

Example: Ahmet
surname
​string

Soyadı

Example: Yılmaz
address
​string

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
locationName
​string · writeOnly

Şehir adı

Example: İstanbul
subLocationName
​string

İlçe adı

Example: Üsküdar
phoneNumber
​string

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
taxNumber
​string · pattern: ^[0-9]{10}$

Vergi numarası (kurumsal faturalar için)

Example: 1966712049
taxOffice
​string

Vergi dairesi (kurumsal faturalar için)

Example: Üsküdar
invoiceType
​string · enum

Fatura tipi

Enum values:
individual
corporate
Example: individual
isEinvoiceUser
​boolean

E-fatura kullanıcısı mı?

Example: true
zipCode
​string · maxLength: 64
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

Ü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 · maxLength: 255

Üyenin e-posta adresi

Example: ahmet.yilmaz@example.com
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: 255

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · maxLength: 255

Cep telefonu numarası

Example: +90 (555) 555 55 55
otherLocation
​string · maxLength: 255

Alternatif şehir bilgisi

Example: Diğer şehir
address
​string · maxLength: 65535

Adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
taxNumber
​string · minLength: 10 · maxLength: 255

Vergi numarası

Example: 1966712049
tcId
​string · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
password
​string · password · maxLength: 255 · writeOnly

Üye hesap şifresi (şifrelenmiş)

activationCode
​string · maxLength: 255 · writeOnly
status
​string · enum

Üye hesap durumu

Enum values:
queue
active
passive
suspended
Example: active
lastLoginDate
​string · date-time

Son giriş yapılan tarih ve 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
zipCode
​string · maxLength: 50

Posta kodu

Example: 34704
commercialName
​string · maxLength: 255

Kurumsal üyelik için şirket adı

Example: Ideasoft Yazılım San. ve Tic. A.Ş.
taxOffice
​string · maxLength: 255

Vergi dairesi

Example: Üsküdar
lastMailSentDate
​string · date-time

Son e-posta gönderim tarihi

lastIp
​string · ipv4 · maxLength: 255

Son giriş yapılan IP adresi

Example: 192.168.1.1
gainedPointAmount
​number · float · min: 0
spentPointAmount
​number · float · min: 0
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
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ı

referredMemberGainedPointAmount
​number · float · min: 0
district
​string · maxLength: 255

İlçe bilgisi

Example: Üsküdar
deviceType
​string · enum · maxLength: 255

Üyelik oluştururken kullanılan cihaz tipi

Enum values:
bilgisayar
mobil
Example: mobil
deviceInfo
​string · maxLength: 65535

Detaylı cihaz bilgisi (user agent)

​CountrySummary
​LocationSummary
locationName
​string · writeOnly

Şehir adı

​MemberGroupSummary
​MemberSummary

Üye hesap bilgilerini içeren obje

kvkkStatus
​integer · enum

KVKK (kişisel verilerin korunması) onay durumu

Enum values:
0
1
Example: 1
kvkkConfirmationDate
​string · date-time
confirmationToken
​string · writeOnly
confirmationTokenExpirationDate
​string · date-time · writeOnly
​MemberDetailSummary[]

MaillistGroup

name
​string · maxLength: 255 · required

Mail listesi grubunun adı.

id
​integer

Mail listesi grubunun benzersiz kimlik değeri.

Maillist

name
​string · maxLength: 255 · required

Mail listesi nesnesinin adı.

Example: Mail listesi 1
email
​string · maxLength: 255 · required

Mail adresi.

Example: mail@example.com
​MaillistGroupSummary · required
id
​integer

Mail listesi nesnesinin benzersiz kimlik değeri.

Example: 123
lastMailSentDate
​string · date-time

Son gönderim tarihi.

Example: 2022-04-18T09:15:30+03:00
creatorIpAddress
​string · maxLength: 64

Mail listesini oluşturan kullanıcının IP adresi.

Example: 10.10.10.1
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

Şehir nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 255

Ş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
predefined
​integer · enum
Enum values:
0
1
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly
​CountrySummary
​RegionSummary

LabelToProduct

Etiket-Ürün ilişki objesi
​LabelSummary · required

Kişisel etiket nesnesi

​ProductSummary · required

Ürün detay objesi

id
​integer

İlişki için benzersiz kimlik

Example: 123

Label

Kişisel etiket nesnesi
id
​integer

Kişisel etiket nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 255

Kişisel etiket Adı

sortOrder
​integer · min: 0 · max: 999

Kişisel etiket nesnesi için sıralama değeri.

Example: 10
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
slug
​string · maxLength: 65535

Etiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.

Example: indirimli-urunler
metaTitle
​string · maxLength: 255
metaKeywords
​string · maxLength: 255

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 255
status
​integer · enum

Etiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.

Enum values:
0
1
Example: 1
root
​integer · writeOnly
level
​integer · writeOnly
leftIndex
​integer · writeOnly
rightIndex
​integer · writeOnly
​LabelSummary

Kişisel etiket nesnesi

createdAt
​string · date-time

Kişisel etiket nesnesinin oluşturulma zamanı.

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

Kişisel etiket nesnesinin son güncellenme zamanı.

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

InstallmentRate

installment
​integer · required

Taksit oranına ait taksit sayısı.

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

Taksit oranı değeri. Ödeme tutarı bu oranla çarpılır.

Example: 1.05
​PaymentGatewaySummary · required
id
​integer

Taksit oranı nesnesinin benzersiz kimlik değeri.

Example: 1

FavouritedProduct

​MemberSummary · required

Üye hesap bilgilerini içeren obje

​ProductSummary · required

Ürün detay objesi

id
​integer

Favori ürün nesnesine ait benzersiz kimlik (ID) değeridir.

Example: 123
createdAt
​string · date-time · writeOnly

ExtraInfoToProduct

value
​string · maxLength: 65535 · required

Ek bilgi ürün bağı değeridir. Ek bilgi "renk" ise bu değer kırmızı olabilir.

Example: Kırmızı
​ExtraInfoSummary · required

Ek bilgi alanı tanımı objesi

​ProductSummary · required

Ürün detay objesi

id
​integer

Ek bilgi ürün bağı nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123

ExtraInfo

Ek bilgi alanı tanımı objesi
id
​integer

Ek bilgi için benzersiz kimlik

Example: 78
name
​string · maxLength: 255

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

DistributorToProduct

Tedarikçi-Ürün ilişki objesi
​DistributorSummary · required

Tedarikçi bilgileri objesi

​ProductSummary · required

Ürün detay objesi

id
​integer

İlişki için benzersiz kimlik

Example: 123
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

Distributor

Tedarikçi bilgileri objesi
name
​string · maxLength: 150 · required

Tedarikçi şirket adı

Example: ABC Tedarik Ltd. Şti.
id
​integer

Tedarikçi için benzersiz kimlik

Example: 501
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
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

DigitalProduct

id
​integer
​object · writeOnly

Ürün detay objesi

deletedAt
​string · date-time · writeOnly

CurrentAccount

title
​string · maxLength: 255 · required

Cari hesap başlığı.

Example: Cari Hesap Başlığı
​MemberSummary · required

Üye hesap bilgilerini içeren obje

id
​integer

Cari hesap nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Cari hesap için düzenlenebilir kod değeri.

Example: cari-hesap-kod-ornegi
balance
​number · float

Cari hesap bakiyesi.

Example: 155.5
riskLimit
​number · float · min: 0

Cari hesap için risk limiti.

Example: 155.5
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 · maxLength: 50

Kur etiketi.

Example: Türk Lirası
buyingPrice
​number · float · min: 0

Kur alış fiyatı.

Example: 1
sellingPrice
​number · float · min: 0

Kur satış fiyatı.

Example: 1
abbr
​string · maxLength: 5

Kur kısaltması.

Example: TL
updatedAt
​string · date-time

Kurun güncellenme zamanı.

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

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

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

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 · writeOnly

Kurun efektif kur olarak kullanılıp kullanılmadığı. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Coupon

id
​integer

Hediye çeki nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string

Hediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.

Example: TESTKUPON123
maxUsage
​integer · writeOnly

Hediye çekinin toplam kullanım limiti.

Example: 100
currentUsage
​integer · writeOnly

Hediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.

Example: 10
maxUsagePerMember
​integer · writeOnly

Bir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.

Example: 5
memberGroupId
​integer · writeOnly
startDate
​string · date-time · writeOnly

Hediye çekinin geçerli olmaya başladığı tarih.

Example: 2015-04-16T00:00:00+03:00
expireDate
​string · date-time · writeOnly
minimumUsageLimit
​number · float · writeOnly
createdAt
​string · date-time · writeOnly

Hediye çekinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
createrType
​string · writeOnly
createrId
​integer · writeOnly
valueType
​boolean · writeOnly
valueEffect
​number · float · writeOnly
products
​string · writeOnly

Kuponun geçerli olduğu ürün nesneleri.

categories
​string · maxLength: 500 · writeOnly

Kuponun geçerli olduğu kategori nesneleri.

status
​boolean · writeOnly

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

Example: 1
cargoFree
​boolean · writeOnly

Kuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

useDiscountProducts
​integer · writeOnly
brands
​string · maxLength: 500 · writeOnly

Kuponun geçerli olduğu marka nesneleri.

members
​string · writeOnly

Kuponun geçerli olduğu üye nesneleri.

isEffectiveSpecialToken
​boolean · writeOnly
taxIncluded
​boolean · writeOnly
minimumUsageLimitTaxIncluded
​boolean · writeOnly
updatedAt
​string · date-time · writeOnly

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 · maxLength: 255

Ülkenin adı.

Example: Türkiye
code
​string · maxLength: 255

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
extraShippingPrice
​number · float · min: 0 · writeOnly
selectedLanguage
​string · maxLength: 255 · writeOnly
selectedCurrency
​string · maxLength: 255 · writeOnly
phoneCode
​integer · writeOnly

CombineProduct

Kombin ürün ilişki objesi
​ProductSummary · required

Ürün detay objesi

​ProductSummary · required

Ürün detay objesi

id
​integer

İlişki için benzersiz kimlik

Example: 123

Collection

name
​string · maxLength: 255 · required
id
​integer
slug
​string · maxLength: 65535 · writeOnly
status
​integer · enum · writeOnly
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999 · writeOnly
displayShowcaseContent
​integer · enum · writeOnly
Enum values:
0
1
2
showcaseContent
​string · maxLength: 65535 · writeOnly
showcaseContentDisplayType
​integer · writeOnly
displayShowcaseFooterContent
​integer · enum · writeOnly
Enum values:
0
1
2
showcaseFooterContent
​string · maxLength: 65535 · writeOnly
showcaseFooterContentDisplayType
​integer · enum · writeOnly
Enum values:
1
2
3
pageTitle
​string · writeOnly
metaKeywords
​string · maxLength: 65535 · writeOnly
metaDescription
​string · maxLength: 65535 · writeOnly
canonicalUrl
​string · maxLength: 255 · writeOnly
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

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

Kategoriye ait benzersiz kimlik numarası. Sistem tarafından otomatik oluşturulur.

Example: 123
name
​string · maxLength: 255

Kategori nesnesi için isim değeri.

Example: Kırtasiye
slug
​string · 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
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
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
distributor
​string · maxLength: 128

Her zaman null değer alır. Pratikte kullanımı yoktur.

Example:
displayShowcaseContent
​integer

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.

Example: 2
showcaseContent
​string · maxLength: 65535

Kategori nesnesinin üst içeriği. Admin paneli üzerinden düzenlenebilir.

Example: Üst içerik metni.
showcaseContentDisplayType
​integer

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.

Example: 2
displayShowcaseFooterContent
​integer

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.

showcaseFooterContent
​string · maxLength: 65535

Kategori nesnesinin alt içeriği. Admin paneli üzerinden düzenlenebilir.

showcaseFooterContentDisplayType
​integer

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.

hasChildren
​integer · enum

Kategorinin alt kategorilere sahip olup olmadığını belirtir. Seçenekler: | 0: Var | 1: Yok

Enum values:
0
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: 255

İ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
pageTitle
​string · maxLength: 65535

Sayfanın arama motorları tarafından tespit edilebilecek başlık yazısı.

Example: Kırtasiye Ürünleri
leftIndex
​integer · writeOnly
level
​integer · writeOnly
rightIndex
​integer · writeOnly
root
​integer · writeOnly

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

attachment
​string · writeOnly

attachment

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
createdAt
​string · date-time

Kategorinin oluşturulma zamanı (ISO 8601 formatında).

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

Kategorinin son güncellenme zamanı (ISO 8601 formatında).

Example: 2022-05-10T09:15:27+03:00
targetKeyword
​string · maxLength: 255

CartItemSubscription

Sepet kalemi abonelik bilgisi objesi
id
​integer

Abonelik için benzersiz kimlik

Example: 123
chosenPeriod
​integer

Seçilen abonelik periyodu

chosenDispatchCount
​integer

Seçilen gönderim sayısı

Example: 12
​SubscriptionSummary
​CartItemSummary

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
parentProductId
​integer · min: 0
categoryId
​integer · min: 0
isDigitalProduct
​boolean · enum
Enum values:
0
1
createdAt
​string · date-time

Sepet kaleminin oluşturulma zamanı.

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

Sepet kaleminin son güncellenme zamanı.

Example: 2018-02-21T15:01:03+0300
​object · writeOnly

Sepet kalemi abonelik bilgisi objesi

Cart

id
​integer

Sepet kimlik değeri

Example: 1
sessionId
​string · maxLength: 255

Sepet oturum kimliği

Example: v7ztzjyow1wgsg4wc4csg0w4oc4o8skok4c0sg800cgwcgo8o28qc2rxchf
locked
​integer · enum
Enum values:
0
1
lockedAt
​string · date-time
createdAt
​string · date-time
updatedAt
​string · date-time
​PromotionSummary
​MemberSummary

Üye hesap bilgilerini içeren obje

​CouponSummary

Sepet kalemi nesnelerini barındıran liste.

Brand

Marka objesi
name
​string · maxLength: 255 · required

Marka adı

Example: Idea Kalem
id
​integer

Marka için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255
sortOrder
​integer · min: 1 · max: 999

Görüntüleme sırası

Example: 999
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
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 · maxLength: 65535

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 · maxLength: 65535
displayShowcaseFooterContent
​integer
metaKeywords
​string · maxLength: 65535

SEO meta anahtar kelimeler

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

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
canonicalUrl
​string · maxLength: 255 · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded logo verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
isSearchable
​integer · enum
Enum values:
0
1
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
targetKeyword
​string · maxLength: 255

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 · required

Müşterinin ülke bilgisi.

Example: Türkiye
location
​string · maxLength: 128 · required

Müşterinin şehir bilgisi.

Example: İstanbul
address
​string · maxLength: 65535 · required

Müşterinin adres bilgisi.

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · maxLength: 32 · required

Müşterinin mobil telefon numarası.

Example: +90 (555) 555 55 55
id
​integer

Fatura adresi nesnesi kimlik değeri.

Example: 123
subLocation
​string · maxLength: 128

Müşterinin ilçe bilgisi.

Example: Üsküdar
phoneNumber
​string · maxLength: 32

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly
invoiceType
​string · enum

Fatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.

Enum values:
individual
corporate
Example: individual
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

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

TownGroupSummary

name
​string · maxLength: 255 · required

İlçe grubu nesnesinin adı.

Example: Standart İlçeler
id
​integer

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

Example: 123
status
​boolean · maxLength: 255

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

Example: true

TownSummary

İlçe nesnesi
name
​string · maxLength: 255 · required

İlçe adı.

Example: Üsküdar
id
​integer

İlçe nesnesine ait benzersiz kimlik numarası.

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

İ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

SEO+ etiketi nesnesine ait benzersiz kimlik numarası

Example: 123
name
​string · maxLength: 255

SEO+ etiketi nesnesi adı.

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

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

Example: 2
pageTitle
​string · maxLength: 65535

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

Example: Kırmızı Kalem
metaDescription
​string · maxLength: 65535

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

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

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

SubscriptionSummary

id
​integer

Abonelik nesnesi kimlik değeri

periods
​string

Abonelik periyodu

periodFrequency
​string

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

dispatchCounts
​string

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

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

name
​string

Abonelik nesnesi adı

description
​string

Açıklama

status
​string

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

discount
​integer

İndirim

shippingAmount
​number · float

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

name
​string · maxLength: 255 · required

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

Example: Kırmızı
id
​integer

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

Example: 101
slug
​string · maxLength: 255

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

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

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

Example: 1
logo
​string · enum

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

Enum values:
jpg
png
gif
jpeg
webp
avif
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
attachment
​string · writeOnly

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

size
​integer · writeOnly

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

​object

SpecGroup nesnesi (özet). Tüm alanlar için SpecGroup şemasına bakın.

​object

SpecName nesnesi (özet). Tüm alanlar için SpecName ş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
name
​string · maxLength: 255 · required

Ürün özelliği adı.

Example: Kapasite
id
​integer

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

Example: 123
slug
​string · maxLength: 255

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

Example: kapasite
choiceType
​string · enum · maxLength: 255

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

SpecGroupSummary

Ürün özellik grubu objesi
name
​string · maxLength: 255 · required

Özellik grubu adı

Example: Cep Telefonları
id
​integer

Özellik grubu için benzersiz kimlik

Example: 123
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

ShippingProviderSummary

Kargo sağlayıcısı nesnesi
code
​string · maxLength: 64 · required

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

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

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

Example: Idea Cargo
id
​integer

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

Example: 123
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}
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

ShippingCompanySummary

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder.
name
​string · maxLength: 128 · required

Kargo firması nesnesi adı.

Example: Idea Cargo
id
​integer

Kargo firması nesnesine ait benzersiz kimlik numarası.

Example: 123
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

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

Example: 999
companyCode
​string · maxLength: 255

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

Example: CMP12KD
paymentType
​string · enum

Kargo ödemesinin tipini belirtir.

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
​object

ShippingProvider nesnesi (özet). Tüm alanlar için ShippingProvider şemasına bakın.

​object[]
createdAt
​string · date-time · writeOnly

Kargo firması nesnesinin oluşturulma zamanı.

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

Kargo firması nesnesinin son güncellenme zamanı.

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

ShippingAddressSummary

Teslimat adresi objesi
firstname
​string · maxLength: 255 · required

Alıcı adı

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

Alıcı soyadı

Example: Yılmaz
country
​string · maxLength: 128 · required

Ülke adı

Example: Türkiye
location
​string · maxLength: 128 · required

Şehir adı

Example: İstanbul
address
​string · maxLength: 65535 · required

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · maxLength: 32 · required

Cep telefonu numarası

Example: +90 (555) 555 55 55
id
​integer

Adres için benzersiz kimlik

Example: 123
subLocation
​string · maxLength: 128

İlçe adı

Example: Üsküdar
phoneNumber
​string · maxLength: 32

Sabit telefon numarası

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly
​object

Orders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.

ShipmentSummary

id
​integer

Teslimat nesnesi kimlik değeri.

Example: 123
barcode
​string · maxLength: 255

Teslimat barkodu.

Example: 12345678ASD
waybillNo
​string · maxLength: 255

Teslimat fatura numarası.

Example: A-1002
invoiceKey
​string · maxLength: 255

Teslimat irsaliye makbuzu numarası.

Example: A-1231
cargoOffice
​string · maxLength: 255

Teslimatın kargo şubesi

Example: Üsküdar
code
​string · maxLength: 255

Teslimat kodu. Kargo takip kodu.

Example: KOD123456
deliveryType
​string · maxLength: 255

Teslimat tipi

Example: deliveryType
invoiceIncluded
​integer · enum

Faturanın pakete dahillik durumunu belirtir.

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

Kapıda ödeme hizmeti bedeli.

Example: 5
createdAt
​string · date-time

Teslimat nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
status
​integer · enum

Teslimat nesnesinin aktiflik durumunu belirten değer.

Enum values:
0
1
-1
Example: 1
​object

Orders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.

barcodeImage
​string

Barkod resmi.

trackingUrl
​string · maxLength: 255

Takip linki.

SelectionGroupSummary

title
​string · maxLength: 255 · required

Ek özellik grubu ismi.

Example: Renk Seçenekleri
sortOrder
​integer · required

Ek özellik grubu sırası.

Example: 1
id
​integer

Ek özellik grubu nesnesi kimlik değeri.

Example: 123

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
sortOrder
​integer · required

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

Example: 1
id
​integer

Ek özellik nesnesinin benzersiz kimlik değeri.

Example: 123
​object

SelectionGroup nesnesi (özet). Tüm alanlar için SelectionGroup şemasına bakın.

RegionSummary

name
​string · maxLength: 255 · required

Teslimat bölgesi ismi.

Example: Marmara
id
​integer

Teslimat bölgesi kimlik değeri.

Example: 1
​object[]
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

PurchaseLimitationSummary

name
​string · required

Satın alma limiti nesnesine ait isim.

type
​string · enum · required

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
id
​integer

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

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.

status
​boolean · enum

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

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

Satın alma limiti nesnesinin oluşturulma tarihi.

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

Satın alma limiti nesnesinin güncellenme tarihi.

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

PromotionToCategorySummary

​object · required

Promotion nesnesi (özet). Tüm alanlar için Promotion şemasına bakın.

​object · required

Category nesnesi (özet). Tüm alanlar için Category şemasına bakın.

id
​integer

PromotionToBrandSummary

​object · required

Promotion nesnesi (özet). Tüm alanlar için Promotion şemasına bakın.

​object · required

Brand nesnesi (özet). Tüm alanlar için Brand şemasına bakın.

id
​integer

PromotionPriceRangeSummary

Promosyon fiyat aralığı objesi (basamaklı indirim)
id
​integer
​object

Promotion nesnesi (özet). Tüm alanlar için Promotion şemasına bakın.

fromQty
​integer

Başlangıç adeti

toQty
​integer

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

discountAmount
​integer

İndirim miktarı (₺ veya %)

status
​boolean
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

name
​string · required

Promosyon adı.

Example: Sepette %20 İndirim
id
​integer

Promosyon nesnesi kimlik değeri.

startDate
​string · date-time · writeOnly

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time · writeOnly
useDateFilter
​integer · enum · writeOnly

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

Enum values:
0
1
Example: 1
usageLimit
​integer · writeOnly
timesUsed
​integer · writeOnly
conditions
​string · writeOnly
freeShipping
​integer · enum · writeOnly

Ücretsiz kargo durumu.

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

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

Enum values:
0
1
Example: 0
minimumCheckoutLimit
​number · float · writeOnly

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

Example: 200
baseCategoryId
​integer · writeOnly
baseCategoryTree
​string · writeOnly
baseBrandId
​integer · writeOnly
baseProducts
​string · writeOnly
promotionValidityControl
​string · enum · writeOnly

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
minimumPurchaseQuantity
​integer · writeOnly
membersId
​string · writeOnly
memberGroupId
​integer · writeOnly
description
​string · writeOnly

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255 · writeOnly
urlBlankStatus
​boolean · writeOnly
imageFile
​string · maxLength: 255 · writeOnly
attachment
​string · writeOnly
promotionFeatureType
​string · enum · writeOnly

Promosyon özelliği tipi.

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

Promosyon özelliğine ait promosyon miktarı.

Example: 20
promotionalProducts
​string · writeOnly

Promosyonlu ürün nesnesi listesi

promotionalProductQuantity
​integer · writeOnly

Promosyonlu ürün miktarı.

Example: 1
useLabel
​boolean · writeOnly
status
​integer · enum · writeOnly

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​boolean · writeOnly
sortOrder
​integer · min: 1 · max: 999999 · writeOnly
createdAt
​string · date-time · writeOnly

Promosyon nesnesinin oluşturulma zamanı.

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

Promosyon nesnesinin güncellenme zamanı.

Example: 2018-02-21T15:01:03+03:00
​object[]
​object[]
​object[]

ProductToCountDownSummary

useCountDown
​integer · enum · required

Geri sayımın aktiflik durumu bilgisini belirtir. ( 0=Pasif, 1=Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 0
id
​integer

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

Example: 123
startDate
​string · date-time

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

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

Geri sayımın bitiş tarihi.

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

Geri sayımın ürün için geçersiz olma tarihi.

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

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

ProductToCollectionSummary

​object · required

Collection nesnesi (özet). Tüm alanlar için Collection şemasına bakın.

id
​integer
sortOrder
​integer · max: 500
​object

Ürün detay objesi — product nesnesi (özet). Tüm alanlar için product şemasına bakın.

ProductToCategorySummary

​object · required

Category nesnesi (özet). Tüm alanlar için Category şemasına bakın.

id
​integer

Ürün kategori bağı nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
sortOrder
​integer · max: 500

Ürün kategori bağının sıralama değeri. Bu değer, ürünün kategori içindeki görüntülenme sırasını belirler. Eğer vitrin sırası belirlenmek istenmiyorsa null atanabilir.

Example: 1
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

ProductPriceSummary

Ürün fiyatlandırma bilgilerini içeren obje
value
​number · float · min: 0 · required

Ürünün fiyat değeri

Example: 10.99
type
​integer · enum · min: 2 · max: 5 · required

Fiyat tipi (alternatif fiyat seçenekleri)

Enum values:
2
3
4
5
6
Example: 2
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
filename
​string · maxLength: 255 · pattern: ^[a-z0-9-]+$ · required

Dosya adı (uzantısız)

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

Dosya uzantısı

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

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

Example: 1
id
​integer

Görsel için benzersiz kimlik

Example: 123
directoryName
​string · maxLength: 10
revision
​string · maxLength: 30
​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

attachment
​string · pattern: ^data:image\/(jpeg|j…

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

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
alt
​string · maxLength: 150

ProductExtraFieldSummary

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

Ürün detay objesi — 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.

ProductCommentImageSummary

filename
​string · maxLength: 255 · required
extension
​string · enum · required
Enum values:
jpg
png
jpeg
id
​integer
directoryName
​string · maxLength: 10
​object

productComment nesnesi (özet). Tüm alanlar için productComment şemasına bakın.

attachment
​string · writeOnly

ProductSummary

Ürün detay objesi
id
​integer

Ürün için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Ürün adı

Example: Kalem
slug
​string · maxLength: 65535 · pattern: ^[a-z0-9-]+$

URL dostu benzersiz tanımlayıcı

Example: kalem
fullName
​string · maxLength: 65535

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

Example: Kalem Kırmızı
sku
​string · maxLength: 255

Stok kodu (benzersiz)

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

Ürün barkodu

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

Ana satış fiyatı (Fiyat 1)

Example: 10.99
warranty
​integer · min: 0

Garanti süresi (ay)

Example: 24
tax
​integer · decimal · min: 0

KDV oranı (%)

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

Mevcut stok miktarı

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

Desi (hacimsel ağırlık)

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

Alış fiyatı

Example: 5.5
stockTypeLabel
​string · enum · maxLength: 255

Stok birim tipi

Enum values:
Piece
cm
Dozen
gram
kg
Person
Package
metre
Example: Piece
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
status
​integer · enum

Ürün aktiflik durumu

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

Fiyatlara KDV dahil mi?

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

Tedarikçi adı

Example: superTedarik
isGifted
​integer · enum
Enum values:
0
1
gift
​string · maxLength: 255

Hediye açıklaması

Example: Silgi hediyeli
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
marketPriceDetail
​string · maxLength: 255

Piyasa fiyatı açıklaması

Example: Diğer mağazalarda 15 TL
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
midblockSortOrder
​integer | null · writeOnly

Vitrin blokları sırası

Example: 1
metaKeywords
​string · maxLength: 65535

SEO meta anahtar kelimeler

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

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri.
pageTitle
​string · maxLength: 65535

SEO sayfa başlığı

Example: Kırmızı Kalem
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
​object

Brand nesnesi (özet). Tüm alanlar için Brand şemasına bakın.

​object

Vitrin bloğu objesi — midblock nesnesi (özet). Tüm alanlar için midblock şemasına bakın.

​object

Currency nesnesi (özet). Tüm alanlar için Currency şemasına bakın.

​

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

​object

ProductToCountDown nesnesi (özet). Tüm alanlar için ProductToCountDown şemasına bakın.

​object[]
​object[]
​object[]
​object[]
​object[]
​object[]
​object

DigitalProduct nesnesi (özet). Tüm alanlar için DigitalProduct şemasına bakın.

targetKeyword
​string · maxLength: 255

PaymentTypeSummary

name
​string · maxLength: 255 · required

Ödeme tipinin adı.

Example: Havale
id
​integer

Ödeme tipi nesnesi kimlik değeri.

Example: 123
sortOrder
​integer · min: 0 · writeOnly

Ödeme tipinin sıralama değeri.

PaymentProviderSettingSummary

Ödeme sağlayıcısına ait yapılandırma ayarlarını temsil eder.
varKey
​string · maxLength: 255 · required

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

Example: agentId
varValue
​string · required

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

Example: PALIKJXZQ
id
​integer

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

Example: 123
​object

paymentProvider nesnesi (özet). Tüm alanlar için paymentProvider şemasına bakın.

PaymentProviderSummary

id
​integer

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

Example: 123
code
​string · maxLength: 255

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

Example: MoneyOrder
name
​string · maxLength: 255

Ö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

PaymentType nesnesi (özet). Tüm alanlar için PaymentType şemasına bakın.

​object[]
​object[]

PaymentGatewaySettingSummary

varKey
​string · maxLength: 255 · required
varValue
​string · maxLength: 255 · 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

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
id
​integer

Ödeme kanalı nesnesinin benzersiz kimlik değeri.

Example: 123
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
sortOrder
​integer · min: 0

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

Example: 999
createdAt
​string · date-time · writeOnly

Ödeme kanalı nesnesinin oluşturulma zamanı.

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

Ödeme kanalı nesnesinin güncellenme zamanı.

Example: 2022-04-20T14:33:45+03:00
legacyTableName
​string · maxLength: 512 · writeOnly
legacyTableId
​integer · min: 1 · writeOnly
​object

PaymentProvider nesnesi (özet). Tüm alanlar için PaymentProvider şemasına bakın.

​object[]

PaymentBddkCategorySummary

​object · required

PaymentProvider nesnesi (özet). Tüm alanlar için PaymentProvider şemasına bakın.

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

OrdersSummary

id
​integer

Siparişe ait benzersiz kimlik (ID) değeridir.

Example: 123
customerFirstname
​string · maxLength: 255

Müşterinin adı.

Example: John
customerSurname
​string · maxLength: 255

Müşterinin soyadı.

Example: Doe
customerEmail
​string · maxLength: 255

Müşterinin e-mail adresi.

Example: johndoe@ideasoft.com.tr
customerPhone
​string · maxLength: 32

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
paymentTypeName
​string · maxLength: 128

Siparişin ödeme tipi.

Example: Havale
paymentProviderCode
​string · maxLength: 128

Siparişin ödeme altyapısı sağlayıcısının sistemdeki kod değeri. Ön tanımlıdır. API otomatik oluşturur.

Example: MoneyOrder
paymentProviderName
​string · maxLength: 128

Siparişin ödeme altyapısı sağlayıcısının adı. Ön tanımlıdır. API otomatik oluşturur.

Example: Havale
paymentGatewayCode
​string · maxLength: 255

Siparişin ödeme kanalının kodu. Ön tanımlıdır. API otomatik oluşturur.

Example: ideabank_1
paymentGatewayName
​string · maxLength: 255

Siparişin ödeme kanalının adı. Ön tanımlıdır. API otomatik oluşturur.

Example: IdeaBank
bankName
​string · maxLength: 128

Sipariş sırasında seçilen veya kullanılan banka adı. Ön tanımlıdır. API otomatik oluşturur.

Example: IdeaBank
cardHolderName
​string · maxLength: 255 · writeOnly
clientIp
​string · maxLength: 40

Siparişi oluşturan müşterinin IP adresi.

Example: 192.168.1.1
userAgent
​string · maxLength: 1024

Siparişin oluşturulduğu cihaz/tarayıcı 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 · maxLength: 32

Siparişte kullanılan kur(para birimi) kodu.

Example: TL
currencyRates
​string · maxLength: 65535

İlgili para birimleri ve alış/satış oranlarını içeren nesne, kur oranları.

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

Siparişin vergi hariç ara toplam tutarı.

Example: 1.69492
couponDiscount
​number · float · min: 0

Siparişte kullanılan hediye çeki indirimi tutarı.

Example: 0
taxAmount
​number · float · min: 0

Siparişin için hesaplanan toplam vergi tutarı.

Example: 0.30508
promotionDiscount
​number · float · min: 0

Siparişte kullanılan promosyon indirimi tutarı.

Example: 0
generalAmount
​number · float · min: 0

Siparişin genel toplam fiyat tutarı. orderAmount, couponDiscount, taxAmount, promotionDiscount, shippingAmount, additionalServiceAmount tutarlarının toplamı.

Example: 2
shippingAmount
​number · float · min: 0

Sipariş için tahsil edilen kargo/teslimat ücreti.

Example: 5
additionalServiceAmount
​number · float

Siparişe ait ek hizmet ücretlerinin toplamı.

Example: 0
finalAmount
​number · float · min: 0

Siparişin son ödeme tutarı. (generalAmount üzerine taksit/vade farkı eklendiyse dahil edilmiş hali).

Example: 2
sumOfGainedPoints
​number · float · min: 0

Siparişten müşterinin kazanacağı toplam puan miktarı.

Example: 200
installment
​integer · min: 0 · max: 18

Sipariş için seçilen taksit sayısı.

Example: 0
installmentRate
​number · float

Siparişin taksit oranı.

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

Sipariş için seçilen ek taksit sayısı.

Example: 0
transactionId
​string · maxLength: 255

Sipariş numarası.

Example: c88728ce28151
hasUserNote
​integer · enum

Siparişin müşteri notu içerip içermediğini belirtir. (0 = Yok, 1 = Var) Seçenekler: | 0: Sipariş müşteri notuna sahip değil. | 1: Sipariş müşteri notuna sahip.

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

Siparişin genel durumu. Seçenekler: | deleted: Silindi | waiting_for_approval: Onay Bekliyor | approved: Onaylandı | fulfilled: Kargoya Verildi | cancelled: İptal Edildi | delivered: Teslim Edildi | on_accumulation: Tedarik Sürecinde | waiting_for_payment: Ödeme Bekleniyor | being_prepared: Hazırlanıyor | refunded: İade Edildi | personal_status_1: Kişisel Sipariş Durumu 1 | personal_status_2: Kişisel Sipariş Durumu 2 | personal_status_3: Kişisel Sipariş Durumu 3

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: waiting_for_approval
paymentStatus
​string · enum

Ödeme işleminin sonucu/durumu. Seçenekler: | in_transaction: Sonuçlanmamış Ödemeler | failed: Hatalı Ödemeler | success: Başarılı

Enum values:
in_transaction
failed
success
Example: success
errorMessage
​string · maxLength: 65535

Sipariş ile ilgili hata mesajı (varsa).

Example: Limit yetersiz.
sessionId
​string · maxLength: 255 · writeOnly
deviceType
​string · enum

Siparişin gerçekleştiği cihaz bilgisi. Seçenekler: | desktop: Masaüstü | mobile: Mobil | tablet: Tablet

Enum values:
desktop
mobile
tablet
unknown
Example: desktop
referrer
​string · maxLength: 65535

Siparişe yönlendiren web sitesinin tam URL bilgisi. API otomatik oluşturur.

Example: https://www.referrer.com
invoicePrintCount
​integer · min: 0

Sipariş için alınan fatura çıktısı adedi.

Example: 1
useGiftPackage
​integer · enum

Hediye paketi talebi durumu. (0 = İstemiyorum, 1 = İstiyorum) Seçenekler: | 0: Hediye paketi istemiyorum | 1: Hediye paketi istiyorum

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

Müşterinin bıraktığı hediye notu (varsa).

Example: Doğum günün kutlu olsun.
giftAmount
​number · float · min: 0
memberGroupName
​string · maxLength: 255

Sipariş veren müşterinin üye grubunun adı.

Example: Üyeliksiz alışveriş
usePromotion
​integer · enum

Siparişte promosyon kullanılıp kullanılmadığını belirtir. (0 = Hayır, 1 = Evet) Seçenekler: | 0: Promosyon kullanma | 1: Promosyon kullan

Enum values:
0
1
Example: 0
shippingProviderCode
​string · maxLength: 128

Siparişin teslimat hizmeti sağlayıcısının kodu. Ön tanımlıdır. API otomatik oluşturur.

Example: idea
shippingProviderName
​string · maxLength: 128

Siparişin teslimat hizmeti sağlayıcısının adı. Ön tanımlıdır.

Example: Idea Cargo
shippingCompanyName
​string · maxLength: 128

Siparişin kargo firmasının adı. Ön tanımlıdır.

Example: Idea Cargo
shippingPaymentType
​string · enum

Siparişin kargo ödemesinin tipi. Seçenekler: | cash_on_delivery: Alıcı Ödemeli | standart_delivery: Gönderici Ödemeli | not_applicable: Bu alan için geçerli değil.

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

Siparişin kargo takip kodu.

Example: 123123IDEA
nebimTransferStatus
​integer · enum · writeOnly
Enum values:
0
1
paidFromCurrentAccount
​integer · enum
Enum values:
0
1
source
​string · maxLength: 255

Siparişin geldiği kaynak bilgisi. Siparişin kaynak yazılımını belirtir.

Example: IdeaShop Payment
createdAt
​string · date-time

Sipariş kaydının oluşturulma tarihi.

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

Sipariş kaydının güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
orderDay
​string · date-time · writeOnly
​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

paymentGateway nesnesi (özet). Tüm alanlar için paymentGateway şemasına bakın.

​object

paymentProvider nesnesi (özet). Tüm alanlar için paymentProvider şemasına bakın.

​object

paymentType nesnesi (özet). Tüm alanlar için paymentType şemasına bakın.

​object

promotion nesnesi (özet). Tüm alanlar için promotion şemasına bakın.

​object

Kargo firması bilgilerini ve gönderim ayarlarını temsil eder. — shippingCompany nesnesi (özet). Tüm alanlar için shippingCompany şemasına bakın.

​object

Kargo sağlayıcısı nesnesi — shippingProvider nesnesi (özet). Tüm alanlar için shippingProvider şemasına bakın.

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

autoPayback
​boolean · enum · writeOnly
Enum values:
0
1

OrderRefundRequestSummary

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
status
​string · enum

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
fee
​number · float · min: 0

Müşteriye ödenecek tutar bilgisi.

Example: 15
shippingFee
​number · float · min: 0

Kargo tutarı.

autoPayback
​integer · enum

Otomatik geri ödeme durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
cancellationReason
​string · maxLength: 512

Sipariş iptal talebinin sebebine dair detaylı açıklama.

Example: Ürün kusurlu.
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
​object

Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.

​object

Orders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.

OrderItemSubscriptionSummary

Sipariş kalemi ile ilişkili abonelik bilgilerini temsil eder.
id
​integer

Sipariş kalemi aboneliğine ait benzersiz kimlik numarası.

Example: 123
chosenPeriod
​integer · writeOnly
chosenDispatchCount
​integer · writeOnly
​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.

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

Ö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

Alan tipi

Enum values:
text
textarea
file
dropdown
radio
checkbox
Example: text
productCustomizationFieldName
​string

Alan adı

Example: Sertifika Düzenlenen Kişi
productCustomizationFieldSortOrder
​integer · writeOnly
productCustomizationFieldValue
​string

Müşterinin girdiği değer

Example: Ahmet Yılmaz
cartItemAttributeId
​integer

İlişkili sepet kalemi özellik kimliği

Example: 789
isCloudFile
​boolean · writeOnly

Dosyanın bulut depolama kullanıp kullanmadığı

cloudContentUrl
​string · uri · writeOnly

Bulut depolama dosya URL'i

Example: https://cdn.example.com/file.pdf
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly
​object

orderItem nesnesi (özet). Tüm alanlar için orderItem şemasına bakın.

OrderItemSummary

id
​integer

Sipariş kaleminin benzersiz kimlik (ID) değeri.

Example: 123
productName
​string · maxLength: 255

Siparişteki ürünün adı.

Example: Kalem
productSku
​string · maxLength: 255

Ürünün stok kodu (SKU).

Example: KAL-1234
productBarcode
​string · maxLength: 255

Ürünün barkod numarası.

Example: 869456789874
productPrice
​number · float · min: 0

Ürünün birim fiyatı.

Example: 15
productCurrency
​string · maxLength: 32

Ü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

Siparişteki ürün adedi (stok tipi cinsinden).

Example: 1
productTax
​integer · min: 0

Ürünün vergi oranı (yüzde cinsinden).

Example: 18
productDiscount
​number · float

Ürüne uygulanan standart indirim miktarı.

Example: 5
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
maxInstallment
​integer · writeOnly
priceRatio
​number · float · min: 0 · max: 5
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly
​object

Orders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.

​object

Product nesnesi (özet). Tüm alanlar için Product şemasına bakın.

​object

DigitalProduct nesnesi (özet). Tüm alanlar için DigitalProduct ş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

Orders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.

OptionsSummary

Varyant seçenek objesi (renk değeri, beden değeri vb.)
title
​string · maxLength: 255 · required

Varyant değeri adı (Kırmızı, L, 42 vb.)

Example: Kırmızı
id
​integer

Varyant seçeneği için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255
sortOrder
​integer · min: 1 · max: 9999

Görüntüleme sırası

Example: 999
logo
​string · enum · pattern: ^[a-zA-Z0-9-_]+\.(jp…

Varyant görseli dosya adı (uzantı ile birlikte)

Enum values:
jpg
png
gif
jpeg
webp
avif
Example: kirmizi-logo.jpg
​object

OptionGroup nesnesi (özet). Tüm alanlar için OptionGroup şemasına bakın.

attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded görsel verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
size
​integer · writeOnly
updatedAt
​string · date-time
createdAt
​string · date-time

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

MemberGroupSummary

name
​string · maxLength: 255 · required

Üye grubu ismi

Example: Üyeler
id
​integer

Üye grubu nesnesinin kimlik değeri

Example: 123
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
allowedPaymentGateways
​string · maxLength: 512

MemberDetailSummary

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

Üye hesap bilgilerini içeren obje — member nesnesi (özet). Tüm alanlar için member şemasına bakın.

createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

MemberAddressSummary

Üye adresi objesi
id
​integer

Adres için benzersiz kimlik

Example: 123
name
​string

Adres tanımlayıcı adı

Example: Ev
type
​string · enum

Adres tipi

Enum values:
shipping
billing
Example: shipping
firstname
​string

Adı

Example: Ahmet
surname
​string

Soyadı

Example: Yılmaz
address
​string

Detaylı adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
locationName
​string · writeOnly

Şehir adı

Example: İstanbul
subLocationName
​string

İlçe adı

Example: Üsküdar
phoneNumber
​string

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string

Cep telefonu numarası

Example: +90 (555) 555 55 55
tcId
​string · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
taxNumber
​string · pattern: ^[0-9]{10}$

Vergi numarası (kurumsal faturalar için)

Example: 1966712049
taxOffice
​string

Vergi dairesi (kurumsal faturalar için)

Example: Üsküdar
invoiceType
​string · enum

Fatura tipi

Enum values:
individual
corporate
Example: individual
isEinvoiceUser
​boolean

E-fatura kullanıcısı mı?

Example: true
zipCode
​string · maxLength: 64
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

Ü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 · maxLength: 255

Üyenin e-posta adresi

Example: ahmet.yilmaz@example.com
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: 255

Sabit telefon numarası

Example: +90 (216) 326 04 77
mobilePhoneNumber
​string · maxLength: 255

Cep telefonu numarası

Example: +90 (555) 555 55 55
otherLocation
​string · maxLength: 255

Alternatif şehir bilgisi

Example: Diğer şehir
address
​string · maxLength: 65535

Adres bilgisi

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
taxNumber
​string · minLength: 10 · maxLength: 255

Vergi numarası

Example: 1966712049
tcId
​string · maxLength: 11 · pattern: ^[0-9]{11}$

TC kimlik numarası

Example: 11111111111
password
​string · password · maxLength: 255 · writeOnly

Üye hesap şifresi (şifrelenmiş)

activationCode
​string · maxLength: 255 · writeOnly
status
​string · enum

Üye hesap durumu

Enum values:
queue
active
passive
suspended
Example: active
lastLoginDate
​string · date-time

Son giriş yapılan tarih ve 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
zipCode
​string · maxLength: 50

Posta kodu

Example: 34704
commercialName
​string · maxLength: 255

Kurumsal üyelik için şirket adı

Example: Ideasoft Yazılım San. ve Tic. A.Ş.
taxOffice
​string · maxLength: 255

Vergi dairesi

Example: Üsküdar
lastMailSentDate
​string · date-time

Son e-posta gönderim tarihi

lastIp
​string · ipv4 · maxLength: 255

Son giriş yapılan IP adresi

Example: 192.168.1.1
gainedPointAmount
​number · float · min: 0
spentPointAmount
​number · float · min: 0
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
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ı

referredMemberGainedPointAmount
​number · float · min: 0
district
​string · maxLength: 255

İlçe bilgisi

Example: Üsküdar
deviceType
​string · enum · maxLength: 255

Üyelik oluştururken kullanılan cihaz tipi

Enum values:
bilgisayar
mobil
Example: mobil
deviceInfo
​string · maxLength: 65535

Detaylı cihaz bilgisi (user agent)

​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 · writeOnly

Şehir adı

​object

MemberGroup nesnesi (özet). Tüm alanlar için MemberGroup şemasına bakın.

​object

Member nesnesi (özet). Tüm alanlar için Member şemasına bakın.

kvkkStatus
​integer · enum

KVKK (kişisel verilerin korunması) onay durumu

Enum values:
0
1
Example: 1
kvkkConfirmationDate
​string · date-time
confirmationToken
​string · writeOnly
confirmationTokenExpirationDate
​string · date-time · writeOnly
​object[]

MaillistGroupSummary

name
​string · maxLength: 255 · required

Mail listesi grubunun adı.

id
​integer

Mail listesi grubunun benzersiz kimlik değeri.

MaillistSummary

name
​string · maxLength: 255 · required

Mail listesi nesnesinin adı.

Example: Mail listesi 1
email
​string · maxLength: 255 · required

Mail adresi.

Example: mail@example.com
​object · required

MaillistGroup nesnesi (özet). Tüm alanlar için MaillistGroup şemasına bakın.

id
​integer

Mail listesi nesnesinin benzersiz kimlik değeri.

Example: 123
lastMailSentDate
​string · date-time

Son gönderim tarihi.

Example: 2022-04-18T09:15:30+03:00
creatorIpAddress
​string · maxLength: 64

Mail listesini oluşturan kullanıcının IP adresi.

Example: 10.10.10.1
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

Şehir nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 255

Ş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
predefined
​integer · enum
Enum values:
0
1
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly
​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

Kişisel etiket nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · maxLength: 255

Kişisel etiket Adı

sortOrder
​integer · min: 0 · max: 999

Kişisel etiket nesnesi için sıralama değeri.

Example: 10
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
slug
​string · maxLength: 65535

Etiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.

Example: indirimli-urunler
metaTitle
​string · maxLength: 255
metaKeywords
​string · maxLength: 255

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 255
status
​integer · enum

Etiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.

Enum values:
0
1
Example: 1
root
​integer · writeOnly
level
​integer · writeOnly
leftIndex
​integer · writeOnly
rightIndex
​integer · writeOnly
​object

Label nesnesi (özet). Tüm alanlar için Label şemasına bakın.

createdAt
​string · date-time

Kişisel etiket nesnesinin oluşturulma zamanı.

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

Kişisel etiket nesnesinin son güncellenme zamanı.

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

ExtraInfoSummary

Ek bilgi alanı tanımı objesi
id
​integer

Ek bilgi için benzersiz kimlik

Example: 78
name
​string · maxLength: 255

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

DistributorSummary

Tedarikçi bilgileri objesi
name
​string · maxLength: 150 · required

Tedarikçi şirket adı

Example: ABC Tedarik Ltd. Şti.
id
​integer

Tedarikçi için benzersiz kimlik

Example: 501
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
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

DigitalProductSummary

id
​integer
​object

Ürün detay objesi — product nesnesi (özet). Tüm alanlar için product şemasına bakın.

deletedAt
​string · date-time · writeOnly

CurrencySummary

id
​integer · required

Kur kimlik değeri.

Example: 123
label
​string · maxLength: 50

Kur etiketi.

Example: Türk Lirası
buyingPrice
​number · float · min: 0

Kur alış fiyatı.

Example: 1
sellingPrice
​number · float · min: 0

Kur satış fiyatı.

Example: 1
abbr
​string · maxLength: 5

Kur kısaltması.

Example: TL
updatedAt
​string · date-time

Kurun güncellenme zamanı.

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

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

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

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 · writeOnly

Kurun efektif kur olarak kullanılıp kullanılmadığı. Seçenekler: | 0: Pasif. | 1: Aktif.

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

CouponSummary

id
​integer

Hediye çeki nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string

Hediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.

Example: TESTKUPON123
maxUsage
​integer · writeOnly

Hediye çekinin toplam kullanım limiti.

Example: 100
currentUsage
​integer · writeOnly

Hediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.

Example: 10
maxUsagePerMember
​integer · writeOnly

Bir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.

Example: 5
memberGroupId
​integer · writeOnly
startDate
​string · date-time · writeOnly

Hediye çekinin geçerli olmaya başladığı tarih.

Example: 2015-04-16T00:00:00+03:00
expireDate
​string · date-time · writeOnly
minimumUsageLimit
​number · float · writeOnly
createdAt
​string · date-time · writeOnly

Hediye çekinin oluşturulma zamanı.

Example: 2022-04-20T14:33:45+03:00
createrType
​string · writeOnly
createrId
​integer · writeOnly
valueType
​boolean · writeOnly
valueEffect
​number · float · writeOnly
products
​string · writeOnly

Kuponun geçerli olduğu ürün nesneleri.

categories
​string · maxLength: 500 · writeOnly

Kuponun geçerli olduğu kategori nesneleri.

status
​boolean · writeOnly

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

Example: 1
cargoFree
​boolean · writeOnly

Kuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

useDiscountProducts
​integer · writeOnly
brands
​string · maxLength: 500 · writeOnly

Kuponun geçerli olduğu marka nesneleri.

members
​string · writeOnly

Kuponun geçerli olduğu üye nesneleri.

isEffectiveSpecialToken
​boolean · writeOnly
taxIncluded
​boolean · writeOnly
minimumUsageLimitTaxIncluded
​boolean · writeOnly
updatedAt
​string · date-time · writeOnly

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 · maxLength: 255

Ülkenin adı.

Example: Türkiye
code
​string · maxLength: 255

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
extraShippingPrice
​number · float · min: 0 · writeOnly
selectedLanguage
​string · maxLength: 255 · writeOnly
selectedCurrency
​string · maxLength: 255 · writeOnly
phoneCode
​integer · writeOnly

CollectionSummary

name
​string · maxLength: 255 · required
id
​integer
slug
​string · maxLength: 65535 · writeOnly
status
​integer · enum · writeOnly
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999 · writeOnly
displayShowcaseContent
​integer · enum · writeOnly
Enum values:
0
1
2
showcaseContent
​string · maxLength: 65535 · writeOnly
showcaseContentDisplayType
​integer · writeOnly
displayShowcaseFooterContent
​integer · enum · writeOnly
Enum values:
0
1
2
showcaseFooterContent
​string · maxLength: 65535 · writeOnly
showcaseFooterContentDisplayType
​integer · enum · writeOnly
Enum values:
1
2
3
pageTitle
​string · writeOnly
metaKeywords
​string · maxLength: 65535 · writeOnly
metaDescription
​string · maxLength: 65535 · writeOnly
canonicalUrl
​string · maxLength: 255 · writeOnly
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly

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

Kategoriye ait benzersiz kimlik numarası. Sistem tarafından otomatik oluşturulur.

Example: 123
name
​string · maxLength: 255

Kategori nesnesi için isim değeri.

Example: Kırtasiye
slug
​string · 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
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
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
distributor
​string · maxLength: 128

Her zaman null değer alır. Pratikte kullanımı yoktur.

Example:
displayShowcaseContent
​integer

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.

Example: 2
showcaseContent
​string · maxLength: 65535

Kategori nesnesinin üst içeriği. Admin paneli üzerinden düzenlenebilir.

Example: Üst içerik metni.
showcaseContentDisplayType
​integer

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.

Example: 2
displayShowcaseFooterContent
​integer

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.

showcaseFooterContent
​string · maxLength: 65535

Kategori nesnesinin alt içeriği. Admin paneli üzerinden düzenlenebilir.

showcaseFooterContentDisplayType
​integer

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.

hasChildren
​integer · enum

Kategorinin alt kategorilere sahip olup olmadığını belirtir. Seçenekler: | 0: Var | 1: Yok

Enum values:
0
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: 255

İ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
pageTitle
​string · maxLength: 65535

Sayfanın arama motorları tarafından tespit edilebilecek başlık yazısı.

Example: Kırtasiye Ürünleri
leftIndex
​integer · writeOnly
level
​integer · writeOnly
rightIndex
​integer · writeOnly
root
​integer · writeOnly
​object

Category nesnesi (özet). Tüm alanlar için Category şemasına bakın.

attachment
​string · writeOnly

attachment

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
createdAt
​string · date-time

Kategorinin oluşturulma zamanı (ISO 8601 formatında).

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

Kategorinin son güncellenme zamanı (ISO 8601 formatında).

Example: 2022-05-10T09:15:27+03:00
targetKeyword
​string · maxLength: 255

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
parentProductId
​integer · min: 0
categoryId
​integer · min: 0
isDigitalProduct
​boolean · enum
Enum values:
0
1
createdAt
​string · date-time

Sepet kaleminin oluşturulma zamanı.

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

Sepet kaleminin son güncellenme zamanı.

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

Cart nesnesi (özet). Tüm alanlar için Cart şemasına bakın.

​object

Sepet kalemi abonelik bilgisi objesi — cartItemSubscription nesnesi (özet). Tüm alanlar için cartItemSubscription şemasına bakın.

CartSummary

id
​integer

Sepet kimlik değeri

Example: 1
sessionId
​string · maxLength: 255

Sepet oturum kimliği

Example: v7ztzjyow1wgsg4wc4csg0w4oc4o8skok4c0sg800cgwcgo8o28qc2rxchf
locked
​integer · enum
Enum values:
0
1
lockedAt
​string · date-time
createdAt
​string · date-time
updatedAt
​string · date-time
​object

Promotion nesnesi (özet). Tüm alanlar için Promotion şemasına bakın.

​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[]

BrandSummary

Marka objesi
name
​string · maxLength: 255 · required

Marka adı

Example: Idea Kalem
id
​integer

Marka için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255
sortOrder
​integer · min: 1 · max: 999

Görüntüleme sırası

Example: 999
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
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 · maxLength: 65535

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 · maxLength: 65535
displayShowcaseFooterContent
​integer
metaKeywords
​string · maxLength: 65535

SEO meta anahtar kelimeler

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

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
canonicalUrl
​string · maxLength: 255 · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded logo verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
isSearchable
​integer · enum
Enum values:
0
1
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
targetKeyword
​string · maxLength: 255

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 · required

Müşterinin ülke bilgisi.

Example: Türkiye
location
​string · maxLength: 128 · required

Müşterinin şehir bilgisi.

Example: İstanbul
address
​string · maxLength: 65535 · required

Müşterinin adres bilgisi.

Example: Cumhuriyet Mah. Libadiye Cad. Çimen Sok. No:2
mobilePhoneNumber
​string · maxLength: 32 · required

Müşterinin mobil telefon numarası.

Example: +90 (555) 555 55 55
id
​integer

Fatura adresi nesnesi kimlik değeri.

Example: 123
subLocation
​string · maxLength: 128

Müşterinin ilçe bilgisi.

Example: Üsküdar
phoneNumber
​string · maxLength: 32

Müşterinin telefon numarası.

Example: +90 (216) 326 04 77
zipCode
​string · maxLength: 64
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly
​object

Orders nesnesi (özet). Tüm alanlar için Orders şemasına bakın.

invoiceType
​string · enum

Fatura tipini belirtir. Seçenekler: | individual: Bireysel. | corporate: Kurumsal.

Enum values:
individual
corporate
Example: individual
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