Skip to content
Ideasoft
Admin API

Town

Serverhttps://your-store.myideasoft.com

Town LIST

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

Town 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 Towns 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

Status alanının alabileceği değerler: 0 veya 1

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

Location id

townGroup
​integer · min: 1

Town Group id

q
​string

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

s
​string

Arama anahtarı ile filtreleme.

Town LIST › Responses

The request (GET or PUT) completed successfully.

İlçe nesnesi
id
​integer · required

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · required

İlçe adı.

Example: Üsküdar
status
​integer · enum

İlçenin aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
​LocationSummary
​TownGroupSummary

Town POST

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

Town POST › Request Body

İlçe nesnesi
id
​integer · required

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · required

İlçe adı.

Example: Üsküdar
status
​integer · enum

İlçenin aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
​LocationSummary
​TownGroupSummary

Town POST › Responses

The create request (POST) completed successfully.

İlçe nesnesi
id
​integer · required

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · required

İlçe adı.

Example: Üsküdar
status
​integer · enum

İlçenin aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
​LocationSummary
​TownGroupSummary

Town COUNT

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

Town 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 Towns 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

Status alanının alabileceği değerler: 0 veya 1

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

Location id

townGroup
​integer · min: 1

Town Group id

q
​string

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

s
​string

Arama anahtarı ile filtreleme.

Town COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


Town GET

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

Town GET › path Parameters

id
​string · pattern: \d+ · required

Town id değeri

Town GET › Responses

The request (GET or PUT) completed successfully.

İlçe nesnesi
id
​integer · required

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · required

İlçe adı.

Example: Üsküdar
status
​integer · enum

İlçenin aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
​LocationSummary
​TownGroupSummary

Town PUT

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

Town PUT › path Parameters

id
​string · pattern: \d+ · required

Güncellenecek Town id değeri

Town PUT › Request Body

İlçe nesnesi
id
​integer · required

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · required

İlçe adı.

Example: Üsküdar
status
​integer · enum

İlçenin aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
​LocationSummary
​TownGroupSummary

Town PUT › Responses

The request (GET or PUT) completed successfully.

İlçe nesnesi
id
​integer · required

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
name
​string · required

İlçe adı.

Example: Üsküdar
status
​integer · enum

İlçenin aktiflik durumu (0 = Pasif, 1 = Aktif).

Enum values:
0
1
​LocationSummary
​TownGroupSummary

Town DELETE

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

Town DELETE › path Parameters

id
​string · pattern: \d+ · required

Silinecek Town id değeri

Town DELETE › Responses

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

No data returned