İçeriğe geç
Admin API

Location

Serverhttps://magaza-adiniz.myideasoft.com

Location LIST

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

Bu endpoint, sistemdeki Location kayıtlarını listeler ve çeşitli kriterlere göre filtrelemeye olanak sağlar. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId), status, ülke, bölge ve arama (q, s) parametreleriyle özelleştirilebilir.

Location 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 Location 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 Location kaydını döndürmek için ID değeri

ids
​string

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

status
​string · enum

Location status arama filtresi

Enum values:
0
1
sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir

country
​integer · min: 1

Country Id

region
​integer · min: 1

Region Id

q
​string

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

s
​string

Arama anahtarı ile filtreleme

Location LIST › Responses

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

id
​integer · required

Şehir nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string

Şehir nesnesi için isim değeri.

Example: İstanbul
status
​integer · enum

Şehir nesnesinin aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
​CountrySummary
​RegionSummary

Location POST

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

Bu endpoint, yeni bir Location kaydı oluşturur ve log kaydı oluşturur.

Location POST › Request Body

id
​integer · required

Şehir nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string

Şehir nesnesi için isim değeri.

Example: İstanbul
status
​integer · enum

Şehir nesnesinin aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
​CountrySummary
​RegionSummary

Location POST › Responses

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

id
​integer · required

Şehir nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string

Şehir nesnesi için isim değeri.

Example: İstanbul
status
​integer · enum

Şehir nesnesinin aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
​CountrySummary
​RegionSummary

Location COUNT

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

Bu endpoint, sistemdeki Location kayıtlarını listeler ve çeşitli kriterlere göre filtrelemeye olanak sağlar. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId), status, ülke, bölge ve arama (q, s) parametreleriyle özelleştirilebilir.

Location 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 Location 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 Location kaydını döndürmek için ID değeri

ids
​string

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

status
​string · enum

Location status arama filtresi

Enum values:
0
1
sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir

country
​integer · min: 1

Country Id

region
​integer · min: 1

Region Id

q
​string

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

s
​string

Arama anahtarı ile filtreleme

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


Location GET

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

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

Location GET › path Parameters

id
​string · pattern: \d+ · required

Location kaydının ID değeri

Location GET › Responses

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

id
​integer · required

Şehir nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string

Şehir nesnesi için isim değeri.

Example: İstanbul
status
​integer · enum

Şehir nesnesinin aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
​CountrySummary
​RegionSummary

Location PUT

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

Belirtilen Location kaydını günceller ve log kaydı oluşturur.

Location PUT › path Parameters

id
​string · pattern: \d+ · required

Güncellenecek Location kaydının ID değeri

Location PUT › Request Body

id
​integer · required

Şehir nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string

Şehir nesnesi için isim değeri.

Example: İstanbul
status
​integer · enum

Şehir nesnesinin aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
​CountrySummary
​RegionSummary

Location PUT › Responses

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

id
​integer · required

Şehir nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string

Şehir nesnesi için isim değeri.

Example: İstanbul
status
​integer · enum

Şehir nesnesinin aktiflik durumunu belirten değer. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
​CountrySummary
​RegionSummary

Location DELETE

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

Belirtilen Location kaydını siler ve log kaydı oluşturur.

Location DELETE › path Parameters

id
​string · pattern: \d+ · required

Silinecek Location kaydının ID değeri

Location DELETE › Responses

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

No data returned