Skip to content
Ideasoft
Admin API

Promotion

Serverhttps://your-store.myideasoft.com

Promotion LIST

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

Bu endpoint, mevcut kampanyaları (Promotions) listelemek, filtrelemek veya zaman aralığına göre arama yapmak için kullanılır. Listeleme işlemi, sayfalama (limit, page), sıralama (sort), tarih filtreleri (startDate, endDate) ve tip (type) parametreleriyle özelleştirilebilir.

Promotion LIST › query Parameters

sort
​string

Sıralama parametresi. - Artan sıralama için: sort=id - Azalan sıralama için: sort=-id Birden fazla alanla sıralama yapmak için virgülle ayırabilirsiniz. Örnek: sort=-startDate,name

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek maksimum kampanya (promotion) sayısı. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

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

Default: 1
id
​integer · min: 1

Tek bir kampanyayı (promotion) döndürmek için kullanılır. Örnek: id=15

ids
​string

Birden fazla kampanyayı aynı anda getirmek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir. Özellikle sayfalama veya gerçek zamanlı güncelleme (incremental sync) senaryolarında kullanılır. Örnek: sinceId=100

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

Kampanyaların başlangıç tarihine göre filtreleme yapar. Format: YYYY-MM-DD Örnek: startDate=2025-01-01

type
​string · enum

Kampanya türüne göre filtreleme yapar. Olası değerler: - cart → Sepet bazlı kampanyalar - product → Ürün bazlı kampanyalar - category_and_brand → Kategori veya marka bazlı kampanyalar Örnek: type=cart

Enum values:
cart
product
category_and_brand
endDate
​string · date · pattern: yyyy-mm-dd

Kampanyaların bitiş tarihine göre filtreleme yapar. Format: YYYY-MM-DD Örnek: endDate=2025-12-31

q
​string

Alan bazlı detaylı arama filtresi. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Yılbaşı veya q[status]=active

s
​string

Genel arama anahtar kelimesiyle filtreleme yapar. Arama, sistemde tanımlı tüm metinsel alanlarda yapılır. Örnek: s=indirim

specialty
​string · enum

Specialty List

Enum values:
campaign

Promotion LIST › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Promosyon nesnesi kimlik değeri.

name
​string · maxLength: 255 · required

Promosyon adı.

Example: Sepette %20 İndirim
type
​string · enum

Promosyon tipi.

Enum values:
cart
product
category_and_brand
Example: cart
maxUsage
​integer · min: 0

Promosyonun maksimum kullanım sayısı.

Example: 1000
currentUsage
​integer · min: 0

Şu ana kadar toplam kullanım sayısı.

Example: 250
useDateFilter
​integer · enum

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

Enum values:
0
1
Example: 1
startDate
​string · date-time

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time
​MemberSummary[]

members

​MemberGroupSummary
minimumCheckoutLimit
​number · float

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

Example: 200
​CategorySummary

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

​CategorySummary[]
​BrandSummary

Marka objesi

​ProductSummary[]

Ana Ürünler

​PromotionPriceRangeSummary[] · minItems: 2 · maxItems: 5
minimumPurchaseQuantityOfMainProducts
​integer · min: 0

Ana ürün minimum satın alma zorunluluğu miktarı.

Example: 2
promotionValidityControl
​string · enum

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
promotionFeatureType
​string · enum

Promosyon özelliği tipi.

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

Promosyon özelliğine ait promosyon miktarı.

Example: 20
​ProductSummary[]

Promosyonlu ürün nesnesi listesi

promotionalProductQuantity
​integer · min: 0

Promosyonlu ürün miktarı.

Example: 1
description
​string

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255
urlBlankStatus
​integer · enum
Enum values:
0
1
imageFile
​string · maxLength: 255
imageUrl
​string
attachment
​string · writeOnly
status
​integer · enum

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999999
freeShipping
​integer · enum

Ücretsiz kargo durumu.

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

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

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

Promosyon nesnesinin oluşturulma zamanı.

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

Promosyon nesnesinin güncellenme zamanı.

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

Promotion POST

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

Promotion POST › Request Body

id
​integer · required

Promosyon nesnesi kimlik değeri.

name
​string · maxLength: 255 · required

Promosyon adı.

Example: Sepette %20 İndirim
type
​string · enum

Promosyon tipi.

Enum values:
cart
product
category_and_brand
Example: cart
maxUsage
​integer · min: 0

Promosyonun maksimum kullanım sayısı.

Example: 1000
currentUsage
​integer · min: 0

Şu ana kadar toplam kullanım sayısı.

Example: 250
useDateFilter
​integer · enum

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

Enum values:
0
1
Example: 1
startDate
​string · date-time

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time
​MemberSummary[]

members

​MemberGroupSummary
minimumCheckoutLimit
​number · float

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

Example: 200
​CategorySummary

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

​CategorySummary[]
​BrandSummary

Marka objesi

​ProductSummary[]

Ana Ürünler

​PromotionPriceRangeSummary[] · minItems: 2 · maxItems: 5
minimumPurchaseQuantityOfMainProducts
​integer · min: 0

Ana ürün minimum satın alma zorunluluğu miktarı.

Example: 2
promotionValidityControl
​string · enum

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
promotionFeatureType
​string · enum

Promosyon özelliği tipi.

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

Promosyon özelliğine ait promosyon miktarı.

Example: 20
​ProductSummary[]

Promosyonlu ürün nesnesi listesi

promotionalProductQuantity
​integer · min: 0

Promosyonlu ürün miktarı.

Example: 1
description
​string

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255
urlBlankStatus
​integer · enum
Enum values:
0
1
imageFile
​string · maxLength: 255
imageUrl
​string
attachment
​string · writeOnly
status
​integer · enum

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999999
freeShipping
​integer · enum

Ücretsiz kargo durumu.

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

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

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

Promosyon nesnesinin oluşturulma zamanı.

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

Promosyon nesnesinin güncellenme zamanı.

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

Promotion POST › Responses

The create request (POST) completed successfully.

id
​integer · required

Promosyon nesnesi kimlik değeri.

name
​string · maxLength: 255 · required

Promosyon adı.

Example: Sepette %20 İndirim
type
​string · enum

Promosyon tipi.

Enum values:
cart
product
category_and_brand
Example: cart
maxUsage
​integer · min: 0

Promosyonun maksimum kullanım sayısı.

Example: 1000
currentUsage
​integer · min: 0

Şu ana kadar toplam kullanım sayısı.

Example: 250
useDateFilter
​integer · enum

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

Enum values:
0
1
Example: 1
startDate
​string · date-time

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time
​MemberSummary[]

members

​MemberGroupSummary
minimumCheckoutLimit
​number · float

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

Example: 200
​CategorySummary

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

​CategorySummary[]
​BrandSummary

Marka objesi

​ProductSummary[]

Ana Ürünler

​PromotionPriceRangeSummary[] · minItems: 2 · maxItems: 5
minimumPurchaseQuantityOfMainProducts
​integer · min: 0

Ana ürün minimum satın alma zorunluluğu miktarı.

Example: 2
promotionValidityControl
​string · enum

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
promotionFeatureType
​string · enum

Promosyon özelliği tipi.

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

Promosyon özelliğine ait promosyon miktarı.

Example: 20
​ProductSummary[]

Promosyonlu ürün nesnesi listesi

promotionalProductQuantity
​integer · min: 0

Promosyonlu ürün miktarı.

Example: 1
description
​string

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255
urlBlankStatus
​integer · enum
Enum values:
0
1
imageFile
​string · maxLength: 255
imageUrl
​string
attachment
​string · writeOnly
status
​integer · enum

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999999
freeShipping
​integer · enum

Ücretsiz kargo durumu.

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

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

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

Promosyon nesnesinin oluşturulma zamanı.

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

Promosyon nesnesinin güncellenme zamanı.

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

Promotion COUNT

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

Bu endpoint, mevcut kampanyaları (Promotions) listelemek, filtrelemek veya zaman aralığına göre arama yapmak için kullanılır. Listeleme işlemi, sayfalama (limit, page), sıralama (sort), tarih filtreleri (startDate, endDate) ve tip (type) parametreleriyle özelleştirilebilir.

Promotion COUNT › query Parameters

sort
​string

Sıralama parametresi. - Artan sıralama için: sort=id - Azalan sıralama için: sort=-id Birden fazla alanla sıralama yapmak için virgülle ayırabilirsiniz. Örnek: sort=-startDate,name

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek maksimum kampanya (promotion) sayısı. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

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

Default: 1
id
​integer · min: 1

Tek bir kampanyayı (promotion) döndürmek için kullanılır. Örnek: id=15

ids
​string

Birden fazla kampanyayı aynı anda getirmek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir. Özellikle sayfalama veya gerçek zamanlı güncelleme (incremental sync) senaryolarında kullanılır. Örnek: sinceId=100

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

Kampanyaların başlangıç tarihine göre filtreleme yapar. Format: YYYY-MM-DD Örnek: startDate=2025-01-01

type
​string · enum

Kampanya türüne göre filtreleme yapar. Olası değerler: - cart → Sepet bazlı kampanyalar - product → Ürün bazlı kampanyalar - category_and_brand → Kategori veya marka bazlı kampanyalar Örnek: type=cart

Enum values:
cart
product
category_and_brand
endDate
​string · date · pattern: yyyy-mm-dd

Kampanyaların bitiş tarihine göre filtreleme yapar. Format: YYYY-MM-DD Örnek: endDate=2025-12-31

q
​string

Alan bazlı detaylı arama filtresi. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Yılbaşı veya q[status]=active

s
​string

Genel arama anahtar kelimesiyle filtreleme yapar. Arama, sistemde tanımlı tüm metinsel alanlarda yapılır. Örnek: s=indirim

specialty
​string · enum

Specialty List

Enum values:
campaign

Promotion COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


Promotion GET

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

Promotion GET › path Parameters

id
​string · pattern: \d+ · required

Promotion GET › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Promosyon nesnesi kimlik değeri.

name
​string · maxLength: 255 · required

Promosyon adı.

Example: Sepette %20 İndirim
type
​string · enum

Promosyon tipi.

Enum values:
cart
product
category_and_brand
Example: cart
maxUsage
​integer · min: 0

Promosyonun maksimum kullanım sayısı.

Example: 1000
currentUsage
​integer · min: 0

Şu ana kadar toplam kullanım sayısı.

Example: 250
useDateFilter
​integer · enum

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

Enum values:
0
1
Example: 1
startDate
​string · date-time

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time
​MemberSummary[]

members

​MemberGroupSummary
minimumCheckoutLimit
​number · float

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

Example: 200
​CategorySummary

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

​CategorySummary[]
​BrandSummary

Marka objesi

​ProductSummary[]

Ana Ürünler

​PromotionPriceRangeSummary[] · minItems: 2 · maxItems: 5
minimumPurchaseQuantityOfMainProducts
​integer · min: 0

Ana ürün minimum satın alma zorunluluğu miktarı.

Example: 2
promotionValidityControl
​string · enum

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
promotionFeatureType
​string · enum

Promosyon özelliği tipi.

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

Promosyon özelliğine ait promosyon miktarı.

Example: 20
​ProductSummary[]

Promosyonlu ürün nesnesi listesi

promotionalProductQuantity
​integer · min: 0

Promosyonlu ürün miktarı.

Example: 1
description
​string

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255
urlBlankStatus
​integer · enum
Enum values:
0
1
imageFile
​string · maxLength: 255
imageUrl
​string
attachment
​string · writeOnly
status
​integer · enum

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999999
freeShipping
​integer · enum

Ücretsiz kargo durumu.

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

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

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

Promosyon nesnesinin oluşturulma zamanı.

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

Promosyon nesnesinin güncellenme zamanı.

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

Promotion PUT

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

Promotion PUT › path Parameters

id
​string · pattern: \d+ · required

Promotion PUT › Request Body

id
​integer · required

Promosyon nesnesi kimlik değeri.

name
​string · maxLength: 255 · required

Promosyon adı.

Example: Sepette %20 İndirim
type
​string · enum

Promosyon tipi.

Enum values:
cart
product
category_and_brand
Example: cart
maxUsage
​integer · min: 0

Promosyonun maksimum kullanım sayısı.

Example: 1000
currentUsage
​integer · min: 0

Şu ana kadar toplam kullanım sayısı.

Example: 250
useDateFilter
​integer · enum

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

Enum values:
0
1
Example: 1
startDate
​string · date-time

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time
​MemberSummary[]

members

​MemberGroupSummary
minimumCheckoutLimit
​number · float

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

Example: 200
​CategorySummary

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

​CategorySummary[]
​BrandSummary

Marka objesi

​ProductSummary[]

Ana Ürünler

​PromotionPriceRangeSummary[] · minItems: 2 · maxItems: 5
minimumPurchaseQuantityOfMainProducts
​integer · min: 0

Ana ürün minimum satın alma zorunluluğu miktarı.

Example: 2
promotionValidityControl
​string · enum

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
promotionFeatureType
​string · enum

Promosyon özelliği tipi.

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

Promosyon özelliğine ait promosyon miktarı.

Example: 20
​ProductSummary[]

Promosyonlu ürün nesnesi listesi

promotionalProductQuantity
​integer · min: 0

Promosyonlu ürün miktarı.

Example: 1
description
​string

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255
urlBlankStatus
​integer · enum
Enum values:
0
1
imageFile
​string · maxLength: 255
imageUrl
​string
attachment
​string · writeOnly
status
​integer · enum

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999999
freeShipping
​integer · enum

Ücretsiz kargo durumu.

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

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

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

Promosyon nesnesinin oluşturulma zamanı.

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

Promosyon nesnesinin güncellenme zamanı.

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

Promotion PUT › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Promosyon nesnesi kimlik değeri.

name
​string · maxLength: 255 · required

Promosyon adı.

Example: Sepette %20 İndirim
type
​string · enum

Promosyon tipi.

Enum values:
cart
product
category_and_brand
Example: cart
maxUsage
​integer · min: 0

Promosyonun maksimum kullanım sayısı.

Example: 1000
currentUsage
​integer · min: 0

Şu ana kadar toplam kullanım sayısı.

Example: 250
useDateFilter
​integer · enum

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

Enum values:
0
1
Example: 1
startDate
​string · date-time

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time
​MemberSummary[]

members

​MemberGroupSummary
minimumCheckoutLimit
​number · float

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

Example: 200
​CategorySummary

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

​CategorySummary[]
​BrandSummary

Marka objesi

​ProductSummary[]

Ana Ürünler

​PromotionPriceRangeSummary[] · minItems: 2 · maxItems: 5
minimumPurchaseQuantityOfMainProducts
​integer · min: 0

Ana ürün minimum satın alma zorunluluğu miktarı.

Example: 2
promotionValidityControl
​string · enum

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
promotionFeatureType
​string · enum

Promosyon özelliği tipi.

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

Promosyon özelliğine ait promosyon miktarı.

Example: 20
​ProductSummary[]

Promosyonlu ürün nesnesi listesi

promotionalProductQuantity
​integer · min: 0

Promosyonlu ürün miktarı.

Example: 1
description
​string

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255
urlBlankStatus
​integer · enum
Enum values:
0
1
imageFile
​string · maxLength: 255
imageUrl
​string
attachment
​string · writeOnly
status
​integer · enum

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999999
freeShipping
​integer · enum

Ücretsiz kargo durumu.

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

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

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

Promosyon nesnesinin oluşturulma zamanı.

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

Promosyon nesnesinin güncellenme zamanı.

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

Promotion DELETE

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

Promotion DELETE › path Parameters

id
​string · pattern: \d+ · required

Promotion DELETE › Responses

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

No data returned

Promotion EligibleAction COUNT

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

Bu endpoint, belirli bir sepet (cart), ürün (product), kategori (category) veya marka (brand) için geçerli olan kampanyaları listeler. Genellikle alışveriş sepeti veya ürün detay sayfalarında, hangi kampanyaların geçerli olduğunu kontrol etmek için kullanılır.

Promotion EligibleAction COUNT › query Parameters

cart
​integer · min: 1

Kampanyaların kontrol edileceği sepet kimliği (Cart ID). Örnek: cart=101

product
​integer · min: 1

Belirli bir ürün için uygun kampanyaları döndürür. Örnek: product=42

category
​integer · min: 1

Kategori bazlı kampanyaları kontrol eder. Örnek: category=5

brand
​integer · min: 1

Marka bazlı kampanyaları kontrol eder. Örnek: brand=12

Promotion EligibleAction COUNT › Responses

The request (GET or PUT) completed successfully.

No data returned

Promotion ApplyAction PUT

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

Promotion ApplyAction PUT › path Parameters

id
​string · pattern: \d+ · required

Promotion ApplyAction PUT › Request Body

id
​integer · required

Promosyon nesnesi kimlik değeri.

name
​string · maxLength: 255 · required

Promosyon adı.

Example: Sepette %20 İndirim
type
​string · enum

Promosyon tipi.

Enum values:
cart
product
category_and_brand
Example: cart
maxUsage
​integer · min: 0

Promosyonun maksimum kullanım sayısı.

Example: 1000
currentUsage
​integer · min: 0

Şu ana kadar toplam kullanım sayısı.

Example: 250
useDateFilter
​integer · enum

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

Enum values:
0
1
Example: 1
startDate
​string · date-time

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time
​MemberSummary[]

members

​MemberGroupSummary
minimumCheckoutLimit
​number · float

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

Example: 200
​CategorySummary

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

​CategorySummary[]
​BrandSummary

Marka objesi

​ProductSummary[]

Ana Ürünler

​PromotionPriceRangeSummary[] · minItems: 2 · maxItems: 5
minimumPurchaseQuantityOfMainProducts
​integer · min: 0

Ana ürün minimum satın alma zorunluluğu miktarı.

Example: 2
promotionValidityControl
​string · enum

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
promotionFeatureType
​string · enum

Promosyon özelliği tipi.

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

Promosyon özelliğine ait promosyon miktarı.

Example: 20
​ProductSummary[]

Promosyonlu ürün nesnesi listesi

promotionalProductQuantity
​integer · min: 0

Promosyonlu ürün miktarı.

Example: 1
description
​string

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255
urlBlankStatus
​integer · enum
Enum values:
0
1
imageFile
​string · maxLength: 255
imageUrl
​string
attachment
​string · writeOnly
status
​integer · enum

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999999
freeShipping
​integer · enum

Ücretsiz kargo durumu.

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

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

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

Promosyon nesnesinin oluşturulma zamanı.

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

Promosyon nesnesinin güncellenme zamanı.

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

Promotion ApplyAction PUT › Responses

The request (GET or PUT) completed successfully.

No data returned

Promotion UnapplyAction PUT

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

Promotion UnapplyAction PUT › path Parameters

id
​string · pattern: \d+ · required

Promotion UnapplyAction PUT › Request Body

id
​integer · required

Promosyon nesnesi kimlik değeri.

name
​string · maxLength: 255 · required

Promosyon adı.

Example: Sepette %20 İndirim
type
​string · enum

Promosyon tipi.

Enum values:
cart
product
category_and_brand
Example: cart
maxUsage
​integer · min: 0

Promosyonun maksimum kullanım sayısı.

Example: 1000
currentUsage
​integer · min: 0

Şu ana kadar toplam kullanım sayısı.

Example: 250
useDateFilter
​integer · enum

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

Enum values:
0
1
Example: 1
startDate
​string · date-time

Promosyon başlangıç tarihi.

Example: 2025-01-01T00:00:00+03:00
endDate
​string · date-time
​MemberSummary[]

members

​MemberGroupSummary
minimumCheckoutLimit
​number · float

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

Example: 200
​CategorySummary

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

​CategorySummary[]
​BrandSummary

Marka objesi

​ProductSummary[]

Ana Ürünler

​PromotionPriceRangeSummary[] · minItems: 2 · maxItems: 5
minimumPurchaseQuantityOfMainProducts
​integer · min: 0

Ana ürün minimum satın alma zorunluluğu miktarı.

Example: 2
promotionValidityControl
​string · enum

Promosyon geçerlilik kontrolü.

Enum values:
together
any
Example: together
promotionFeatureType
​string · enum

Promosyon özelliği tipi.

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

Promosyon özelliğine ait promosyon miktarı.

Example: 20
​ProductSummary[]

Promosyonlu ürün nesnesi listesi

promotionalProductQuantity
​integer · min: 0

Promosyonlu ürün miktarı.

Example: 1
description
​string

Promosyon açıklaması.

Example: Sepette %20 indirim fırsatı
url
​string · maxLength: 255
urlBlankStatus
​integer · enum
Enum values:
0
1
imageFile
​string · maxLength: 255
imageUrl
​string
attachment
​string · writeOnly
status
​integer · enum

Promosyon aktiflik durumu.

Enum values:
0
1
Example: 1
campaignPageStatus
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999999
freeShipping
​integer · enum

Ücretsiz kargo durumu.

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

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

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

Promosyon nesnesinin oluşturulma zamanı.

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

Promosyon nesnesinin güncellenme zamanı.

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

Promotion UnapplyAction PUT › Responses

The request (GET or PUT) completed successfully.

No data returned

Promotion ShowcaseSortOrderUpdateAction PUT

PUT
https://your-store.myideasoft.com
/admin-api/promotions/showcase_sort_order_update
Bearer
or
OAuth 2.0

Promotion ShowcaseSortOrderUpdateAction PUT › Responses

The request (GET or PUT) completed successfully.

No data returned

Promotion BulkUpdateAction PUT

PUT
https://your-store.myideasoft.com
/admin-api/promotions/bulk_update
Bearer
or
OAuth 2.0

Promotion BulkUpdateAction PUT › Responses

The request (GET or PUT) completed successfully.

No data returned