Promotion LIST
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.
query Parameters
sortSı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
limitSayfa başına döndürülecek maksimum kampanya (promotion) sayısı. Varsayılan: 20 Örnek: limit=50
pageListelenecek sayfa numarası. Varsayılan: 1 Örnek: page=2
idTek bir kampanyayı (promotion) döndürmek için kullanılır. Örnek: id=15
idsBirden fazla kampanyayı aynı anda getirmek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4
sinceIdBelirtilen 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
startDateyyyy-mm-ddKampanyaların başlangıç tarihine göre filtreleme yapar. Format: YYYY-MM-DD Örnek: startDate=2025-01-01
typeKampanya 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
endDateyyyy-mm-ddKampanyaların bitiş tarihine göre filtreleme yapar. Format: YYYY-MM-DD Örnek: endDate=2025-12-31
qAlan bazlı detaylı arama filtresi. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Yılbaşı veya q[status]=active
sGenel arama anahtar kelimesiyle filtreleme yapar. Arama, sistemde tanımlı tüm metinsel alanlarda yapılır. Örnek: s=indirim
specialtySpecialty List
Promotion LIST › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
idPromosyon nesnesi kimlik değeri.
namePromosyon adı.
typePromosyon tipi.
maxUsagePromosyonun maksimum kullanım sayısı.
currentUsageŞu ana kadar toplam kullanım sayısı.
useDateFilterTarih aralığı özelliği kullanılsın mı?
startDatePromosyon başlangıç tarihi.
endDatemembers
minimumCheckoutLimitKullanım alışveriş sınırı.
Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
Marka objesi
Ana Ürünler
minimumPurchaseQuantityOfMainProductsAna ürün minimum satın alma zorunluluğu miktarı.
promotionValidityControlPromosyon geçerlilik kontrolü.
promotionFeatureTypePromosyon özelliği tipi.
promotionFeatureValuePromosyon özelliğine ait promosyon miktarı.
Promosyonlu ürün nesnesi listesi
promotionalProductQuantityPromosyonlu ürün miktarı.
descriptionPromosyon açıklaması.
urlurlBlankStatusimageFileimageUrlattachmentstatusPromosyon aktiflik durumu.
campaignPageStatussortOrderfreeShippingÜcretsiz kargo durumu.
applyToDiscountProductİndirimli ürünlerde geçerli olsun mu?
createdAtPromosyon nesnesinin oluşturulma zamanı.
updatedAtPromosyon nesnesinin güncellenme zamanı.
Promotion POST
Promotion POST › Request Body
idPromosyon nesnesi kimlik değeri.
namePromosyon adı.
typePromosyon tipi.
maxUsagePromosyonun maksimum kullanım sayısı.
currentUsageŞu ana kadar toplam kullanım sayısı.
useDateFilterTarih aralığı özelliği kullanılsın mı?
startDatePromosyon başlangıç tarihi.
endDatemembers
minimumCheckoutLimitKullanım alışveriş sınırı.
Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
Marka objesi
Ana Ürünler
minimumPurchaseQuantityOfMainProductsAna ürün minimum satın alma zorunluluğu miktarı.
promotionValidityControlPromosyon geçerlilik kontrolü.
promotionFeatureTypePromosyon özelliği tipi.
promotionFeatureValuePromosyon özelliğine ait promosyon miktarı.
Promosyonlu ürün nesnesi listesi
promotionalProductQuantityPromosyonlu ürün miktarı.
descriptionPromosyon açıklaması.
urlurlBlankStatusimageFileimageUrlattachmentstatusPromosyon aktiflik durumu.
campaignPageStatussortOrderfreeShippingÜcretsiz kargo durumu.
applyToDiscountProductİndirimli ürünlerde geçerli olsun mu?
createdAtPromosyon nesnesinin oluşturulma zamanı.
updatedAtPromosyon nesnesinin güncellenme zamanı.
Promotion POST › Responses
Oluşturma işlemi (POST) başarı ile sonuçlandı.
idPromosyon nesnesi kimlik değeri.
namePromosyon adı.
typePromosyon tipi.
maxUsagePromosyonun maksimum kullanım sayısı.
currentUsageŞu ana kadar toplam kullanım sayısı.
useDateFilterTarih aralığı özelliği kullanılsın mı?
startDatePromosyon başlangıç tarihi.
endDatemembers
minimumCheckoutLimitKullanım alışveriş sınırı.
Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
Marka objesi
Ana Ürünler
minimumPurchaseQuantityOfMainProductsAna ürün minimum satın alma zorunluluğu miktarı.
promotionValidityControlPromosyon geçerlilik kontrolü.
promotionFeatureTypePromosyon özelliği tipi.
promotionFeatureValuePromosyon özelliğine ait promosyon miktarı.
Promosyonlu ürün nesnesi listesi
promotionalProductQuantityPromosyonlu ürün miktarı.
descriptionPromosyon açıklaması.
urlurlBlankStatusimageFileimageUrlattachmentstatusPromosyon aktiflik durumu.
campaignPageStatussortOrderfreeShippingÜcretsiz kargo durumu.
applyToDiscountProductİndirimli ürünlerde geçerli olsun mu?
createdAtPromosyon nesnesinin oluşturulma zamanı.
updatedAtPromosyon nesnesinin güncellenme zamanı.
Promotion COUNT
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.
query Parameters
sortSı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
limitSayfa başına döndürülecek maksimum kampanya (promotion) sayısı. Varsayılan: 20 Örnek: limit=50
pageListelenecek sayfa numarası. Varsayılan: 1 Örnek: page=2
idTek bir kampanyayı (promotion) döndürmek için kullanılır. Örnek: id=15
idsBirden fazla kampanyayı aynı anda getirmek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4
sinceIdBelirtilen 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
startDateyyyy-mm-ddKampanyaların başlangıç tarihine göre filtreleme yapar. Format: YYYY-MM-DD Örnek: startDate=2025-01-01
typeKampanya 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
endDateyyyy-mm-ddKampanyaların bitiş tarihine göre filtreleme yapar. Format: YYYY-MM-DD Örnek: endDate=2025-12-31
qAlan bazlı detaylı arama filtresi. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Yılbaşı veya q[status]=active
sGenel arama anahtar kelimesiyle filtreleme yapar. Arama, sistemde tanımlı tüm metinsel alanlarda yapılır. Örnek: s=indirim
specialtySpecialty List
Promotion COUNT › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
total_countFiltrelere uyan toplam kayıt sayısı.
Promotion GET
path Parameters
id\d+ · requiredPromotion GET › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
idPromosyon nesnesi kimlik değeri.
namePromosyon adı.
typePromosyon tipi.
maxUsagePromosyonun maksimum kullanım sayısı.
currentUsageŞu ana kadar toplam kullanım sayısı.
useDateFilterTarih aralığı özelliği kullanılsın mı?
startDatePromosyon başlangıç tarihi.
endDatemembers
minimumCheckoutLimitKullanım alışveriş sınırı.
Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
Marka objesi
Ana Ürünler
minimumPurchaseQuantityOfMainProductsAna ürün minimum satın alma zorunluluğu miktarı.
promotionValidityControlPromosyon geçerlilik kontrolü.
promotionFeatureTypePromosyon özelliği tipi.
promotionFeatureValuePromosyon özelliğine ait promosyon miktarı.
Promosyonlu ürün nesnesi listesi
promotionalProductQuantityPromosyonlu ürün miktarı.
descriptionPromosyon açıklaması.
urlurlBlankStatusimageFileimageUrlattachmentstatusPromosyon aktiflik durumu.
campaignPageStatussortOrderfreeShippingÜcretsiz kargo durumu.
applyToDiscountProductİndirimli ürünlerde geçerli olsun mu?
createdAtPromosyon nesnesinin oluşturulma zamanı.
updatedAtPromosyon nesnesinin güncellenme zamanı.
Promotion PUT
path Parameters
id\d+ · requiredPromotion PUT › Request Body
idPromosyon nesnesi kimlik değeri.
namePromosyon adı.
typePromosyon tipi.
maxUsagePromosyonun maksimum kullanım sayısı.
currentUsageŞu ana kadar toplam kullanım sayısı.
useDateFilterTarih aralığı özelliği kullanılsın mı?
startDatePromosyon başlangıç tarihi.
endDatemembers
minimumCheckoutLimitKullanım alışveriş sınırı.
Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
Marka objesi
Ana Ürünler
minimumPurchaseQuantityOfMainProductsAna ürün minimum satın alma zorunluluğu miktarı.
promotionValidityControlPromosyon geçerlilik kontrolü.
promotionFeatureTypePromosyon özelliği tipi.
promotionFeatureValuePromosyon özelliğine ait promosyon miktarı.
Promosyonlu ürün nesnesi listesi
promotionalProductQuantityPromosyonlu ürün miktarı.
descriptionPromosyon açıklaması.
urlurlBlankStatusimageFileimageUrlattachmentstatusPromosyon aktiflik durumu.
campaignPageStatussortOrderfreeShippingÜcretsiz kargo durumu.
applyToDiscountProductİndirimli ürünlerde geçerli olsun mu?
createdAtPromosyon nesnesinin oluşturulma zamanı.
updatedAtPromosyon nesnesinin güncellenme zamanı.
Promotion PUT › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
idPromosyon nesnesi kimlik değeri.
namePromosyon adı.
typePromosyon tipi.
maxUsagePromosyonun maksimum kullanım sayısı.
currentUsageŞu ana kadar toplam kullanım sayısı.
useDateFilterTarih aralığı özelliği kullanılsın mı?
startDatePromosyon başlangıç tarihi.
endDatemembers
minimumCheckoutLimitKullanım alışveriş sınırı.
Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
Marka objesi
Ana Ürünler
minimumPurchaseQuantityOfMainProductsAna ürün minimum satın alma zorunluluğu miktarı.
promotionValidityControlPromosyon geçerlilik kontrolü.
promotionFeatureTypePromosyon özelliği tipi.
promotionFeatureValuePromosyon özelliğine ait promosyon miktarı.
Promosyonlu ürün nesnesi listesi
promotionalProductQuantityPromosyonlu ürün miktarı.
descriptionPromosyon açıklaması.
urlurlBlankStatusimageFileimageUrlattachmentstatusPromosyon aktiflik durumu.
campaignPageStatussortOrderfreeShippingÜcretsiz kargo durumu.
applyToDiscountProductİndirimli ürünlerde geçerli olsun mu?
createdAtPromosyon nesnesinin oluşturulma zamanı.
updatedAtPromosyon nesnesinin güncellenme zamanı.
Promotion EligibleAction COUNT
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.
query Parameters
cartKampanyaların kontrol edileceği sepet kimliği (Cart ID). Örnek: cart=101
productBelirli bir ürün için uygun kampanyaları döndürür. Örnek: product=42
categoryKategori bazlı kampanyaları kontrol eder. Örnek: category=5
brandMarka bazlı kampanyaları kontrol eder. Örnek: brand=12
Promotion EligibleAction COUNT › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
Promotion ApplyAction PUT
path Parameters
id\d+ · requiredPromotion ApplyAction PUT › Request Body
idPromosyon nesnesi kimlik değeri.
namePromosyon adı.
typePromosyon tipi.
maxUsagePromosyonun maksimum kullanım sayısı.
currentUsageŞu ana kadar toplam kullanım sayısı.
useDateFilterTarih aralığı özelliği kullanılsın mı?
startDatePromosyon başlangıç tarihi.
endDatemembers
minimumCheckoutLimitKullanım alışveriş sınırı.
Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
Marka objesi
Ana Ürünler
minimumPurchaseQuantityOfMainProductsAna ürün minimum satın alma zorunluluğu miktarı.
promotionValidityControlPromosyon geçerlilik kontrolü.
promotionFeatureTypePromosyon özelliği tipi.
promotionFeatureValuePromosyon özelliğine ait promosyon miktarı.
Promosyonlu ürün nesnesi listesi
promotionalProductQuantityPromosyonlu ürün miktarı.
descriptionPromosyon açıklaması.
urlurlBlankStatusimageFileimageUrlattachmentstatusPromosyon aktiflik durumu.
campaignPageStatussortOrderfreeShippingÜcretsiz kargo durumu.
applyToDiscountProductİndirimli ürünlerde geçerli olsun mu?
createdAtPromosyon nesnesinin oluşturulma zamanı.
updatedAtPromosyon nesnesinin güncellenme zamanı.
Promotion ApplyAction PUT › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
Promotion UnapplyAction PUT
path Parameters
id\d+ · requiredPromotion UnapplyAction PUT › Request Body
idPromosyon nesnesi kimlik değeri.
namePromosyon adı.
typePromosyon tipi.
maxUsagePromosyonun maksimum kullanım sayısı.
currentUsageŞu ana kadar toplam kullanım sayısı.
useDateFilterTarih aralığı özelliği kullanılsın mı?
startDatePromosyon başlangıç tarihi.
endDatemembers
minimumCheckoutLimitKullanım alışveriş sınırı.
Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.
Marka objesi
Ana Ürünler
minimumPurchaseQuantityOfMainProductsAna ürün minimum satın alma zorunluluğu miktarı.
promotionValidityControlPromosyon geçerlilik kontrolü.
promotionFeatureTypePromosyon özelliği tipi.
promotionFeatureValuePromosyon özelliğine ait promosyon miktarı.
Promosyonlu ürün nesnesi listesi
promotionalProductQuantityPromosyonlu ürün miktarı.
descriptionPromosyon açıklaması.
urlurlBlankStatusimageFileimageUrlattachmentstatusPromosyon aktiflik durumu.
campaignPageStatussortOrderfreeShippingÜcretsiz kargo durumu.
applyToDiscountProductİndirimli ürünlerde geçerli olsun mu?
createdAtPromosyon nesnesinin oluşturulma zamanı.
updatedAtPromosyon nesnesinin güncellenme zamanı.
Promotion UnapplyAction PUT › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.