Skip to content
Ideasoft
Admin API

Popup

Serverhttps://your-store.myideasoft.com

GET
https://your-store.myideasoft.com
/admin-api/popups
Bearer

Bu endpoint, sistemdeki Popupları listeler ve çeşitli kriterlere göre filtrelemeye olanak sağlar. Sıralama (sort), sayfalama (limit, page), tekil ID (id) ve arama (q, s) parametreleriyle özelleştirilebilir.

sort
​string

Sonuçların sıralama biçimi. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek Popup sayısı. Varsayılan 20

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı. Varsayılan 1

Default: 1
id
​string

Tek bir Popup kaydını döndürmek için ID değeri

q
​string

Popup arama filtresi. Kullanımı: q[<geçerli-query-param>]=<değer>

s
​string

Genel arama anahtarı ile filtreleme

The request (GET or PUT) completed successfully.

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

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

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

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

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

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

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

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

Enum values:
0
1
Example: 1
id
​integer

Popup nesnesine ait benzersiz kimlik numarası.

Example: 101
frequency
​integer · min: 0

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

Example: 1
displayHomepage
​integer · enum

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

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

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

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

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

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

Kategori nesnesi

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

Popup nesnesinin oluşturulma zamanı.

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

Popup nesnesinin son güncellenme zamanı.

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

Popup POST

POST
https://your-store.myideasoft.com
/admin-api/popups
Bearer
or
OAuth 2.0

Bu endpoint, yeni bir Popup kaydı oluşturur ve log kaydı oluşturur.

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

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

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

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

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

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

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

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

Enum values:
0
1
Example: 1
id
​integer

Popup nesnesine ait benzersiz kimlik numarası.

Example: 101
frequency
​integer · min: 0

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

Example: 1
displayHomepage
​integer · enum

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

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

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

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

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

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

Kategori nesnesi

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

Popup nesnesinin oluşturulma zamanı.

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

Popup nesnesinin son güncellenme zamanı.

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

The create request (POST) completed successfully.

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

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

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

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

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

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

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

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

Enum values:
0
1
Example: 1
id
​integer

Popup nesnesine ait benzersiz kimlik numarası.

Example: 101
frequency
​integer · min: 0

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

Example: 1
displayHomepage
​integer · enum

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

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

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

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

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

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

Kategori nesnesi

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

Popup nesnesinin oluşturulma zamanı.

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

Popup nesnesinin son güncellenme zamanı.

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

GET
https://your-store.myideasoft.com
/admin-api/popups/count
Bearer

Bu endpoint, sistemdeki Popupları listeler ve çeşitli kriterlere göre filtrelemeye olanak sağlar. Sıralama (sort), sayfalama (limit, page), tekil ID (id) ve arama (q, s) parametreleriyle özelleştirilebilir.

sort
​string

Sonuçların sıralama biçimi. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek Popup sayısı. Varsayılan 20

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı. Varsayılan 1

Default: 1
id
​string

Tek bir Popup kaydını döndürmek için ID değeri

q
​string

Popup arama filtresi. Kullanımı: q[<geçerli-query-param>]=<değer>

s
​string

Genel arama anahtarı ile filtreleme

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


GET
https://your-store.myideasoft.com
/admin-api/popups/{id}
Bearer

Belirtilen ID ile eşleşen Popup kaydını döndürür.

id
​string · pattern: \d+ · required

Popup kaydının ID değeri

The request (GET or PUT) completed successfully.

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

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

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

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

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

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

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

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

Enum values:
0
1
Example: 1
id
​integer

Popup nesnesine ait benzersiz kimlik numarası.

Example: 101
frequency
​integer · min: 0

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

Example: 1
displayHomepage
​integer · enum

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

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

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

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

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

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

Kategori nesnesi

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

Popup nesnesinin oluşturulma zamanı.

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

Popup nesnesinin son güncellenme zamanı.

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

PUT
https://your-store.myideasoft.com
/admin-api/popups/{id}
Bearer
or
OAuth 2.0

Belirtilen Popup kaydını günceller ve log kaydı oluşturur.

id
​string · pattern: \d+ · required

Güncellenecek Popup kaydının ID değeri

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

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

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

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

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

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

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

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

Enum values:
0
1
Example: 1
id
​integer

Popup nesnesine ait benzersiz kimlik numarası.

Example: 101
frequency
​integer · min: 0

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

Example: 1
displayHomepage
​integer · enum

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

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

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

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

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

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

Kategori nesnesi

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

Popup nesnesinin oluşturulma zamanı.

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

Popup nesnesinin son güncellenme zamanı.

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

The request (GET or PUT) completed successfully.

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

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

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

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

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

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

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

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

Enum values:
0
1
Example: 1
id
​integer

Popup nesnesine ait benzersiz kimlik numarası.

Example: 101
frequency
​integer · min: 0

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

Example: 1
displayHomepage
​integer · enum

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

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

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

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

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

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

Kategori nesnesi

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

Popup nesnesinin oluşturulma zamanı.

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

Popup nesnesinin son güncellenme zamanı.

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

DELETE
https://your-store.myideasoft.com
/admin-api/popups/{id}
Bearer
or
OAuth 2.0

Belirtilen Popup kaydını siler ve log kaydı oluşturur.

id
​string · pattern: \d+ · required

Silinecek Popup kaydının ID değeri

The delete request completed successfully (the response has no content).

No data returned