İçeriğe geç
Admin API

ContractPlan

Serverhttps://magaza-adiniz.myideasoft.com

ContractPlan LIST

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

ContractPlan LIST › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id.

limit
​integer · min: 1 · max: 100

Bir sayfada listelenecek Contract Plans adedi.

Default: 20
page
​integer · min: 1

Başlanacak sayfa numarası.

Default: 1
id
​integer · min: 1

Tekli listeleme için ContractPlan ID.

ids
​string

Çoklu listeleme için virgülle ayrılmış ContractPlan ID’leri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir.

q
​string

ContractPlan arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]

contract
​integer · min: 1

Contract ID

s
​string

Arama anahtarı ile filtreleme.

ContractPlan LIST › Responses

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

period
​integer · min: 0 · required

Abonelik planının periyodu(gün/hafta/ay).

Example: 1
status
​string · enum · required

Abonelik planı nesnesinin durumunu belirten değer. Seçenekler: | waiting: Beklemede | successful: Başarılı | failed: Başarısız | canceled: İptal edildi

Enum values:
waiting
successful
failed
canceled
​ContractSummary · required

Abonelik sözleşmesi objesi

id
​integer

Abonelik planı nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
message
​string · maxLength: 255

Abonelik planı nesnesi ile ilgili mesaj değeri.

periodDate
​string · date-time

Abonelik planı için geçerli tarih aralığı veya tarih bilgisi.

createdAt
​string · date-time

Abonelik planı nesnesinin oluşturulma tarihi.

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

Abonelik planı nesnesinin son güncellenme tarihi.

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

ContractPlan COUNT

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

ContractPlan COUNT › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id.

limit
​integer · min: 1 · max: 100

Bir sayfada listelenecek Contract Plans adedi.

Default: 20
page
​integer · min: 1

Başlanacak sayfa numarası.

Default: 1
id
​integer · min: 1

Tekli listeleme için ContractPlan ID.

ids
​string

Çoklu listeleme için virgülle ayrılmış ContractPlan ID’leri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir.

q
​string

ContractPlan arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]

contract
​integer · min: 1

Contract ID

s
​string

Arama anahtarı ile filtreleme.

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


ContractPlan GET

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

ContractPlan GET › path Parameters

id
​string · pattern: \d+ · required

ContractPlan GET › Responses

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

period
​integer · min: 0 · required

Abonelik planının periyodu(gün/hafta/ay).

Example: 1
status
​string · enum · required

Abonelik planı nesnesinin durumunu belirten değer. Seçenekler: | waiting: Beklemede | successful: Başarılı | failed: Başarısız | canceled: İptal edildi

Enum values:
waiting
successful
failed
canceled
​ContractSummary · required

Abonelik sözleşmesi objesi

id
​integer

Abonelik planı nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
message
​string · maxLength: 255

Abonelik planı nesnesi ile ilgili mesaj değeri.

periodDate
​string · date-time

Abonelik planı için geçerli tarih aralığı veya tarih bilgisi.

createdAt
​string · date-time

Abonelik planı nesnesinin oluşturulma tarihi.

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

Abonelik planı nesnesinin son güncellenme tarihi.

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