İçeriğe geç
Store API

Country

Serverhttps://magaza-adiniz.myideasoft.com

Country LIST

GET
https://magaza-adiniz.myideasoft.com
/api/countries
Bearer

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
sinceId
​integer · min: 1

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

ids
​string

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

name
​string

Country Name.

status
​string · enum

Country status arama filtresi.

Enum values:
0
1
q
​string

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

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 · maxLength: 255

Ülkenin adı.

Example: Türkiye
code
​string · maxLength: 255

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
extraShippingPrice
​number · float · min: 0 · writeOnly
selectedLanguage
​string · maxLength: 255 · writeOnly
selectedCurrency
​string · maxLength: 255 · writeOnly
phoneCode
​integer · writeOnly

Country GET

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

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 · maxLength: 255

Ülkenin adı.

Example: Türkiye
code
​string · maxLength: 255

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
extraShippingPrice
​number · float · min: 0 · writeOnly
selectedLanguage
​string · maxLength: 255 · writeOnly
selectedCurrency
​string · maxLength: 255 · writeOnly
phoneCode
​integer · writeOnly

Country PUT

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

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 · maxLength: 255

Ülkenin adı.

Example: Türkiye
code
​string · maxLength: 255

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
extraShippingPrice
​number · float · min: 0 · writeOnly
selectedLanguage
​string · maxLength: 255 · writeOnly
selectedCurrency
​string · maxLength: 255 · writeOnly
phoneCode
​integer · writeOnly

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 · maxLength: 255

Ülkenin adı.

Example: Türkiye
code
​string · maxLength: 255

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
extraShippingPrice
​number · float · min: 0 · writeOnly
selectedLanguage
​string · maxLength: 255 · writeOnly
selectedCurrency
​string · maxLength: 255 · writeOnly
phoneCode
​integer · writeOnly