Skip to content
Ideasoft
Admin API

TownGroup

Serverhttps://your-store.myideasoft.com

TownGroup LIST

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

TownGroup LIST › query Parameters

sort
​string

Sonuçların hangi alana göre sıralanacağını belirler. Artan (ascending) sıralama için alan adını (id), azalan (descending) sıralama için ise başına eksi işareti (-) ekleyin.

limit
​integer · min: 1 · max: 100

Bir sayfada döndürülecek maksimum kayıt adedi.

Default: 20
page
​integer · min: 1

Getirilecek sonuçların sayfa numarası.

Default: 1
id
​integer · min: 1

Tek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).

ids
​string

Çoklu listeleme için virgülle ayrılmış benzersiz kimlik değerleri (IDs) listesi.

sinceId
​integer · min: 1

Belirtilen ID değerinden daha büyük ID'ye sahip (sonraki) kayıtları getirir.

q
​string

Gelişmiş Filtreleme (Query Filter)**. Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>

s
​string

Arama Anahtarı Filtresi (Search Keyword). Genel arama yapmak için kullanılır.

TownGroup LIST › Responses

The request (GET or PUT) completed successfully.

name
​string · required

İlçe grubu nesnesinin adı.

Example: Standart İlçeler
id
​integer

İlçe grubu nesnesinin benzersiz kimlik değeri.

Example: 123
status
​integer · enum

İlçe grubunun aktiflik durumu. true = Aktif, false = Pasif

Enum values:
0
1
Example: true

TownGroup POST

POST
https://your-store.myideasoft.com
/admin-api/town_groups
Bearer
or
OAuth 2.0

TownGroup POST › Request Body

name
​string · required

İlçe grubu nesnesinin adı.

Example: Standart İlçeler
id
​integer

İlçe grubu nesnesinin benzersiz kimlik değeri.

Example: 123
status
​integer · enum

İlçe grubunun aktiflik durumu. true = Aktif, false = Pasif

Enum values:
0
1
Example: true

TownGroup POST › Responses

The create request (POST) completed successfully.

name
​string · required

İlçe grubu nesnesinin adı.

Example: Standart İlçeler
id
​integer

İlçe grubu nesnesinin benzersiz kimlik değeri.

Example: 123
status
​integer · enum

İlçe grubunun aktiflik durumu. true = Aktif, false = Pasif

Enum values:
0
1
Example: true

TownGroup COUNT

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

TownGroup COUNT › query Parameters

sort
​string

Sonuçların hangi alana göre sıralanacağını belirler. Artan (ascending) sıralama için alan adını (id), azalan (descending) sıralama için ise başına eksi işareti (-) ekleyin.

limit
​integer · min: 1 · max: 100

Bir sayfada döndürülecek maksimum kayıt adedi.

Default: 20
page
​integer · min: 1

Getirilecek sonuçların sayfa numarası.

Default: 1
id
​integer · min: 1

Tek bir kayıt getirmek için kullanılan benzersiz kimlik değeri (ID).

ids
​string

Çoklu listeleme için virgülle ayrılmış benzersiz kimlik değerleri (IDs) listesi.

sinceId
​integer · min: 1

Belirtilen ID değerinden daha büyük ID'ye sahip (sonraki) kayıtları getirir.

q
​string

Gelişmiş Filtreleme (Query Filter)**. Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>

s
​string

Arama Anahtarı Filtresi (Search Keyword). Genel arama yapmak için kullanılır.

TownGroup COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


TownGroup GET

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

TownGroup GET › path Parameters

id
​string · pattern: \d+ · required

TownGroup GET › Responses

The request (GET or PUT) completed successfully.

name
​string · required

İlçe grubu nesnesinin adı.

Example: Standart İlçeler
id
​integer

İlçe grubu nesnesinin benzersiz kimlik değeri.

Example: 123
status
​integer · enum

İlçe grubunun aktiflik durumu. true = Aktif, false = Pasif

Enum values:
0
1
Example: true

TownGroup PUT

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

TownGroup PUT › path Parameters

id
​string · pattern: \d+ · required

TownGroup PUT › Request Body

name
​string · required

İlçe grubu nesnesinin adı.

Example: Standart İlçeler
id
​integer

İlçe grubu nesnesinin benzersiz kimlik değeri.

Example: 123
status
​integer · enum

İlçe grubunun aktiflik durumu. true = Aktif, false = Pasif

Enum values:
0
1
Example: true

TownGroup PUT › Responses

The request (GET or PUT) completed successfully.

name
​string · required

İlçe grubu nesnesinin adı.

Example: Standart İlçeler
id
​integer

İlçe grubu nesnesinin benzersiz kimlik değeri.

Example: 123
status
​integer · enum

İlçe grubunun aktiflik durumu. true = Aktif, false = Pasif

Enum values:
0
1
Example: true

TownGroup DELETE

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

TownGroup DELETE › path Parameters

id
​string · pattern: \d+ · required

TownGroup DELETE › Responses

The delete request completed successfully (the response has no content).

No data returned

TownGroup CopyAction POST

POST
https://your-store.myideasoft.com
/admin-api/town_groups/{id}/copy
Bearer
or
OAuth 2.0

TownGroup CopyAction POST › path Parameters

id
​string · pattern: \d+ · required

TownGroup CopyAction POST › Responses

The request (GET or PUT) completed successfully.

No data returned