İçeriğe geç
Admin API

Country

Serverhttps://magaza-adiniz.myideasoft.com

Country LIST

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

Country 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 gelecek Countries adedi.

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı.

Default: 1
id
​integer · min: 1

Tekli listeleme için id değeri.

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir.

status
​string · enum

Country status arama filtresi.

Enum values:
0
1
q
​string

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

s
​string

Arama anahtarı ile filtreleme.

Country LIST › Responses

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

id
​integer

Ülke nesnesinin benzersiz kimlik (ID) değeri.

Example: 123
name
​string

Ülkenin adı.

Example: Türkiye
code
​string

ISO 3166-1 alpha-2 ülke kodu (2 harfli).

Example: TR
status
​integer · enum

Ülkenin aktiflik durumu. Seçenekler: | 0: Devre dışı (ülke kullanılmaz) | 1: Etkin (ülke kullanılabilir)

Enum values:
0
1
Example: 1
exportStatus
​integer · enum
Enum values:
0
1
selectedLanguage
​string
selectedCurrency
​string

Country COUNT

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

Country 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 gelecek Countries adedi.

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı.

Default: 1
id
​integer · min: 1

Tekli listeleme için id değeri.

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir.

status
​string · enum

Country status arama filtresi.

Enum values:
0
1
q
​string

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

s
​string

Arama anahtarı ile filtreleme.

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


Country GET

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

Country GET › path Parameters

id
​string · pattern: \d+ · required

Country GET › Responses

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

id
​integer

Ülke nesnesinin benzersiz kimlik (ID) değeri.

Example: 123
name
​string

Ülkenin adı.

Example: Türkiye
code
​string

ISO 3166-1 alpha-2 ülke kodu (2 harfli).

Example: TR
status
​integer · enum

Ülkenin aktiflik durumu. Seçenekler: | 0: Devre dışı (ülke kullanılmaz) | 1: Etkin (ülke kullanılabilir)

Enum values:
0
1
Example: 1
exportStatus
​integer · enum
Enum values:
0
1
selectedLanguage
​string
selectedCurrency
​string

Country PUT

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

Country PUT › path Parameters

id
​string · pattern: \d+ · required

Country PUT › Request Body

id
​integer

Ülke nesnesinin benzersiz kimlik (ID) değeri.

Example: 123
name
​string

Ülkenin adı.

Example: Türkiye
code
​string

ISO 3166-1 alpha-2 ülke kodu (2 harfli).

Example: TR
status
​integer · enum

Ülkenin aktiflik durumu. Seçenekler: | 0: Devre dışı (ülke kullanılmaz) | 1: Etkin (ülke kullanılabilir)

Enum values:
0
1
Example: 1
exportStatus
​integer · enum
Enum values:
0
1
selectedLanguage
​string
selectedCurrency
​string

Country PUT › Responses

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

id
​integer

Ülke nesnesinin benzersiz kimlik (ID) değeri.

Example: 123
name
​string

Ülkenin adı.

Example: Türkiye
code
​string

ISO 3166-1 alpha-2 ülke kodu (2 harfli).

Example: TR
status
​integer · enum

Ülkenin aktiflik durumu. Seçenekler: | 0: Devre dışı (ülke kullanılmaz) | 1: Etkin (ülke kullanılabilir)

Enum values:
0
1
Example: 1
exportStatus
​integer · enum
Enum values:
0
1
selectedLanguage
​string
selectedCurrency
​string