Skip to content
Ideasoft
Admin API

PromotionBar

Serverhttps://your-store.myideasoft.com

PromotionBar LIST

GET
https://your-store.myideasoft.com
/admin-api/promotion_bars
Bearer
or
OAuth 2.0

Bu endpoint, sistemdeki PromotionBar kayıtlarını listelemek veya filtrelemek için kullanılır. Listeleme; sıralama (sort), sayfalama (limit, page), ID bazlı filtreleme (id) ve arama (q, s) parametreleriyle özelleştirilebilir.

PromotionBar LIST › query Parameters

sort
​string

Sıralama parametresi. - Artan sıra için: sort=id - Azalan sıra için: sort=-id Örnek: sort=-createdAt

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek PromotionBar adedi. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1 Örnek: page=3

Default: 1
id
​string

Tek bir PromotionBar kaydını döndürmek için kullanılabilir. Örnek: id=7

q
​string

Alan bazlı gelişmiş arama filtresi. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Yaz Kampanyası

s
​string

Genel arama parametresi. Tüm arama yapılabilir alanlarda verilen kelimeyi arar. Örnek: s=indirim

PromotionBar LIST › Responses

The request (GET or PUT) completed successfully.

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

Promosyon barının adı.

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

Promosyon barında gösterilecek içerik.

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

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

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

Barın arka plan rengi.

Example: #ffffff
id
​integer

Promosyon barına ait benzersiz kimlik numarası.

Example: 12
closeButton
​integer · enum

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

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

Barın sayfa üzerindeki konumu.

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

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

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

Barın çerçeve rengi.

Example: #000000
frameSize
​integer · min: 0

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

Example: 2
displayHomepage
​integer · enum

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

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

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

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

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

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

Barın ilişkilendirildiği kategori nesneleri.

createdAt
​string · date-time

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

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

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

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

PromotionBar POST

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

PromotionBar POST › Request Body

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

Promosyon barının adı.

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

Promosyon barında gösterilecek içerik.

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

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

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

Barın arka plan rengi.

Example: #ffffff
id
​integer

Promosyon barına ait benzersiz kimlik numarası.

Example: 12
closeButton
​integer · enum

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

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

Barın sayfa üzerindeki konumu.

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

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

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

Barın çerçeve rengi.

Example: #000000
frameSize
​integer · min: 0

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

Example: 2
displayHomepage
​integer · enum

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

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

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

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

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

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

Barın ilişkilendirildiği kategori nesneleri.

createdAt
​string · date-time

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

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

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

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

PromotionBar POST › Responses

The create request (POST) completed successfully.

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

Promosyon barının adı.

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

Promosyon barında gösterilecek içerik.

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

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

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

Barın arka plan rengi.

Example: #ffffff
id
​integer

Promosyon barına ait benzersiz kimlik numarası.

Example: 12
closeButton
​integer · enum

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

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

Barın sayfa üzerindeki konumu.

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

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

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

Barın çerçeve rengi.

Example: #000000
frameSize
​integer · min: 0

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

Example: 2
displayHomepage
​integer · enum

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

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

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

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

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

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

Barın ilişkilendirildiği kategori nesneleri.

createdAt
​string · date-time

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

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

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

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

PromotionBar COUNT

GET
https://your-store.myideasoft.com
/admin-api/promotion_bars/count
Bearer
or
OAuth 2.0

Bu endpoint, sistemdeki PromotionBar kayıtlarını listelemek veya filtrelemek için kullanılır. Listeleme; sıralama (sort), sayfalama (limit, page), ID bazlı filtreleme (id) ve arama (q, s) parametreleriyle özelleştirilebilir.

PromotionBar COUNT › query Parameters

sort
​string

Sıralama parametresi. - Artan sıra için: sort=id - Azalan sıra için: sort=-id Örnek: sort=-createdAt

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek PromotionBar adedi. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1 Örnek: page=3

Default: 1
id
​string

Tek bir PromotionBar kaydını döndürmek için kullanılabilir. Örnek: id=7

q
​string

Alan bazlı gelişmiş arama filtresi. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Yaz Kampanyası

s
​string

Genel arama parametresi. Tüm arama yapılabilir alanlarda verilen kelimeyi arar. Örnek: s=indirim

PromotionBar COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


PromotionBar GET

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

PromotionBar GET › path Parameters

id
​string · pattern: \d+ · required

PromotionBar GET › Responses

The request (GET or PUT) completed successfully.

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

Promosyon barının adı.

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

Promosyon barında gösterilecek içerik.

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

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

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

Barın arka plan rengi.

Example: #ffffff
id
​integer

Promosyon barına ait benzersiz kimlik numarası.

Example: 12
closeButton
​integer · enum

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

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

Barın sayfa üzerindeki konumu.

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

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

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

Barın çerçeve rengi.

Example: #000000
frameSize
​integer · min: 0

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

Example: 2
displayHomepage
​integer · enum

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

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

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

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

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

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

Barın ilişkilendirildiği kategori nesneleri.

createdAt
​string · date-time

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

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

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

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

PromotionBar PUT

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

PromotionBar PUT › path Parameters

id
​string · pattern: \d+ · required

PromotionBar PUT › Request Body

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

Promosyon barının adı.

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

Promosyon barında gösterilecek içerik.

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

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

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

Barın arka plan rengi.

Example: #ffffff
id
​integer

Promosyon barına ait benzersiz kimlik numarası.

Example: 12
closeButton
​integer · enum

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

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

Barın sayfa üzerindeki konumu.

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

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

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

Barın çerçeve rengi.

Example: #000000
frameSize
​integer · min: 0

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

Example: 2
displayHomepage
​integer · enum

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

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

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

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

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

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

Barın ilişkilendirildiği kategori nesneleri.

createdAt
​string · date-time

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

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

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

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

PromotionBar PUT › Responses

The request (GET or PUT) completed successfully.

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

Promosyon barının adı.

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

Promosyon barında gösterilecek içerik.

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

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

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

Barın arka plan rengi.

Example: #ffffff
id
​integer

Promosyon barına ait benzersiz kimlik numarası.

Example: 12
closeButton
​integer · enum

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

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

Barın sayfa üzerindeki konumu.

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

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

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

Barın çerçeve rengi.

Example: #000000
frameSize
​integer · min: 0

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

Example: 2
displayHomepage
​integer · enum

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

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

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

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

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

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

Barın ilişkilendirildiği kategori nesneleri.

createdAt
​string · date-time

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

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

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

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

PromotionBar DELETE

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

PromotionBar DELETE › path Parameters

id
​string · pattern: \d+ · required

PromotionBar DELETE › Responses

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

No data returned