Skip to content
Ideasoft
Admin API

Subscription

Serverhttps://your-store.myideasoft.com

Subscription LIST

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

Tüm Abonelik (Subscription) 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.

Subscription 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. Kullanım: q[<alan_adı>]=<değer>

s
​string

Arama Anahtarı Filtresi (Search Keyword). Abonelik adında veya ilgili alanlarda genel arama yapmak için kullanılır.

Subscription LIST › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Abonelik nesnesi kimlik değeri

name
​string · maxLength: 255 · required

Abonelik nesnesi adı

periods
​string · maxLength: 255

Abonelik periyodu

periodFrequency
​string · enum

Abonelik periyodu sıklığı Seçenekler: | daily: Günlük | weekly: Haftalık | monthly: Aylık

Enum values:
daily
weekly
monthly
dispatchCounts
​string · maxLength: 255

Periyot içindeki sevk sayısı. Örneğin 30 günde bir en fazla 1, 2, 3 veya 4 defa abone olunabilir

Example: 1,2,3,4
continuousSending
​integer · enum

Sürekli gönderim. Kullanıcı abonelikten çıkmadığı sürece gönderim devam eder Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
description
​string

Açıklama

status
​string · enum

Abonelik nesnesi aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
active
passive
discount
​integer · min: 0

İndirim

shippingAmount
​number · float · min: 0

Kargo ücreti

createdAt
​string · date-time

Abonelik nesnesinin oluşturulma zamanı

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Abonelik nesnesinin güncellenme zamanı

Example: 2018-02-21T15:01:03+03:00

Subscription POST

POST
https://your-store.myideasoft.com
/admin-api/subscriptions
Bearer
or
OAuth 2.0

Subscription POST › Request Body

id
​integer · required

Abonelik nesnesi kimlik değeri

name
​string · maxLength: 255 · required

Abonelik nesnesi adı

periods
​string · maxLength: 255

Abonelik periyodu

periodFrequency
​string · enum

Abonelik periyodu sıklığı Seçenekler: | daily: Günlük | weekly: Haftalık | monthly: Aylık

Enum values:
daily
weekly
monthly
dispatchCounts
​string · maxLength: 255

Periyot içindeki sevk sayısı. Örneğin 30 günde bir en fazla 1, 2, 3 veya 4 defa abone olunabilir

Example: 1,2,3,4
continuousSending
​integer · enum

Sürekli gönderim. Kullanıcı abonelikten çıkmadığı sürece gönderim devam eder Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
description
​string

Açıklama

status
​string · enum

Abonelik nesnesi aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
active
passive
discount
​integer · min: 0

İndirim

shippingAmount
​number · float · min: 0

Kargo ücreti

createdAt
​string · date-time

Abonelik nesnesinin oluşturulma zamanı

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Abonelik nesnesinin güncellenme zamanı

Example: 2018-02-21T15:01:03+03:00

Subscription POST › Responses

The create request (POST) completed successfully.

id
​integer · required

Abonelik nesnesi kimlik değeri

name
​string · maxLength: 255 · required

Abonelik nesnesi adı

periods
​string · maxLength: 255

Abonelik periyodu

periodFrequency
​string · enum

Abonelik periyodu sıklığı Seçenekler: | daily: Günlük | weekly: Haftalık | monthly: Aylık

Enum values:
daily
weekly
monthly
dispatchCounts
​string · maxLength: 255

Periyot içindeki sevk sayısı. Örneğin 30 günde bir en fazla 1, 2, 3 veya 4 defa abone olunabilir

Example: 1,2,3,4
continuousSending
​integer · enum

Sürekli gönderim. Kullanıcı abonelikten çıkmadığı sürece gönderim devam eder Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
description
​string

Açıklama

status
​string · enum

Abonelik nesnesi aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
active
passive
discount
​integer · min: 0

İndirim

shippingAmount
​number · float · min: 0

Kargo ücreti

createdAt
​string · date-time

Abonelik nesnesinin oluşturulma zamanı

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Abonelik nesnesinin güncellenme zamanı

Example: 2018-02-21T15:01:03+03:00

Subscription COUNT

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

Tüm Abonelik (Subscription) 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.

Subscription 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. Kullanım: q[<alan_adı>]=<değer>

s
​string

Arama Anahtarı Filtresi (Search Keyword). Abonelik adında veya ilgili alanlarda genel arama yapmak için kullanılır.

Subscription COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


Subscription GET

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

Subscription GET › path Parameters

id
​string · pattern: \d+ · required

Subscription GET › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Abonelik nesnesi kimlik değeri

name
​string · maxLength: 255 · required

Abonelik nesnesi adı

periods
​string · maxLength: 255

Abonelik periyodu

periodFrequency
​string · enum

Abonelik periyodu sıklığı Seçenekler: | daily: Günlük | weekly: Haftalık | monthly: Aylık

Enum values:
daily
weekly
monthly
dispatchCounts
​string · maxLength: 255

Periyot içindeki sevk sayısı. Örneğin 30 günde bir en fazla 1, 2, 3 veya 4 defa abone olunabilir

Example: 1,2,3,4
continuousSending
​integer · enum

Sürekli gönderim. Kullanıcı abonelikten çıkmadığı sürece gönderim devam eder Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
description
​string

Açıklama

status
​string · enum

Abonelik nesnesi aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
active
passive
discount
​integer · min: 0

İndirim

shippingAmount
​number · float · min: 0

Kargo ücreti

createdAt
​string · date-time

Abonelik nesnesinin oluşturulma zamanı

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Abonelik nesnesinin güncellenme zamanı

Example: 2018-02-21T15:01:03+03:00

Subscription PUT

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

Subscription PUT › path Parameters

id
​string · pattern: \d+ · required

Subscription PUT › Request Body

id
​integer · required

Abonelik nesnesi kimlik değeri

name
​string · maxLength: 255 · required

Abonelik nesnesi adı

periods
​string · maxLength: 255

Abonelik periyodu

periodFrequency
​string · enum

Abonelik periyodu sıklığı Seçenekler: | daily: Günlük | weekly: Haftalık | monthly: Aylık

Enum values:
daily
weekly
monthly
dispatchCounts
​string · maxLength: 255

Periyot içindeki sevk sayısı. Örneğin 30 günde bir en fazla 1, 2, 3 veya 4 defa abone olunabilir

Example: 1,2,3,4
continuousSending
​integer · enum

Sürekli gönderim. Kullanıcı abonelikten çıkmadığı sürece gönderim devam eder Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
description
​string

Açıklama

status
​string · enum

Abonelik nesnesi aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
active
passive
discount
​integer · min: 0

İndirim

shippingAmount
​number · float · min: 0

Kargo ücreti

createdAt
​string · date-time

Abonelik nesnesinin oluşturulma zamanı

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Abonelik nesnesinin güncellenme zamanı

Example: 2018-02-21T15:01:03+03:00

Subscription PUT › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Abonelik nesnesi kimlik değeri

name
​string · maxLength: 255 · required

Abonelik nesnesi adı

periods
​string · maxLength: 255

Abonelik periyodu

periodFrequency
​string · enum

Abonelik periyodu sıklığı Seçenekler: | daily: Günlük | weekly: Haftalık | monthly: Aylık

Enum values:
daily
weekly
monthly
dispatchCounts
​string · maxLength: 255

Periyot içindeki sevk sayısı. Örneğin 30 günde bir en fazla 1, 2, 3 veya 4 defa abone olunabilir

Example: 1,2,3,4
continuousSending
​integer · enum

Sürekli gönderim. Kullanıcı abonelikten çıkmadığı sürece gönderim devam eder Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
0
1
description
​string

Açıklama

status
​string · enum

Abonelik nesnesi aktiflik durumu Seçenekler: | 0: Pasif | 1: Aktif

Enum values:
active
passive
discount
​integer · min: 0

İndirim

shippingAmount
​number · float · min: 0

Kargo ücreti

createdAt
​string · date-time

Abonelik nesnesinin oluşturulma zamanı

Example: 2018-02-21T09:36:03+03:00
updatedAt
​string · date-time

Abonelik nesnesinin güncellenme zamanı

Example: 2018-02-21T15:01:03+03:00

Subscription DELETE

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

Subscription DELETE › path Parameters

id
​string · pattern: \d+ · required

Subscription DELETE › Responses

The delete request completed successfully (the response has no content).

No data returned