İçeriğe geç
Admin API

Category

Serverhttps://magaza-adiniz.myideasoft.com

Category LIST

GET
https://magaza-adiniz.myideasoft.com
/admin-api/categories
Bearer
or
OAuth 2.0

Category LIST › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek Categories adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
id
​integer · min: 1

Tekli listeleme için id değeri

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

parent
​string

Parent Id

displayShowcaseContent
​string · enum

displayShowcaseContent alanının alabileceği değerler: 0 veya 1

Enum values:
0
1
displayShowcaseFooterContent
​string · enum

displayShowcaseFooterContent alanının alabileceği değerler: 0 veya 1

Enum values:
0
1
distributor
​string

Category Distributor

startCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt değeri için başlangıç tarihi

endCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt değeri için bitiş tarihi

startUpdatedAt
​string · date · pattern: yyyy-mm-dd

updatedAt değeri için başlangıç tarihi

endUpdatedAt
​string · date · pattern: yyyy-mm-dd

updatedAt değeri için bitiş tarihi

status
​string · enum

Category status search filter

Enum values:
0
1
q
​string

Category arama filtresi. Kullanımı: q[<geçerli-query-param>]

s
​string

Arama anahtarı ile filtreleme

Category LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

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

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

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

Kategori nesnesi için isim değeri.

Example: Kırtasiye
slug
​string · minLength: 1 · maxLength: 255

Slug değeri ilgili nesnenin Url değeridir.

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

Kategori nesnesi için sıralama değeri.

Example: 999
showcaseSortOrder
​integer · max: 500
status
​integer · enum

Kategorinin aktiflik durumunu belirtir. Seçenekler: | 0: Pasif — kategori yayınlanmaz. | 1: Aktif — kategori mağazada görünür.

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

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

Example:
distributorCode
​string · maxLength: 255

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

percent
​number · float · min: 0

Kategori nesnesinin fiyat katsayısı.

Example: 1
imageFile
​string · maxLength: 255

Kategori nesnesinin görselinin dosya adı. Geçerli dosya tipleri: .JPG, .PNG, .GIF

Example: kalem.jpg
displayShowcaseContent
​integer · enum

Kategori üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
Example: 2
showcaseContent
​string

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

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

Kategori nesnesinin üst içerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve üst kategorilere ait içerik. | 3: Bu kategori ve tüm üst kategorilere ait içerik.

Enum values:
1
2
3
Example: 2
displayShowcaseFooterContent
​integer · enum

Kategori Alt İçerik nesnesinin üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
showcaseFooterContent
​string

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

showcaseFooterContentDisplayType
​integer · enum

Kategori Alt İçerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve alt kategorilere ait içerik. | 3: Bu kategori ve tüm alt kategorilere ait içerik.

Enum values:
1
2
3
hasChildren
​integer · enum

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

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

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

Example: Kırtasiye Ürünleri
metaDescription
​string

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

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

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

İlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-de&#x11F;eri" /> HTML etiketinin girdiginiz-canonical-url alanı yazan yere gelmesini istediğiniz değer. Mağaza domaininizin olduğu kısım değiştirilemez, sistem tarafından otomatik eklenir..

Example: kategoriler/idea-kalem
tree
​string

tree

attachment
​string · writeOnly

attachment

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

​object

Alt kategori olan kategori listesi.

imageUrl
​string

Kategori nesnesinin görselinin URL'i

Example: test.myideasoft.com/test/aa/01/myassets/categories/2/Screenshot
isCombine
​integer · enum

Kategori nesnesi kombin kategori durumu.Bu kategori kombin kategorisi olarak işaretlendiğinde kategori altındaki ürünler kombin detay sayfasına yönlendirilecektir. Seçenekler: | 0: Kombin Kategori | 1: Kombin Kategori değil

Enum values:
0
1
isSearchable
​integer · enum
Enum values:
0
1
​SeoSettingSummary
createdAt
​string · date-time

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

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

Category POST

POST
https://magaza-adiniz.myideasoft.com
/admin-api/categories
Bearer
or
OAuth 2.0

Category POST › Request Body

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

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

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

Kategori nesnesi için isim değeri.

Example: Kırtasiye
slug
​string · minLength: 1 · maxLength: 255

Slug değeri ilgili nesnenin Url değeridir.

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

Kategori nesnesi için sıralama değeri.

Example: 999
showcaseSortOrder
​integer · max: 500
status
​integer · enum

Kategorinin aktiflik durumunu belirtir. Seçenekler: | 0: Pasif — kategori yayınlanmaz. | 1: Aktif — kategori mağazada görünür.

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

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

Example:
distributorCode
​string · maxLength: 255

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

percent
​number · float · min: 0

Kategori nesnesinin fiyat katsayısı.

Example: 1
imageFile
​string · maxLength: 255

Kategori nesnesinin görselinin dosya adı. Geçerli dosya tipleri: .JPG, .PNG, .GIF

Example: kalem.jpg
displayShowcaseContent
​integer · enum

Kategori üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
Example: 2
showcaseContent
​string

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

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

Kategori nesnesinin üst içerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve üst kategorilere ait içerik. | 3: Bu kategori ve tüm üst kategorilere ait içerik.

Enum values:
1
2
3
Example: 2
displayShowcaseFooterContent
​integer · enum

Kategori Alt İçerik nesnesinin üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
showcaseFooterContent
​string

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

showcaseFooterContentDisplayType
​integer · enum

Kategori Alt İçerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve alt kategorilere ait içerik. | 3: Bu kategori ve tüm alt kategorilere ait içerik.

Enum values:
1
2
3
hasChildren
​integer · enum

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

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

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

Example: Kırtasiye Ürünleri
metaDescription
​string

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

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

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

İlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-de&#x11F;eri" /> HTML etiketinin girdiginiz-canonical-url alanı yazan yere gelmesini istediğiniz değer. Mağaza domaininizin olduğu kısım değiştirilemez, sistem tarafından otomatik eklenir..

Example: kategoriler/idea-kalem
tree
​string

tree

attachment
​string · writeOnly

attachment

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

​object

Alt kategori olan kategori listesi.

imageUrl
​string

Kategori nesnesinin görselinin URL'i

Example: test.myideasoft.com/test/aa/01/myassets/categories/2/Screenshot
isCombine
​integer · enum

Kategori nesnesi kombin kategori durumu.Bu kategori kombin kategorisi olarak işaretlendiğinde kategori altındaki ürünler kombin detay sayfasına yönlendirilecektir. Seçenekler: | 0: Kombin Kategori | 1: Kombin Kategori değil

Enum values:
0
1
isSearchable
​integer · enum
Enum values:
0
1
​SeoSettingSummary
createdAt
​string · date-time

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

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

Category POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

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

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

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

Kategori nesnesi için isim değeri.

Example: Kırtasiye
slug
​string · minLength: 1 · maxLength: 255

Slug değeri ilgili nesnenin Url değeridir.

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

Kategori nesnesi için sıralama değeri.

Example: 999
showcaseSortOrder
​integer · max: 500
status
​integer · enum

Kategorinin aktiflik durumunu belirtir. Seçenekler: | 0: Pasif — kategori yayınlanmaz. | 1: Aktif — kategori mağazada görünür.

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

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

Example:
distributorCode
​string · maxLength: 255

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

percent
​number · float · min: 0

Kategori nesnesinin fiyat katsayısı.

Example: 1
imageFile
​string · maxLength: 255

Kategori nesnesinin görselinin dosya adı. Geçerli dosya tipleri: .JPG, .PNG, .GIF

Example: kalem.jpg
displayShowcaseContent
​integer · enum

Kategori üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
Example: 2
showcaseContent
​string

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

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

Kategori nesnesinin üst içerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve üst kategorilere ait içerik. | 3: Bu kategori ve tüm üst kategorilere ait içerik.

Enum values:
1
2
3
Example: 2
displayShowcaseFooterContent
​integer · enum

Kategori Alt İçerik nesnesinin üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
showcaseFooterContent
​string

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

showcaseFooterContentDisplayType
​integer · enum

Kategori Alt İçerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve alt kategorilere ait içerik. | 3: Bu kategori ve tüm alt kategorilere ait içerik.

Enum values:
1
2
3
hasChildren
​integer · enum

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

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

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

Example: Kırtasiye Ürünleri
metaDescription
​string

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

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

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

İlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-de&#x11F;eri" /> HTML etiketinin girdiginiz-canonical-url alanı yazan yere gelmesini istediğiniz değer. Mağaza domaininizin olduğu kısım değiştirilemez, sistem tarafından otomatik eklenir..

Example: kategoriler/idea-kalem
tree
​string

tree

attachment
​string · writeOnly

attachment

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

​object

Alt kategori olan kategori listesi.

imageUrl
​string

Kategori nesnesinin görselinin URL'i

Example: test.myideasoft.com/test/aa/01/myassets/categories/2/Screenshot
isCombine
​integer · enum

Kategori nesnesi kombin kategori durumu.Bu kategori kombin kategorisi olarak işaretlendiğinde kategori altındaki ürünler kombin detay sayfasına yönlendirilecektir. Seçenekler: | 0: Kombin Kategori | 1: Kombin Kategori değil

Enum values:
0
1
isSearchable
​integer · enum
Enum values:
0
1
​SeoSettingSummary
createdAt
​string · date-time

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

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

Category COUNT

GET
https://magaza-adiniz.myideasoft.com
/admin-api/categories/count
Bearer
or
OAuth 2.0

Category COUNT › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek Categories adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
id
​integer · min: 1

Tekli listeleme için id değeri

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

parent
​string

Parent Id

displayShowcaseContent
​string · enum

displayShowcaseContent alanının alabileceği değerler: 0 veya 1

Enum values:
0
1
displayShowcaseFooterContent
​string · enum

displayShowcaseFooterContent alanının alabileceği değerler: 0 veya 1

Enum values:
0
1
distributor
​string

Category Distributor

startCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt değeri için başlangıç tarihi

endCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt değeri için bitiş tarihi

startUpdatedAt
​string · date · pattern: yyyy-mm-dd

updatedAt değeri için başlangıç tarihi

endUpdatedAt
​string · date · pattern: yyyy-mm-dd

updatedAt değeri için bitiş tarihi

status
​string · enum

Category status search filter

Enum values:
0
1
q
​string

Category arama filtresi. Kullanımı: q[<geçerli-query-param>]

s
​string

Arama anahtarı ile filtreleme

Category COUNT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Kayıt sayısı yanıtı.
total_count
​integer · required

Filtrelere uyan toplam kayıt sayısı.


Category GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/categories/{id}
Bearer
or
OAuth 2.0

Category GET › path Parameters

id
​string · pattern: \d+ · required

Getirilecek Category ID

Category GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

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

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

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

Kategori nesnesi için isim değeri.

Example: Kırtasiye
slug
​string · minLength: 1 · maxLength: 255

Slug değeri ilgili nesnenin Url değeridir.

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

Kategori nesnesi için sıralama değeri.

Example: 999
showcaseSortOrder
​integer · max: 500
status
​integer · enum

Kategorinin aktiflik durumunu belirtir. Seçenekler: | 0: Pasif — kategori yayınlanmaz. | 1: Aktif — kategori mağazada görünür.

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

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

Example:
distributorCode
​string · maxLength: 255

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

percent
​number · float · min: 0

Kategori nesnesinin fiyat katsayısı.

Example: 1
imageFile
​string · maxLength: 255

Kategori nesnesinin görselinin dosya adı. Geçerli dosya tipleri: .JPG, .PNG, .GIF

Example: kalem.jpg
displayShowcaseContent
​integer · enum

Kategori üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
Example: 2
showcaseContent
​string

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

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

Kategori nesnesinin üst içerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve üst kategorilere ait içerik. | 3: Bu kategori ve tüm üst kategorilere ait içerik.

Enum values:
1
2
3
Example: 2
displayShowcaseFooterContent
​integer · enum

Kategori Alt İçerik nesnesinin üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
showcaseFooterContent
​string

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

showcaseFooterContentDisplayType
​integer · enum

Kategori Alt İçerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve alt kategorilere ait içerik. | 3: Bu kategori ve tüm alt kategorilere ait içerik.

Enum values:
1
2
3
hasChildren
​integer · enum

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

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

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

Example: Kırtasiye Ürünleri
metaDescription
​string

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

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

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

İlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-de&#x11F;eri" /> HTML etiketinin girdiginiz-canonical-url alanı yazan yere gelmesini istediğiniz değer. Mağaza domaininizin olduğu kısım değiştirilemez, sistem tarafından otomatik eklenir..

Example: kategoriler/idea-kalem
tree
​string

tree

attachment
​string · writeOnly

attachment

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

​object

Alt kategori olan kategori listesi.

imageUrl
​string

Kategori nesnesinin görselinin URL'i

Example: test.myideasoft.com/test/aa/01/myassets/categories/2/Screenshot
isCombine
​integer · enum

Kategori nesnesi kombin kategori durumu.Bu kategori kombin kategorisi olarak işaretlendiğinde kategori altındaki ürünler kombin detay sayfasına yönlendirilecektir. Seçenekler: | 0: Kombin Kategori | 1: Kombin Kategori değil

Enum values:
0
1
isSearchable
​integer · enum
Enum values:
0
1
​SeoSettingSummary
createdAt
​string · date-time

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

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

Category PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/categories/{id}
Bearer
or
OAuth 2.0

Category PUT › path Parameters

id
​string · pattern: \d+ · required

Güncellenecek Category ID

Category PUT › Request Body

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

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

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

Kategori nesnesi için isim değeri.

Example: Kırtasiye
slug
​string · minLength: 1 · maxLength: 255

Slug değeri ilgili nesnenin Url değeridir.

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

Kategori nesnesi için sıralama değeri.

Example: 999
showcaseSortOrder
​integer · max: 500
status
​integer · enum

Kategorinin aktiflik durumunu belirtir. Seçenekler: | 0: Pasif — kategori yayınlanmaz. | 1: Aktif — kategori mağazada görünür.

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

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

Example:
distributorCode
​string · maxLength: 255

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

percent
​number · float · min: 0

Kategori nesnesinin fiyat katsayısı.

Example: 1
imageFile
​string · maxLength: 255

Kategori nesnesinin görselinin dosya adı. Geçerli dosya tipleri: .JPG, .PNG, .GIF

Example: kalem.jpg
displayShowcaseContent
​integer · enum

Kategori üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
Example: 2
showcaseContent
​string

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

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

Kategori nesnesinin üst içerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve üst kategorilere ait içerik. | 3: Bu kategori ve tüm üst kategorilere ait içerik.

Enum values:
1
2
3
Example: 2
displayShowcaseFooterContent
​integer · enum

Kategori Alt İçerik nesnesinin üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
showcaseFooterContent
​string

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

showcaseFooterContentDisplayType
​integer · enum

Kategori Alt İçerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve alt kategorilere ait içerik. | 3: Bu kategori ve tüm alt kategorilere ait içerik.

Enum values:
1
2
3
hasChildren
​integer · enum

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

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

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

Example: Kırtasiye Ürünleri
metaDescription
​string

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

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

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

İlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-de&#x11F;eri" /> HTML etiketinin girdiginiz-canonical-url alanı yazan yere gelmesini istediğiniz değer. Mağaza domaininizin olduğu kısım değiştirilemez, sistem tarafından otomatik eklenir..

Example: kategoriler/idea-kalem
tree
​string

tree

attachment
​string · writeOnly

attachment

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

​object

Alt kategori olan kategori listesi.

imageUrl
​string

Kategori nesnesinin görselinin URL'i

Example: test.myideasoft.com/test/aa/01/myassets/categories/2/Screenshot
isCombine
​integer · enum

Kategori nesnesi kombin kategori durumu.Bu kategori kombin kategorisi olarak işaretlendiğinde kategori altındaki ürünler kombin detay sayfasına yönlendirilecektir. Seçenekler: | 0: Kombin Kategori | 1: Kombin Kategori değil

Enum values:
0
1
isSearchable
​integer · enum
Enum values:
0
1
​SeoSettingSummary
createdAt
​string · date-time

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

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

Category PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

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

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

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

Kategori nesnesi için isim değeri.

Example: Kırtasiye
slug
​string · minLength: 1 · maxLength: 255

Slug değeri ilgili nesnenin Url değeridir.

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

Kategori nesnesi için sıralama değeri.

Example: 999
showcaseSortOrder
​integer · max: 500
status
​integer · enum

Kategorinin aktiflik durumunu belirtir. Seçenekler: | 0: Pasif — kategori yayınlanmaz. | 1: Aktif — kategori mağazada görünür.

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

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

Example:
distributorCode
​string · maxLength: 255

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

percent
​number · float · min: 0

Kategori nesnesinin fiyat katsayısı.

Example: 1
imageFile
​string · maxLength: 255

Kategori nesnesinin görselinin dosya adı. Geçerli dosya tipleri: .JPG, .PNG, .GIF

Example: kalem.jpg
displayShowcaseContent
​integer · enum

Kategori üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
Example: 2
showcaseContent
​string

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

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

Kategori nesnesinin üst içerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve üst kategorilere ait içerik. | 3: Bu kategori ve tüm üst kategorilere ait içerik.

Enum values:
1
2
3
Example: 2
displayShowcaseFooterContent
​integer · enum

Kategori Alt İçerik nesnesinin üst içerik metninin gösterim durumu. Seçenekler: | 0: Gösterilmez. | 1: Yalnızca masaüstü cihazlarda gösterilir. | 2: Hem mobil hem masaüstü cihazlarda gösterilir.

Enum values:
0
1
2
showcaseFooterContent
​string

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

showcaseFooterContentDisplayType
​integer · enum

Kategori Alt İçerik metninin gösterim tipi. Seçenekler: | 1: Sadece bu kategoriye ait içerik. | 2: Bu kategori ve alt kategorilere ait içerik. | 3: Bu kategori ve tüm alt kategorilere ait içerik.

Enum values:
1
2
3
hasChildren
​integer · enum

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

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

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

Example: Kırtasiye Ürünleri
metaDescription
​string

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

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

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

İlgili nesnenin İdeaSoft mağazanızdaki sayfasına eklenecek olan <link rel="canonical" href="https://www.magaza-adiniz.com/girdiginiz-canonical-url-de&#x11F;eri" /> HTML etiketinin girdiginiz-canonical-url alanı yazan yere gelmesini istediğiniz değer. Mağaza domaininizin olduğu kısım değiştirilemez, sistem tarafından otomatik eklenir..

Example: kategoriler/idea-kalem
tree
​string

tree

attachment
​string · writeOnly

attachment

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

​object

Alt kategori olan kategori listesi.

imageUrl
​string

Kategori nesnesinin görselinin URL'i

Example: test.myideasoft.com/test/aa/01/myassets/categories/2/Screenshot
isCombine
​integer · enum

Kategori nesnesi kombin kategori durumu.Bu kategori kombin kategorisi olarak işaretlendiğinde kategori altındaki ürünler kombin detay sayfasına yönlendirilecektir. Seçenekler: | 0: Kombin Kategori | 1: Kombin Kategori değil

Enum values:
0
1
isSearchable
​integer · enum
Enum values:
0
1
​SeoSettingSummary
createdAt
​string · date-time

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

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255
solvedCount
​integer
seoTotalRuleCount
​integer

Category DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/admin-api/categories/{id}
Bearer
or
OAuth 2.0

Category DELETE › path Parameters

id
​string · pattern: \d+ · required

Silinecek Category ID

Category DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned

Category SearchTreeAction GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/categories/search_tree
Bearer
or
OAuth 2.0

Category SearchTreeAction GET › query Parameters

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek Categories adedi

id
​integer · min: -1

Tekli listeleme için id değeri

q
​string

Category arama filtresi. Kullanımı: q[<geçerli-query-param>]

s
​string

Arama anahtarı ile filtreleme

parent
​string

Parent Id

Category SearchTreeAction GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

No data returned