T-SOFT/Storefront API/Bölgeler

Bölgeler

Coğrafi bölgeleri (ülke, şehir, ilçe vb.) döndürür. Her kayıt bölge adı, türü, kodu ve üst bölge kodunu içerir; adres/konum seçimi için hiyerarşik gezinmeye uygundur. Salt-okunur katalog kaynağıdır. Erişim için okuma token'ı gerekir: Authorization: Bearer <TOKEN> ve Accept: application/vnd.api+json başlıklarını gönder.

Yetki:storefront:read — herkese açık, token isteğe bağlı.

Listeleme

GET /regions

curl -s 'https://<domain>/api/v3/storefront/2026-01/regions?filter[type]=city' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer <TOKEN>'

Örnek bir bölge kaydı:

{
  "type": "regions",
  "id": "34",
  "attributes": {
    "name": "İstanbul",
    "type": "city",
    "code": "34",
    "parentCode": "TR",
    "hasState": true,
    "phoneCode": 90,
    "postalCodePattern": "34XXX"
  }
}

Tek kayıt

GET /regions/{id}

curl -s 'https://<domain>/api/v3/storefront/2026-01/regions/34' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer <TOKEN>'

Alanlar

Alan	Açıklama
`name`	Bölge adı
`type`	Bölge türü (ülke/şehir/ilçe vb.)
`code`	Bölge kodu
`parentCode`	Üst bölgenin kodu
`hasState`	Alt bölge (eyalet/il) var mı?
`phoneCode`	Telefon alan kodu
`postalCodePattern`	Posta kodu deseni

Filtreler

Filtre	Örnek	Davranış
`id`	`filter[id]=34,06`	Verilen id'lerle sınırlar (virgülle çoklu)
`type`	`filter[type]=city`	Bölge türüne göre daraltır
`parent`	`filter[parent]=TR`	Üst bölge koduna göre alt bölgeleri getirir

Sıralama

Sort	Anlamı
`name`	Alfabetik

Kayıt id'si [A-Za-z0-9]{1,30} desenine uyar. Hiyerarşide gezinmek için önce üst bölgeyi listele, sonra filter[parent]=<code> ile alt bölgeleri çek.