Skip to content
Ideasoft
Store API

Town

Serverhttps://your-store.myideasoft.com

Town LIST

GET
https://your-store.myideasoft.com
/api/towns
Bearer

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

location
​integer · min: 1

Location id

townGroup
​integer · min: 1

Town Group id

name
​string

Town name.

status
​string · enum

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

Enum values:
0
1

Town LIST › Responses

The request (GET or PUT) completed successfully.

İlçe nesnesi
name
​string · maxLength: 255 · required

İlçe adı.

Example: Üsküdar
id
​integer

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
status
​string · enum · maxLength: 255

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

Enum values:
0
1
​LocationSummary
​TownGroupSummary

Town POST

POST
https://your-store.myideasoft.com
/api/towns
Bearer

Town POST › Request Body

İlçe nesnesi
name
​string · maxLength: 255 · required

İlçe adı.

Example: Üsküdar
id
​integer

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
status
​string · enum · maxLength: 255

İ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
name
​string · maxLength: 255 · required

İlçe adı.

Example: Üsküdar
id
​integer

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
status
​string · enum · maxLength: 255

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

Enum values:
0
1
​LocationSummary
​TownGroupSummary

Town GET

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

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
name
​string · maxLength: 255 · required

İlçe adı.

Example: Üsküdar
id
​integer

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
status
​string · enum · maxLength: 255

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

Enum values:
0
1
​LocationSummary
​TownGroupSummary

Town PUT

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

Town PUT › path Parameters

id
​string · pattern: \d+ · required

Güncellenecek Town id değeri

Town PUT › Request Body

İlçe nesnesi
name
​string · maxLength: 255 · required

İlçe adı.

Example: Üsküdar
id
​integer

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
status
​string · enum · maxLength: 255

İ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
name
​string · maxLength: 255 · required

İlçe adı.

Example: Üsküdar
id
​integer

İlçe nesnesine ait benzersiz kimlik numarası.

Example: 123
status
​string · enum · maxLength: 255

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

Enum values:
0
1
​LocationSummary
​TownGroupSummary

Town DELETE

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

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