İçeriğe geç
Admin API

Coupon

Serverhttps://magaza-adiniz.myideasoft.com

Coupon LIST

GET
https://magaza-adiniz.myideasoft.com
/admin-api/coupons
Bearer
or
OAuth 2.0

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.

Coupon LIST › query Parameters

sort
​string

Sonuç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.

limit
​integer · min: 1 · max: 100

Bir sayfada döndürülecek maksimum kayıt adedi.

Default: 20
page
​integer · min: 1

Getirilecek sonuçların sayfa numarası.

Default: 1
creatorType
​string

Kuponu oluşturan varlık tipine göre filtreleme yapar.

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

Kuponun geçerlilik başlangıç tarihi (startDate) için minimum tarih filtresi.

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

Kuponun geçerlilik bitiş tarihi (endDate) için maksimum tarih filtresi.

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

Oluşturulma tarihi (createdAt) için başlangıç zamanı.

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

Oluşturulma tarihi (createdAt) için bitiş zamanı.

status
​string · enum

Kuponun aktiflik/kullanım durumuna göre filtreleme yapar. Seçenekler: | 0: Kupon Pasif/Kullanılamaz. | 1: Kupon Aktif/Kullanılabilir.

Enum values:
0
1
valueType
​string · enum

Coupon value type search filter.

Enum values:
0
1
id
​integer · min: 1

Tek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).

ids
​string

Çoklu listeleme için virgülle ayrılmış benzersiz kimlik değerleri (IDs) listesi.

sinceId
​integer · min: 1

Belirtilen ID değerinden daha büyük ID'ye sahip (sonraki) kayıtları getirir.

q
​string

Gelişmiş Filtreleme (Query Filter). Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>

s
​string

Arama 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ı.

id
​integer · required

Hediye çeki nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Hediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.

Example: TESTKUPON123
currentUsage
​integer · min: 0

Hediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.

Example: 10
maxUsage
​integer · min: 1

Hediye çekinin toplam kullanım limiti.

Example: 100
maxUsagePerMember
​integer · min: 1

Bir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.

Example: 5
startDate
​string · date-time

Hediye çekinin geçerli olmaya başladığı tarih.

Example: 2015-04-16T00:00:00+03:00
endDate
​string · date-time

Hediye çekinin geçerlilik bitiş tarihi.

Example: 2015-05-16T00:00:00+03:00
​CreatorSummary

Nesneyi oluşturan kullanıcıyı temsil eder.

minimumCheckoutLimit
​number · float

Kuponun kullanılabilmesi için gereken minimum sepet tutarı.

Example: 100
minimumCheckoutLimitTaxIncluded
​integer · enum

Minimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
discountType
​string · enum

Kupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.

Enum values:
fixed
percentage
Example: percentage
discountValue
​number · float

Kuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)

Example: 20
discountTaxIncluded
​integer · enum

İndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
filterType
​string · enum

Kuponun 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.

Enum values:
all
product
category
brand
member
Example: category
​ProductSummary[]

Kuponun geçerli olduğu ürün nesneleri.

​CategorySummary[]

Kuponun geçerli olduğu kategori nesneleri.

Kuponun geçerli olduğu marka nesneleri.

​MemberSummary[]

Kuponun geçerli olduğu üye nesneleri.

​MemberGroupSummary
status
​integer · enum

Hediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Kuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
useDiscountedProducts
​integer · enum

Kuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
filterValidityType
​integer · enum

Kupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.

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

Hediye çekinin oluşturulma zamanı.

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

Hediye çekinin son güncellenme zamanı.

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

Coupon POST

POST
https://magaza-adiniz.myideasoft.com
/admin-api/coupons
Bearer
or
OAuth 2.0

Coupon POST › Request Body

id
​integer · required

Hediye çeki nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Hediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.

Example: TESTKUPON123
currentUsage
​integer · min: 0

Hediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.

Example: 10
maxUsage
​integer · min: 1

Hediye çekinin toplam kullanım limiti.

Example: 100
maxUsagePerMember
​integer · min: 1

Bir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.

Example: 5
startDate
​string · date-time

Hediye çekinin geçerli olmaya başladığı tarih.

Example: 2015-04-16T00:00:00+03:00
endDate
​string · date-time

Hediye çekinin geçerlilik bitiş tarihi.

Example: 2015-05-16T00:00:00+03:00
​CreatorSummary

Nesneyi oluşturan kullanıcıyı temsil eder.

minimumCheckoutLimit
​number · float

Kuponun kullanılabilmesi için gereken minimum sepet tutarı.

Example: 100
minimumCheckoutLimitTaxIncluded
​integer · enum

Minimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
discountType
​string · enum

Kupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.

Enum values:
fixed
percentage
Example: percentage
discountValue
​number · float

Kuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)

Example: 20
discountTaxIncluded
​integer · enum

İndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
filterType
​string · enum

Kuponun 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.

Enum values:
all
product
category
brand
member
Example: category
​ProductSummary[]

Kuponun geçerli olduğu ürün nesneleri.

​CategorySummary[]

Kuponun geçerli olduğu kategori nesneleri.

Kuponun geçerli olduğu marka nesneleri.

​MemberSummary[]

Kuponun geçerli olduğu üye nesneleri.

​MemberGroupSummary
status
​integer · enum

Hediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Kuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
useDiscountedProducts
​integer · enum

Kuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
filterValidityType
​integer · enum

Kupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.

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

Hediye çekinin oluşturulma zamanı.

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

Hediye çekinin son güncellenme zamanı.

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

Coupon POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

id
​integer · required

Hediye çeki nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Hediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.

Example: TESTKUPON123
currentUsage
​integer · min: 0

Hediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.

Example: 10
maxUsage
​integer · min: 1

Hediye çekinin toplam kullanım limiti.

Example: 100
maxUsagePerMember
​integer · min: 1

Bir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.

Example: 5
startDate
​string · date-time

Hediye çekinin geçerli olmaya başladığı tarih.

Example: 2015-04-16T00:00:00+03:00
endDate
​string · date-time

Hediye çekinin geçerlilik bitiş tarihi.

Example: 2015-05-16T00:00:00+03:00
​CreatorSummary

Nesneyi oluşturan kullanıcıyı temsil eder.

minimumCheckoutLimit
​number · float

Kuponun kullanılabilmesi için gereken minimum sepet tutarı.

Example: 100
minimumCheckoutLimitTaxIncluded
​integer · enum

Minimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
discountType
​string · enum

Kupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.

Enum values:
fixed
percentage
Example: percentage
discountValue
​number · float

Kuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)

Example: 20
discountTaxIncluded
​integer · enum

İndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
filterType
​string · enum

Kuponun 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.

Enum values:
all
product
category
brand
member
Example: category
​ProductSummary[]

Kuponun geçerli olduğu ürün nesneleri.

​CategorySummary[]

Kuponun geçerli olduğu kategori nesneleri.

Kuponun geçerli olduğu marka nesneleri.

​MemberSummary[]

Kuponun geçerli olduğu üye nesneleri.

​MemberGroupSummary
status
​integer · enum

Hediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Kuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
useDiscountedProducts
​integer · enum

Kuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
filterValidityType
​integer · enum

Kupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.

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

Hediye çekinin oluşturulma zamanı.

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

Hediye çekinin son güncellenme zamanı.

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

Coupon COUNT

GET
https://magaza-adiniz.myideasoft.com
/admin-api/coupons/count
Bearer
or
OAuth 2.0

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.

Coupon COUNT › query Parameters

sort
​string

Sonuç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.

limit
​integer · min: 1 · max: 100

Bir sayfada döndürülecek maksimum kayıt adedi.

Default: 20
page
​integer · min: 1

Getirilecek sonuçların sayfa numarası.

Default: 1
creatorType
​string

Kuponu oluşturan varlık tipine göre filtreleme yapar.

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

Kuponun geçerlilik başlangıç tarihi (startDate) için minimum tarih filtresi.

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

Kuponun geçerlilik bitiş tarihi (endDate) için maksimum tarih filtresi.

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

Oluşturulma tarihi (createdAt) için başlangıç zamanı.

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

Oluşturulma tarihi (createdAt) için bitiş zamanı.

status
​string · enum

Kuponun aktiflik/kullanım durumuna göre filtreleme yapar. Seçenekler: | 0: Kupon Pasif/Kullanılamaz. | 1: Kupon Aktif/Kullanılabilir.

Enum values:
0
1
valueType
​string · enum

Coupon value type search filter.

Enum values:
0
1
id
​integer · min: 1

Tek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).

ids
​string

Çoklu listeleme için virgülle ayrılmış benzersiz kimlik değerleri (IDs) listesi.

sinceId
​integer · min: 1

Belirtilen ID değerinden daha büyük ID'ye sahip (sonraki) kayıtları getirir.

q
​string

Gelişmiş Filtreleme (Query Filter). Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>

s
​string

Arama 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ı.

Kayıt sayısı yanıtı.
total_count
​integer · required

Filtrelere uyan toplam kayıt sayısı.


Coupon GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/coupons/{id}
Bearer
or
OAuth 2.0

Coupon GET › path Parameters

id
​string · pattern: \d+ · required

Coupon GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer · required

Hediye çeki nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Hediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.

Example: TESTKUPON123
currentUsage
​integer · min: 0

Hediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.

Example: 10
maxUsage
​integer · min: 1

Hediye çekinin toplam kullanım limiti.

Example: 100
maxUsagePerMember
​integer · min: 1

Bir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.

Example: 5
startDate
​string · date-time

Hediye çekinin geçerli olmaya başladığı tarih.

Example: 2015-04-16T00:00:00+03:00
endDate
​string · date-time

Hediye çekinin geçerlilik bitiş tarihi.

Example: 2015-05-16T00:00:00+03:00
​CreatorSummary

Nesneyi oluşturan kullanıcıyı temsil eder.

minimumCheckoutLimit
​number · float

Kuponun kullanılabilmesi için gereken minimum sepet tutarı.

Example: 100
minimumCheckoutLimitTaxIncluded
​integer · enum

Minimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
discountType
​string · enum

Kupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.

Enum values:
fixed
percentage
Example: percentage
discountValue
​number · float

Kuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)

Example: 20
discountTaxIncluded
​integer · enum

İndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
filterType
​string · enum

Kuponun 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.

Enum values:
all
product
category
brand
member
Example: category
​ProductSummary[]

Kuponun geçerli olduğu ürün nesneleri.

​CategorySummary[]

Kuponun geçerli olduğu kategori nesneleri.

Kuponun geçerli olduğu marka nesneleri.

​MemberSummary[]

Kuponun geçerli olduğu üye nesneleri.

​MemberGroupSummary
status
​integer · enum

Hediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Kuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
useDiscountedProducts
​integer · enum

Kuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
filterValidityType
​integer · enum

Kupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.

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

Hediye çekinin oluşturulma zamanı.

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

Hediye çekinin son güncellenme zamanı.

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

Coupon PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/coupons/{id}
Bearer
or
OAuth 2.0

Coupon PUT › path Parameters

id
​string · pattern: \d+ · required

Coupon PUT › Request Body

id
​integer · required

Hediye çeki nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Hediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.

Example: TESTKUPON123
currentUsage
​integer · min: 0

Hediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.

Example: 10
maxUsage
​integer · min: 1

Hediye çekinin toplam kullanım limiti.

Example: 100
maxUsagePerMember
​integer · min: 1

Bir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.

Example: 5
startDate
​string · date-time

Hediye çekinin geçerli olmaya başladığı tarih.

Example: 2015-04-16T00:00:00+03:00
endDate
​string · date-time

Hediye çekinin geçerlilik bitiş tarihi.

Example: 2015-05-16T00:00:00+03:00
​CreatorSummary

Nesneyi oluşturan kullanıcıyı temsil eder.

minimumCheckoutLimit
​number · float

Kuponun kullanılabilmesi için gereken minimum sepet tutarı.

Example: 100
minimumCheckoutLimitTaxIncluded
​integer · enum

Minimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
discountType
​string · enum

Kupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.

Enum values:
fixed
percentage
Example: percentage
discountValue
​number · float

Kuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)

Example: 20
discountTaxIncluded
​integer · enum

İndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
filterType
​string · enum

Kuponun 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.

Enum values:
all
product
category
brand
member
Example: category
​ProductSummary[]

Kuponun geçerli olduğu ürün nesneleri.

​CategorySummary[]

Kuponun geçerli olduğu kategori nesneleri.

Kuponun geçerli olduğu marka nesneleri.

​MemberSummary[]

Kuponun geçerli olduğu üye nesneleri.

​MemberGroupSummary
status
​integer · enum

Hediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Kuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
useDiscountedProducts
​integer · enum

Kuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
filterValidityType
​integer · enum

Kupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.

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

Hediye çekinin oluşturulma zamanı.

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

Hediye çekinin son güncellenme zamanı.

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

Coupon PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer · required

Hediye çeki nesnesinin benzersiz kimlik değeri.

Example: 123
code
​string · maxLength: 255 · required

Hediye çeki kodu. Minimum 4, maksimum 50 karakter olmalıdır.

Example: TESTKUPON123
currentUsage
​integer · min: 0

Hediye çekinin şu ana kadar kaç kez kullanıldığını gösterir.

Example: 10
maxUsage
​integer · min: 1

Hediye çekinin toplam kullanım limiti.

Example: 100
maxUsagePerMember
​integer · min: 1

Bir üyenin kuponu en fazla kaç kez kullanabileceğini belirtir.

Example: 5
startDate
​string · date-time

Hediye çekinin geçerli olmaya başladığı tarih.

Example: 2015-04-16T00:00:00+03:00
endDate
​string · date-time

Hediye çekinin geçerlilik bitiş tarihi.

Example: 2015-05-16T00:00:00+03:00
​CreatorSummary

Nesneyi oluşturan kullanıcıyı temsil eder.

minimumCheckoutLimit
​number · float

Kuponun kullanılabilmesi için gereken minimum sepet tutarı.

Example: 100
minimumCheckoutLimitTaxIncluded
​integer · enum

Minimum sepet tutarının KDV dahil hesaplanıp hesaplanmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
discountType
​string · enum

Kupon indirim tipini belirtir. Seçenekler: | fixed: Sabit tutar indirimi. | percentage: Yüzdesel indirim.

Enum values:
fixed
percentage
Example: percentage
discountValue
​number · float

Kuponun indirim miktarı. (Sabit tutar ya da yüzdeye göre değişir)

Example: 20
discountTaxIncluded
​integer · enum

İndirim miktarının KDV dahil olup olmadığını belirtir. Seçenekler: | 0: KDV hariç. | 1: KDV dahil.

Enum values:
0
1
filterType
​string · enum

Kuponun 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.

Enum values:
all
product
category
brand
member
Example: category
​ProductSummary[]

Kuponun geçerli olduğu ürün nesneleri.

​CategorySummary[]

Kuponun geçerli olduğu kategori nesneleri.

Kuponun geçerli olduğu marka nesneleri.

​MemberSummary[]

Kuponun geçerli olduğu üye nesneleri.

​MemberGroupSummary
status
​integer · enum

Hediye çekinin aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Kuponun ücretsiz kargo sağlayıp sağlamadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
useDiscountedProducts
​integer · enum

Kuponun indirimli ürünlerde kullanılıp kullanılamayacağını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
filterValidityType
​integer · enum

Kupon geçerlilik doğrulama tipi. Seçenekler: | 0: Hayır. | 1: Evet.

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

Hediye çekinin oluşturulma zamanı.

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

Hediye çekinin son güncellenme zamanı.

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

Coupon DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/admin-api/coupons/{id}
Bearer
or
OAuth 2.0

Coupon DELETE › path Parameters

id
​string · pattern: \d+ · required

Coupon DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned