Skip to content
Ideasoft
Admin API

Contract

Serverhttps://your-store.myideasoft.com

Contract LIST

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

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.

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

subscription
​integer · min: 1

Belirli bir Abonelik ID'sine (Subscription ID) göre filtreleme yapar.

productId
​string

Aboneliğin ilişkili olduğu Ürün ID'sine göre filtreleme yapar.

email
​string

Aboneliğin ilişkili olduğu üyenin e-posta adresine göre filtreleme yapar.

periodFrequency
​string

Aboneliğin periyot sıklığına göre filtreleme yapar.

paymentProvider
​string

Aboneliğin bağlı olduğu ödeme sağlayıcısına (Payment Provider) göre filtreleme yapar.

s
​string

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

Abonelik sözleşmesi objesi
id
​integer · required

Abonelik için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Abonelik planı adı

Example: Aylık Kahve Aboneliği
status
​string · enum

Abonelik aktiflik durumu

Enum values:
0
1
Example: 1
description
​string

Abonelik plan açıklaması

Example: 30 günde 1 olmak üzere maksimum 4 kere çekilecek. %10 indirimli ve 15 TL kargo bedeli olacaktır.
periods
​string · maxLength: 255

Abonelik periyot sayısı

Example: 1
periodFrequency
​string · enum · maxLength: 255

Periyot sıklığı

Enum values:
Daily
Weekly
Monthly
Yearly
Example: Monthly
dispatchCounts
​string · maxLength: 255

Gönderim sayısı seçenekleri (virgülle ayrılmış)

Example: 1,2,3,4
shippingAmount
​number · float · min: 0

Ek kargo ücreti

Example: 15
discount
​integer · min: 0

İndirim tutarı veya oranı

Example: 10
chosenPeriod
​integer · min: 0

Müşteri tarafından seçilen periyot

Example: Monthly
chosenDispatchCount
​integer · min: 0

Müşteri tarafından seçilen gönderim sayısı

Example: 4
paymentToken
​string

Ödeme token'ı (kart saklama için)

Example: 7ea3e413cd9ef6074a01714qwe1f6e12
firstInstallmentRate
​number · float · min: 0

İlk taksit oranı

Example: 1
​OrderItemSummary
​SubscriptionSummary
createdAt
​string · date-time

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

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

Contract COUNT

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

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.

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

subscription
​integer · min: 1

Belirli bir Abonelik ID'sine (Subscription ID) göre filtreleme yapar.

productId
​string

Aboneliğin ilişkili olduğu Ürün ID'sine göre filtreleme yapar.

email
​string

Aboneliğin ilişkili olduğu üyenin e-posta adresine göre filtreleme yapar.

periodFrequency
​string

Aboneliğin periyot sıklığına göre filtreleme yapar.

paymentProvider
​string

Aboneliğin bağlı olduğu ödeme sağlayıcısına (Payment Provider) göre filtreleme yapar.

s
​string

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

Record count response.
total_count
​integer · required

Total number of records matching the filters.


Contract GET

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

Contract GET › path Parameters

id
​string · pattern: \d+ · required

Contract GET › Responses

The request (GET or PUT) completed successfully.

Abonelik sözleşmesi objesi
id
​integer · required

Abonelik için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Abonelik planı adı

Example: Aylık Kahve Aboneliği
status
​string · enum

Abonelik aktiflik durumu

Enum values:
0
1
Example: 1
description
​string

Abonelik plan açıklaması

Example: 30 günde 1 olmak üzere maksimum 4 kere çekilecek. %10 indirimli ve 15 TL kargo bedeli olacaktır.
periods
​string · maxLength: 255

Abonelik periyot sayısı

Example: 1
periodFrequency
​string · enum · maxLength: 255

Periyot sıklığı

Enum values:
Daily
Weekly
Monthly
Yearly
Example: Monthly
dispatchCounts
​string · maxLength: 255

Gönderim sayısı seçenekleri (virgülle ayrılmış)

Example: 1,2,3,4
shippingAmount
​number · float · min: 0

Ek kargo ücreti

Example: 15
discount
​integer · min: 0

İndirim tutarı veya oranı

Example: 10
chosenPeriod
​integer · min: 0

Müşteri tarafından seçilen periyot

Example: Monthly
chosenDispatchCount
​integer · min: 0

Müşteri tarafından seçilen gönderim sayısı

Example: 4
paymentToken
​string

Ödeme token'ı (kart saklama için)

Example: 7ea3e413cd9ef6074a01714qwe1f6e12
firstInstallmentRate
​number · float · min: 0

İlk taksit oranı

Example: 1
​OrderItemSummary
​SubscriptionSummary
createdAt
​string · date-time

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

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

Contract PUT

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

Contract PUT › path Parameters

id
​string · pattern: \d+ · required

Contract PUT › Request Body

Abonelik sözleşmesi objesi
id
​integer · required

Abonelik için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Abonelik planı adı

Example: Aylık Kahve Aboneliği
status
​string · enum

Abonelik aktiflik durumu

Enum values:
0
1
Example: 1
description
​string

Abonelik plan açıklaması

Example: 30 günde 1 olmak üzere maksimum 4 kere çekilecek. %10 indirimli ve 15 TL kargo bedeli olacaktır.
periods
​string · maxLength: 255

Abonelik periyot sayısı

Example: 1
periodFrequency
​string · enum · maxLength: 255

Periyot sıklığı

Enum values:
Daily
Weekly
Monthly
Yearly
Example: Monthly
dispatchCounts
​string · maxLength: 255

Gönderim sayısı seçenekleri (virgülle ayrılmış)

Example: 1,2,3,4
shippingAmount
​number · float · min: 0

Ek kargo ücreti

Example: 15
discount
​integer · min: 0

İndirim tutarı veya oranı

Example: 10
chosenPeriod
​integer · min: 0

Müşteri tarafından seçilen periyot

Example: Monthly
chosenDispatchCount
​integer · min: 0

Müşteri tarafından seçilen gönderim sayısı

Example: 4
paymentToken
​string

Ödeme token'ı (kart saklama için)

Example: 7ea3e413cd9ef6074a01714qwe1f6e12
firstInstallmentRate
​number · float · min: 0

İlk taksit oranı

Example: 1
​OrderItemSummary
​SubscriptionSummary
createdAt
​string · date-time

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

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

Contract PUT › Responses

The request (GET or PUT) completed successfully.

Abonelik sözleşmesi objesi
id
​integer · required

Abonelik için benzersiz kimlik

Example: 123
name
​string · maxLength: 255

Abonelik planı adı

Example: Aylık Kahve Aboneliği
status
​string · enum

Abonelik aktiflik durumu

Enum values:
0
1
Example: 1
description
​string

Abonelik plan açıklaması

Example: 30 günde 1 olmak üzere maksimum 4 kere çekilecek. %10 indirimli ve 15 TL kargo bedeli olacaktır.
periods
​string · maxLength: 255

Abonelik periyot sayısı

Example: 1
periodFrequency
​string · enum · maxLength: 255

Periyot sıklığı

Enum values:
Daily
Weekly
Monthly
Yearly
Example: Monthly
dispatchCounts
​string · maxLength: 255

Gönderim sayısı seçenekleri (virgülle ayrılmış)

Example: 1,2,3,4
shippingAmount
​number · float · min: 0

Ek kargo ücreti

Example: 15
discount
​integer · min: 0

İndirim tutarı veya oranı

Example: 10
chosenPeriod
​integer · min: 0

Müşteri tarafından seçilen periyot

Example: Monthly
chosenDispatchCount
​integer · min: 0

Müşteri tarafından seçilen gönderim sayısı

Example: 4
paymentToken
​string

Ödeme token'ı (kart saklama için)

Example: 7ea3e413cd9ef6074a01714qwe1f6e12
firstInstallmentRate
​number · float · min: 0

İlk taksit oranı

Example: 1
​OrderItemSummary
​SubscriptionSummary
createdAt
​string · date-time

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

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