Coupon LIST
Tüm Kupon (Coupon) nesnelerini filtreleyerek ve sayfalandırarak listeler. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.
query Parameters
sortSonuçların hangi alana göre sıralanacağını belirler. Artan (ascending) sıralama için alan adını (id), azalan (descending) sıralama için ise başına eksi işareti (-) ekleyin.
limitBir sayfada döndürülecek maksimum kayıt adedi.
pageGetirilecek sonuçların sayfa numarası.
creatorTypeKuponu oluşturan varlık tipine göre filtreleme yapar.
startDateyyyy-mm-ddKuponun geçerlilik başlangıç tarihi (startDate) için minimum tarih filtresi.
endDateyyyy-mm-ddKuponun geçerlilik bitiş tarihi (endDate) için maksimum tarih filtresi.
startCreatedAtyyyy-mm-ddOluşturulma tarihi (createdAt) için başlangıç zamanı.
endCreatedAtyyyy-mm-ddOluşturulma tarihi (createdAt) için bitiş zamanı.
statusKuponun aktiflik/kullanım durumuna göre filtreleme yapar. Seçenekler: | 0: Kupon Pasif/Kullanılamaz. | 1: Kupon Aktif/Kullanılabilir.
valueTypeCoupon value type search filter.
idTek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).
idsÇoklu listeleme için virgülle ayrılmış benzersiz kimlik değerleri (IDs) listesi.
sinceIdBelirtilen ID değerinden daha büyük ID'ye sahip (sonraki) kayıtları getirir.
qGelişmiş Filtreleme (Query Filter). Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>
sArama Anahtarı Filtresi (Search Keyword). Kupon kodu veya adında genel arama yapmak için kullanılır.
Coupon LIST › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
idHediye çeki nesnesinin benzersiz kimlik değeri.
codeHediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.
currentUsageHediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.
maxUsageHediye çekinin toplam kullanım limiti.
maxUsagePerMemberBir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.
startDateHediye çekinin geçerli olmaya başladığı tarih.
endDateHediye çekinin geçerlilik bitiş tarihi.
Nesneyi oluşturan kullanıcıyı temsil eder.
minimumCheckoutLimitKuponun kullanılabilmesi için gereken minimum sepet tutarı.
minimumCheckoutLimitTaxIncludedMinimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
discountTypeKupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.
discountValueKuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)
discountTaxIncludedİndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
filterTypeKuponun hangi ürün/kategori/marka/üyelerde geçerli olacağını belirtir. Seçenekler: | all: Tüm kategori ve markalarda geçerli. | product: Belirli ürünlerde geçerli. | category: Belirli kategorilerde geçerli. | brand: Belirli markalarda geçerli. | member: Belirli üyelere özel.
Kuponun geçerli olduğu ürün nesneleri.
Kuponun geçerli olduğu kategori nesneleri.
Kuponun geçerli olduğu marka nesneleri.
Kuponun geçerli olduğu üye nesneleri.
statusHediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
cargoFreeKuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
useDiscountedProductsKuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
filterValidityTypeKupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.
couponWithoutMembershipcreatedAtHediye çekinin oluşturulma zamanı.
updatedAtHediye çekinin son güncellenme zamanı.
Coupon POST
Coupon POST › Request Body
idHediye çeki nesnesinin benzersiz kimlik değeri.
codeHediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.
currentUsageHediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.
maxUsageHediye çekinin toplam kullanım limiti.
maxUsagePerMemberBir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.
startDateHediye çekinin geçerli olmaya başladığı tarih.
endDateHediye çekinin geçerlilik bitiş tarihi.
Nesneyi oluşturan kullanıcıyı temsil eder.
minimumCheckoutLimitKuponun kullanılabilmesi için gereken minimum sepet tutarı.
minimumCheckoutLimitTaxIncludedMinimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
discountTypeKupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.
discountValueKuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)
discountTaxIncludedİndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
filterTypeKuponun hangi ürün/kategori/marka/üyelerde geçerli olacağını belirtir. Seçenekler: | all: Tüm kategori ve markalarda geçerli. | product: Belirli ürünlerde geçerli. | category: Belirli kategorilerde geçerli. | brand: Belirli markalarda geçerli. | member: Belirli üyelere özel.
Kuponun geçerli olduğu ürün nesneleri.
Kuponun geçerli olduğu kategori nesneleri.
Kuponun geçerli olduğu marka nesneleri.
Kuponun geçerli olduğu üye nesneleri.
statusHediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
cargoFreeKuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
useDiscountedProductsKuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
filterValidityTypeKupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.
couponWithoutMembershipcreatedAtHediye çekinin oluşturulma zamanı.
updatedAtHediye çekinin son güncellenme zamanı.
Coupon POST › Responses
Oluşturma işlemi (POST) başarı ile sonuçlandı.
idHediye çeki nesnesinin benzersiz kimlik değeri.
codeHediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.
currentUsageHediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.
maxUsageHediye çekinin toplam kullanım limiti.
maxUsagePerMemberBir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.
startDateHediye çekinin geçerli olmaya başladığı tarih.
endDateHediye çekinin geçerlilik bitiş tarihi.
Nesneyi oluşturan kullanıcıyı temsil eder.
minimumCheckoutLimitKuponun kullanılabilmesi için gereken minimum sepet tutarı.
minimumCheckoutLimitTaxIncludedMinimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
discountTypeKupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.
discountValueKuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)
discountTaxIncludedİndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
filterTypeKuponun hangi ürün/kategori/marka/üyelerde geçerli olacağını belirtir. Seçenekler: | all: Tüm kategori ve markalarda geçerli. | product: Belirli ürünlerde geçerli. | category: Belirli kategorilerde geçerli. | brand: Belirli markalarda geçerli. | member: Belirli üyelere özel.
Kuponun geçerli olduğu ürün nesneleri.
Kuponun geçerli olduğu kategori nesneleri.
Kuponun geçerli olduğu marka nesneleri.
Kuponun geçerli olduğu üye nesneleri.
statusHediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
cargoFreeKuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
useDiscountedProductsKuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
filterValidityTypeKupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.
couponWithoutMembershipcreatedAtHediye çekinin oluşturulma zamanı.
updatedAtHediye çekinin son güncellenme zamanı.
Coupon COUNT
Tüm Kupon (Coupon) nesnelerini filtreleyerek ve sayfalandırarak listeler. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.
query Parameters
sortSonuçların hangi alana göre sıralanacağını belirler. Artan (ascending) sıralama için alan adını (id), azalan (descending) sıralama için ise başına eksi işareti (-) ekleyin.
limitBir sayfada döndürülecek maksimum kayıt adedi.
pageGetirilecek sonuçların sayfa numarası.
creatorTypeKuponu oluşturan varlık tipine göre filtreleme yapar.
startDateyyyy-mm-ddKuponun geçerlilik başlangıç tarihi (startDate) için minimum tarih filtresi.
endDateyyyy-mm-ddKuponun geçerlilik bitiş tarihi (endDate) için maksimum tarih filtresi.
startCreatedAtyyyy-mm-ddOluşturulma tarihi (createdAt) için başlangıç zamanı.
endCreatedAtyyyy-mm-ddOluşturulma tarihi (createdAt) için bitiş zamanı.
statusKuponun aktiflik/kullanım durumuna göre filtreleme yapar. Seçenekler: | 0: Kupon Pasif/Kullanılamaz. | 1: Kupon Aktif/Kullanılabilir.
valueTypeCoupon value type search filter.
idTek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).
idsÇoklu listeleme için virgülle ayrılmış benzersiz kimlik değerleri (IDs) listesi.
sinceIdBelirtilen ID değerinden daha büyük ID'ye sahip (sonraki) kayıtları getirir.
qGelişmiş Filtreleme (Query Filter). Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>
sArama Anahtarı Filtresi (Search Keyword). Kupon kodu veya adında genel arama yapmak için kullanılır.
Coupon COUNT › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
total_countFiltrelere uyan toplam kayıt sayısı.
Coupon GET
path Parameters
id\d+ · requiredCoupon GET › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
idHediye çeki nesnesinin benzersiz kimlik değeri.
codeHediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.
currentUsageHediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.
maxUsageHediye çekinin toplam kullanım limiti.
maxUsagePerMemberBir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.
startDateHediye çekinin geçerli olmaya başladığı tarih.
endDateHediye çekinin geçerlilik bitiş tarihi.
Nesneyi oluşturan kullanıcıyı temsil eder.
minimumCheckoutLimitKuponun kullanılabilmesi için gereken minimum sepet tutarı.
minimumCheckoutLimitTaxIncludedMinimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
discountTypeKupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.
discountValueKuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)
discountTaxIncludedİndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
filterTypeKuponun hangi ürün/kategori/marka/üyelerde geçerli olacağını belirtir. Seçenekler: | all: Tüm kategori ve markalarda geçerli. | product: Belirli ürünlerde geçerli. | category: Belirli kategorilerde geçerli. | brand: Belirli markalarda geçerli. | member: Belirli üyelere özel.
Kuponun geçerli olduğu ürün nesneleri.
Kuponun geçerli olduğu kategori nesneleri.
Kuponun geçerli olduğu marka nesneleri.
Kuponun geçerli olduğu üye nesneleri.
statusHediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
cargoFreeKuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
useDiscountedProductsKuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
filterValidityTypeKupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.
couponWithoutMembershipcreatedAtHediye çekinin oluşturulma zamanı.
updatedAtHediye çekinin son güncellenme zamanı.
Coupon PUT
path Parameters
id\d+ · requiredCoupon PUT › Request Body
idHediye çeki nesnesinin benzersiz kimlik değeri.
codeHediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.
currentUsageHediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.
maxUsageHediye çekinin toplam kullanım limiti.
maxUsagePerMemberBir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.
startDateHediye çekinin geçerli olmaya başladığı tarih.
endDateHediye çekinin geçerlilik bitiş tarihi.
Nesneyi oluşturan kullanıcıyı temsil eder.
minimumCheckoutLimitKuponun kullanılabilmesi için gereken minimum sepet tutarı.
minimumCheckoutLimitTaxIncludedMinimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
discountTypeKupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.
discountValueKuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)
discountTaxIncludedİndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
filterTypeKuponun hangi ürün/kategori/marka/üyelerde geçerli olacağını belirtir. Seçenekler: | all: Tüm kategori ve markalarda geçerli. | product: Belirli ürünlerde geçerli. | category: Belirli kategorilerde geçerli. | brand: Belirli markalarda geçerli. | member: Belirli üyelere özel.
Kuponun geçerli olduğu ürün nesneleri.
Kuponun geçerli olduğu kategori nesneleri.
Kuponun geçerli olduğu marka nesneleri.
Kuponun geçerli olduğu üye nesneleri.
statusHediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
cargoFreeKuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
useDiscountedProductsKuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
filterValidityTypeKupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.
couponWithoutMembershipcreatedAtHediye çekinin oluşturulma zamanı.
updatedAtHediye çekinin son güncellenme zamanı.
Coupon PUT › Responses
İşlem (GET veya PUT) başarı ile sonuçlandı.
idHediye çeki nesnesinin benzersiz kimlik değeri.
codeHediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.
currentUsageHediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.
maxUsageHediye çekinin toplam kullanım limiti.
maxUsagePerMemberBir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.
startDateHediye çekinin geçerli olmaya başladığı tarih.
endDateHediye çekinin geçerlilik bitiş tarihi.
Nesneyi oluşturan kullanıcıyı temsil eder.
minimumCheckoutLimitKuponun kullanılabilmesi için gereken minimum sepet tutarı.
minimumCheckoutLimitTaxIncludedMinimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
discountTypeKupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.
discountValueKuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)
discountTaxIncludedİndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.
filterTypeKuponun hangi ürün/kategori/marka/üyelerde geçerli olacağını belirtir. Seçenekler: | all: Tüm kategori ve markalarda geçerli. | product: Belirli ürünlerde geçerli. | category: Belirli kategorilerde geçerli. | brand: Belirli markalarda geçerli. | member: Belirli üyelere özel.
Kuponun geçerli olduğu ürün nesneleri.
Kuponun geçerli olduğu kategori nesneleri.
Kuponun geçerli olduğu marka nesneleri.
Kuponun geçerli olduğu üye nesneleri.
statusHediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.
cargoFreeKuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
useDiscountedProductsKuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.
filterValidityTypeKupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.
couponWithoutMembershipcreatedAtHediye çekinin oluşturulma zamanı.
updatedAtHediye çekinin son güncellenme zamanı.