İçeriğe geç
Admin API

Region

Serverhttps://magaza-adiniz.myideasoft.com

Region LIST

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

Region LIST › query Parameters

sort
​string

Sonuçların sıralama biçimini belirtir. - Artan sıra: sort=id - Azalan sıra: sort=-id Birden fazla alanla sıralamak için virgülle ayırabilirsiniz. Örnek: sort=-id,name

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek bölge (Region) sayısı. Varsayılan: 20

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1

Default: 1
id
​integer · min: 1

Tek bir bölge kaydını döndürür. Örnek: id=3

ids
​string

Birden fazla bölgeyi aynı anda getirmek için virgülle ayrılmış ID listesi. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir. Genellikle sonsuz kaydırma (infinite scroll) senaryolarında kullanılır. Örnek: sinceId=10

q
​string

Alan bazlı arama filtresi. Kullanım: q[alanAdı]=değer Örnek: q[name]=Marmara

s
​string

Genel arama anahtarı. Bölge adında veya diğer metinsel alanlarda arama yapar. Örnek: s=Ege

countries
​string

Ülkelere göre filtreleme yapar. Country ID'leri virgülle ayrılmış olarak gönderilmelidir. Örnek: countries=1,170

Default: 1,170

Region LIST › Responses

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

id
​integer · required

Teslimat bölgesi kimlik değeri.

Example: 1
name
​string

Teslimat bölgesi ismi.

Example: Marmara
​CountrySummary[]

Teslimat bölgesine ait ülkeler listesi.


Region POST

POST
https://magaza-adiniz.myideasoft.com
/admin-api/regions
Bearer
or
OAuth 2.0

Region POST › Request Body

id
​integer · required

Teslimat bölgesi kimlik değeri.

Example: 1
name
​string

Teslimat bölgesi ismi.

Example: Marmara
​CountrySummary[]

Teslimat bölgesine ait ülkeler listesi.

Region POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

id
​integer · required

Teslimat bölgesi kimlik değeri.

Example: 1
name
​string

Teslimat bölgesi ismi.

Example: Marmara
​CountrySummary[]

Teslimat bölgesine ait ülkeler listesi.


Region COUNT

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

Region COUNT › query Parameters

sort
​string

Sonuçların sıralama biçimini belirtir. - Artan sıra: sort=id - Azalan sıra: sort=-id Birden fazla alanla sıralamak için virgülle ayırabilirsiniz. Örnek: sort=-id,name

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek bölge (Region) sayısı. Varsayılan: 20

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1

Default: 1
id
​integer · min: 1

Tek bir bölge kaydını döndürür. Örnek: id=3

ids
​string

Birden fazla bölgeyi aynı anda getirmek için virgülle ayrılmış ID listesi. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir. Genellikle sonsuz kaydırma (infinite scroll) senaryolarında kullanılır. Örnek: sinceId=10

q
​string

Alan bazlı arama filtresi. Kullanım: q[alanAdı]=değer Örnek: q[name]=Marmara

s
​string

Genel arama anahtarı. Bölge adında veya diğer metinsel alanlarda arama yapar. Örnek: s=Ege

countries
​string

Ülkelere göre filtreleme yapar. Country ID'leri virgülle ayrılmış olarak gönderilmelidir. Örnek: countries=1,170

Default: 1,170

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


Region GET

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

Region GET › path Parameters

id
​string · pattern: \d+ · required

Region GET › Responses

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

id
​integer · required

Teslimat bölgesi kimlik değeri.

Example: 1
name
​string

Teslimat bölgesi ismi.

Example: Marmara
​CountrySummary[]

Teslimat bölgesine ait ülkeler listesi.


Region PUT

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

Region PUT › path Parameters

id
​string · pattern: \d+ · required

Region PUT › Request Body

id
​integer · required

Teslimat bölgesi kimlik değeri.

Example: 1
name
​string

Teslimat bölgesi ismi.

Example: Marmara
​CountrySummary[]

Teslimat bölgesine ait ülkeler listesi.

Region PUT › Responses

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

id
​integer · required

Teslimat bölgesi kimlik değeri.

Example: 1
name
​string

Teslimat bölgesi ismi.

Example: Marmara
​CountrySummary[]

Teslimat bölgesine ait ülkeler listesi.


Region DELETE

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

Region DELETE › path Parameters

id
​string · pattern: \d+ · required

Region DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned