İçeriğe geç
Admin API

Block

Serverhttps://magaza-adiniz.myideasoft.com

Block LIST

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

Block 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 blocks adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
id
​integer · min: 1

Tekli listeleme için id değeri.

q
​string

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

s
​string

Arama anahtarı ile filtreleme.

Block LIST › Responses

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

name
​string · maxLength: 255 · required

Blok adı. Yönetim panelinde görüntülenecek isimdir.

Example: Ürün Grupları
position
​string · enum · required

Blok konumu. Sayfada hangi alanda yer alacağını belirtir. Seçenekler: | left: Sol tarafta gösterilir. | right: Sağ tarafta gösterilir.

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

Blok çerçeve durumu. Blok görsel olarak bir çerçeve içinde gösterilsin mi? Seçenekler: | 0: Çerçevesiz. | 1: Çerçeveli.

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

Blok aktiflik durumu. Aktif olan blok mağazada gösterilir. Seçenekler: | 0: Pasif (gösterilmez). | 1: Aktif (gösterilir).

Enum values:
0
1
id
​integer

Blok nesnesi kimlik değeri. Her blok için benzersizdir.

Example: 1
sortOrder
​integer

Blok sıralama değeri. Sayfadaki blokların hangi sırada görüntüleneceğini belirler.

Example: 999
module
​string

Blok’un bağlı olduğu modül. Örneğin marka, kategori veya kampanya.

Example: brand
content
​string · maxLength: 65535

Blok içeriği. HTML veya düz metin olabilir.

Example: Bir test bloğudur.
predefined
​integer · enum

Blok’un sistem tarafından ön tanımlı olup olmadığını belirtir. Seçenekler: | 0: Sonradan kullanıcı tarafından eklenmiş blok. | 1: Sistem tarafından ön tanımlı blok.

Enum values:
0
1

Block POST

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

Block POST › Request Body

name
​string · maxLength: 255 · required

Blok adı. Yönetim panelinde görüntülenecek isimdir.

Example: Ürün Grupları
position
​string · enum · required

Blok konumu. Sayfada hangi alanda yer alacağını belirtir. Seçenekler: | left: Sol tarafta gösterilir. | right: Sağ tarafta gösterilir.

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

Blok çerçeve durumu. Blok görsel olarak bir çerçeve içinde gösterilsin mi? Seçenekler: | 0: Çerçevesiz. | 1: Çerçeveli.

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

Blok aktiflik durumu. Aktif olan blok mağazada gösterilir. Seçenekler: | 0: Pasif (gösterilmez). | 1: Aktif (gösterilir).

Enum values:
0
1
id
​integer

Blok nesnesi kimlik değeri. Her blok için benzersizdir.

Example: 1
sortOrder
​integer

Blok sıralama değeri. Sayfadaki blokların hangi sırada görüntüleneceğini belirler.

Example: 999
module
​string

Blok’un bağlı olduğu modül. Örneğin marka, kategori veya kampanya.

Example: brand
content
​string · maxLength: 65535

Blok içeriği. HTML veya düz metin olabilir.

Example: Bir test bloğudur.
predefined
​integer · enum

Blok’un sistem tarafından ön tanımlı olup olmadığını belirtir. Seçenekler: | 0: Sonradan kullanıcı tarafından eklenmiş blok. | 1: Sistem tarafından ön tanımlı blok.

Enum values:
0
1

Block POST › Responses

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

name
​string · maxLength: 255 · required

Blok adı. Yönetim panelinde görüntülenecek isimdir.

Example: Ürün Grupları
position
​string · enum · required

Blok konumu. Sayfada hangi alanda yer alacağını belirtir. Seçenekler: | left: Sol tarafta gösterilir. | right: Sağ tarafta gösterilir.

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

Blok çerçeve durumu. Blok görsel olarak bir çerçeve içinde gösterilsin mi? Seçenekler: | 0: Çerçevesiz. | 1: Çerçeveli.

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

Blok aktiflik durumu. Aktif olan blok mağazada gösterilir. Seçenekler: | 0: Pasif (gösterilmez). | 1: Aktif (gösterilir).

Enum values:
0
1
id
​integer

Blok nesnesi kimlik değeri. Her blok için benzersizdir.

Example: 1
sortOrder
​integer

Blok sıralama değeri. Sayfadaki blokların hangi sırada görüntüleneceğini belirler.

Example: 999
module
​string

Blok’un bağlı olduğu modül. Örneğin marka, kategori veya kampanya.

Example: brand
content
​string · maxLength: 65535

Blok içeriği. HTML veya düz metin olabilir.

Example: Bir test bloğudur.
predefined
​integer · enum

Blok’un sistem tarafından ön tanımlı olup olmadığını belirtir. Seçenekler: | 0: Sonradan kullanıcı tarafından eklenmiş blok. | 1: Sistem tarafından ön tanımlı blok.

Enum values:
0
1

Block COUNT

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

Block 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 blocks adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
id
​integer · min: 1

Tekli listeleme için id değeri.

q
​string

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

s
​string

Arama anahtarı ile filtreleme.

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


Block GET

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

Block GET › path Parameters

id
​string · pattern: \d+ · required

Block GET › Responses

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

name
​string · maxLength: 255 · required

Blok adı. Yönetim panelinde görüntülenecek isimdir.

Example: Ürün Grupları
position
​string · enum · required

Blok konumu. Sayfada hangi alanda yer alacağını belirtir. Seçenekler: | left: Sol tarafta gösterilir. | right: Sağ tarafta gösterilir.

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

Blok çerçeve durumu. Blok görsel olarak bir çerçeve içinde gösterilsin mi? Seçenekler: | 0: Çerçevesiz. | 1: Çerçeveli.

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

Blok aktiflik durumu. Aktif olan blok mağazada gösterilir. Seçenekler: | 0: Pasif (gösterilmez). | 1: Aktif (gösterilir).

Enum values:
0
1
id
​integer

Blok nesnesi kimlik değeri. Her blok için benzersizdir.

Example: 1
sortOrder
​integer

Blok sıralama değeri. Sayfadaki blokların hangi sırada görüntüleneceğini belirler.

Example: 999
module
​string

Blok’un bağlı olduğu modül. Örneğin marka, kategori veya kampanya.

Example: brand
content
​string · maxLength: 65535

Blok içeriği. HTML veya düz metin olabilir.

Example: Bir test bloğudur.
predefined
​integer · enum

Blok’un sistem tarafından ön tanımlı olup olmadığını belirtir. Seçenekler: | 0: Sonradan kullanıcı tarafından eklenmiş blok. | 1: Sistem tarafından ön tanımlı blok.

Enum values:
0
1

Block PUT

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

Block PUT › path Parameters

id
​string · pattern: \d+ · required

Block PUT › Request Body

name
​string · maxLength: 255 · required

Blok adı. Yönetim panelinde görüntülenecek isimdir.

Example: Ürün Grupları
position
​string · enum · required

Blok konumu. Sayfada hangi alanda yer alacağını belirtir. Seçenekler: | left: Sol tarafta gösterilir. | right: Sağ tarafta gösterilir.

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

Blok çerçeve durumu. Blok görsel olarak bir çerçeve içinde gösterilsin mi? Seçenekler: | 0: Çerçevesiz. | 1: Çerçeveli.

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

Blok aktiflik durumu. Aktif olan blok mağazada gösterilir. Seçenekler: | 0: Pasif (gösterilmez). | 1: Aktif (gösterilir).

Enum values:
0
1
id
​integer

Blok nesnesi kimlik değeri. Her blok için benzersizdir.

Example: 1
sortOrder
​integer

Blok sıralama değeri. Sayfadaki blokların hangi sırada görüntüleneceğini belirler.

Example: 999
module
​string

Blok’un bağlı olduğu modül. Örneğin marka, kategori veya kampanya.

Example: brand
content
​string · maxLength: 65535

Blok içeriği. HTML veya düz metin olabilir.

Example: Bir test bloğudur.
predefined
​integer · enum

Blok’un sistem tarafından ön tanımlı olup olmadığını belirtir. Seçenekler: | 0: Sonradan kullanıcı tarafından eklenmiş blok. | 1: Sistem tarafından ön tanımlı blok.

Enum values:
0
1

Block PUT › Responses

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

name
​string · maxLength: 255 · required

Blok adı. Yönetim panelinde görüntülenecek isimdir.

Example: Ürün Grupları
position
​string · enum · required

Blok konumu. Sayfada hangi alanda yer alacağını belirtir. Seçenekler: | left: Sol tarafta gösterilir. | right: Sağ tarafta gösterilir.

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

Blok çerçeve durumu. Blok görsel olarak bir çerçeve içinde gösterilsin mi? Seçenekler: | 0: Çerçevesiz. | 1: Çerçeveli.

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

Blok aktiflik durumu. Aktif olan blok mağazada gösterilir. Seçenekler: | 0: Pasif (gösterilmez). | 1: Aktif (gösterilir).

Enum values:
0
1
id
​integer

Blok nesnesi kimlik değeri. Her blok için benzersizdir.

Example: 1
sortOrder
​integer

Blok sıralama değeri. Sayfadaki blokların hangi sırada görüntüleneceğini belirler.

Example: 999
module
​string

Blok’un bağlı olduğu modül. Örneğin marka, kategori veya kampanya.

Example: brand
content
​string · maxLength: 65535

Blok içeriği. HTML veya düz metin olabilir.

Example: Bir test bloğudur.
predefined
​integer · enum

Blok’un sistem tarafından ön tanımlı olup olmadığını belirtir. Seçenekler: | 0: Sonradan kullanıcı tarafından eklenmiş blok. | 1: Sistem tarafından ön tanımlı blok.

Enum values:
0
1

Block DELETE

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

Block DELETE › path Parameters

id
​string · pattern: \d+ · required

Block DELETE › Responses

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

No data returned