Skip to content
Ideasoft
Admin API

Currency

Serverhttps://your-store.myideasoft.com

Currency LIST

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

Bu endpoint, sistemdeki dövizleri listelemek ve çeşitli kriterlere göre filtrelemek için kullanılır. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

Currency LIST › query Parameters

sort
​string

Sonuçların sıralama biçimi. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek Currency sayısı. Varsayılan 20

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı. Varsayılan 1

Default: 1
id
​integer · min: 1

Tek bir döviz kaydını döndürmek için ID değeri

ids
​string

Çoklu döviz kaydını aynı anda getirmek için virgülle ayrılmış ID listesi. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir

q
​string

Döviz arama filtresi. Kullanımı: q[<geçerli-query-param>]=<değer>

s
​string

Genel arama anahtarı ile filtreleme

Currency LIST › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Kur kimlik değeri.

Example: 123
label
​string

Kur etiketi.

Example: Türk Lirası
abbr
​string

Kur kısaltması.

Example: TL
buyingPrice
​number · float · min: 0

Kur alış fiyatı.

Example: 1
sellingPrice
​number · float · min: 0

Kur satış fiyatı.

Example: 1
status
​integer · enum

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

Enum values:
0
1
permissionStatus
​integer · enum

Kur kullanım izni durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
isPrimary
​integer · enum

Kurun birincil kur olup olmadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
isEffective
​integer · enum

Kurun efektif kur olarak kullanılıp kullanılmadığı. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
updatedAt
​string · date-time

Kurun güncellenme zamanı.

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

Currency COUNT

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

Bu endpoint, sistemdeki dövizleri listelemek ve çeşitli kriterlere göre filtrelemek için kullanılır. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

Currency COUNT › query Parameters

sort
​string

Sonuçların sıralama biçimi. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek Currency sayısı. Varsayılan 20

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı. Varsayılan 1

Default: 1
id
​integer · min: 1

Tek bir döviz kaydını döndürmek için ID değeri

ids
​string

Çoklu döviz kaydını aynı anda getirmek için virgülle ayrılmış ID listesi. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir

q
​string

Döviz arama filtresi. Kullanımı: q[<geçerli-query-param>]=<değer>

s
​string

Genel arama anahtarı ile filtreleme

Currency COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


Currency GET

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

Belirtilen ID ile eşleşen döviz kaydını döndürür.

Currency GET › path Parameters

id
​string · pattern: \d+ · required

Döviz kaydının ID değeri

Currency GET › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Kur kimlik değeri.

Example: 123
label
​string

Kur etiketi.

Example: Türk Lirası
abbr
​string

Kur kısaltması.

Example: TL
buyingPrice
​number · float · min: 0

Kur alış fiyatı.

Example: 1
sellingPrice
​number · float · min: 0

Kur satış fiyatı.

Example: 1
status
​integer · enum

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

Enum values:
0
1
permissionStatus
​integer · enum

Kur kullanım izni durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
isPrimary
​integer · enum

Kurun birincil kur olup olmadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
isEffective
​integer · enum

Kurun efektif kur olarak kullanılıp kullanılmadığı. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
updatedAt
​string · date-time

Kurun güncellenme zamanı.

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

Currency PUT

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

Belirtilen döviz kaydını günceller ve log kaydı oluşturur.

Currency PUT › path Parameters

id
​string · pattern: \d+ · required

Güncellenecek döviz kaydının ID değeri

Currency PUT › Request Body

id
​integer · required

Kur kimlik değeri.

Example: 123
label
​string

Kur etiketi.

Example: Türk Lirası
abbr
​string

Kur kısaltması.

Example: TL
buyingPrice
​number · float · min: 0

Kur alış fiyatı.

Example: 1
sellingPrice
​number · float · min: 0

Kur satış fiyatı.

Example: 1
status
​integer · enum

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

Enum values:
0
1
permissionStatus
​integer · enum

Kur kullanım izni durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
isPrimary
​integer · enum

Kurun birincil kur olup olmadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
isEffective
​integer · enum

Kurun efektif kur olarak kullanılıp kullanılmadığı. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
updatedAt
​string · date-time

Kurun güncellenme zamanı.

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

Currency PUT › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Kur kimlik değeri.

Example: 123
label
​string

Kur etiketi.

Example: Türk Lirası
abbr
​string

Kur kısaltması.

Example: TL
buyingPrice
​number · float · min: 0

Kur alış fiyatı.

Example: 1
sellingPrice
​number · float · min: 0

Kur satış fiyatı.

Example: 1
status
​integer · enum

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

Enum values:
0
1
permissionStatus
​integer · enum

Kur kullanım izni durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
isPrimary
​integer · enum

Kurun birincil kur olup olmadığını belirtir. Seçenekler: | 0: Hayır. | 1: Evet.

Enum values:
0
1
isEffective
​integer · enum

Kurun efektif kur olarak kullanılıp kullanılmadığı. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
updatedAt
​string · date-time

Kurun güncellenme zamanı.

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