Contract LIST
Bu endpoint, sistemdeki tüm abonelik sözleşmesi (Contract) 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ı.
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.
subscriptionBelirli bir Abonelik ID'sine (Subscription ID) göre filtreleme yapar.
productIdAboneliğin ilişkili olduğu Ürün ID'sine göre filtreleme yapar.
emailAboneliğin ilişkili olduğu üyenin e-posta adresine göre filtreleme yapar.
periodFrequencyAboneliğin periyot sıklığına göre filtreleme yapar.
paymentProviderAboneliğin bağlı olduğu ödeme sağlayıcısına (Payment Provider) göre filtreleme yapar.
sArama Anahtarı Filtresi (Search Keyword). Aboneliğin adında veya ilgili alanlarda genel arama yapmak için kullanılır.
Contract LIST › Responses
The request (GET or PUT) completed successfully.
idAbonelik için benzersiz kimlik
nameAbonelik planı adı
statusAbonelik aktiflik durumu
descriptionAbonelik plan açıklaması
periodsAbonelik periyot sayısı
periodFrequencyPeriyot sıklığı
dispatchCountsGönderim sayısı seçenekleri (virgülle ayrılmış)
shippingAmountEk kargo ücreti
discountİndirim tutarı veya oranı
chosenPeriodMüşteri tarafından seçilen periyot
chosenDispatchCountMüşteri tarafından seçilen gönderim sayısı
paymentTokenÖdeme token'ı (kart saklama için)
firstInstallmentRateİlk taksit oranı
createdAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
Contract COUNT
Bu endpoint, sistemdeki tüm abonelik sözleşmesi (Contract) 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ı.
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.
subscriptionBelirli bir Abonelik ID'sine (Subscription ID) göre filtreleme yapar.
productIdAboneliğin ilişkili olduğu Ürün ID'sine göre filtreleme yapar.
emailAboneliğin ilişkili olduğu üyenin e-posta adresine göre filtreleme yapar.
periodFrequencyAboneliğin periyot sıklığına göre filtreleme yapar.
paymentProviderAboneliğin bağlı olduğu ödeme sağlayıcısına (Payment Provider) göre filtreleme yapar.
sArama Anahtarı Filtresi (Search Keyword). Aboneliğin adında veya ilgili alanlarda genel arama yapmak için kullanılır.
Contract COUNT › Responses
The request (GET or PUT) completed successfully.
total_countTotal number of records matching the filters.
Contract GET
path Parameters
id\d+ · requiredContract GET › Responses
The request (GET or PUT) completed successfully.
idAbonelik için benzersiz kimlik
nameAbonelik planı adı
statusAbonelik aktiflik durumu
descriptionAbonelik plan açıklaması
periodsAbonelik periyot sayısı
periodFrequencyPeriyot sıklığı
dispatchCountsGönderim sayısı seçenekleri (virgülle ayrılmış)
shippingAmountEk kargo ücreti
discountİndirim tutarı veya oranı
chosenPeriodMüşteri tarafından seçilen periyot
chosenDispatchCountMüşteri tarafından seçilen gönderim sayısı
paymentTokenÖdeme token'ı (kart saklama için)
firstInstallmentRateİlk taksit oranı
createdAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
Contract PUT
path Parameters
id\d+ · requiredContract PUT › Request Body
idAbonelik için benzersiz kimlik
nameAbonelik planı adı
statusAbonelik aktiflik durumu
descriptionAbonelik plan açıklaması
periodsAbonelik periyot sayısı
periodFrequencyPeriyot sıklığı
dispatchCountsGönderim sayısı seçenekleri (virgülle ayrılmış)
shippingAmountEk kargo ücreti
discountİndirim tutarı veya oranı
chosenPeriodMüşteri tarafından seçilen periyot
chosenDispatchCountMüşteri tarafından seçilen gönderim sayısı
paymentTokenÖdeme token'ı (kart saklama için)
firstInstallmentRateİlk taksit oranı
createdAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi
Contract PUT › Responses
The request (GET or PUT) completed successfully.
idAbonelik için benzersiz kimlik
nameAbonelik planı adı
statusAbonelik aktiflik durumu
descriptionAbonelik plan açıklaması
periodsAbonelik periyot sayısı
periodFrequencyPeriyot sıklığı
dispatchCountsGönderim sayısı seçenekleri (virgülle ayrılmış)
shippingAmountEk kargo ücreti
discountİndirim tutarı veya oranı
chosenPeriodMüşteri tarafından seçilen periyot
chosenDispatchCountMüşteri tarafından seçilen gönderim sayısı
paymentTokenÖdeme token'ı (kart saklama için)
firstInstallmentRateİlk taksit oranı
createdAtKayıt oluşturulma tarihi
updatedAtKayıt son güncellenme tarihi