Skip to content
Ideasoft
Admin API

OptionGroup

Serverhttps://your-store.myideasoft.com

OptionGroup LIST

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

Tüm Varyant Grubu (OptionGroup) nesnelerini filtreleyerek ve sayfalandırarak listeler. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

OptionGroup 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). Varyant grubu başlıklarında genel arama yapmak için kullanılır.

OptionGroup LIST › Responses

The request (GET or PUT) completed successfully.

Varyant grubu objesi (renk, beden vb.)
title
​string · maxLength: 255 · required

Varyant grubu başlığı

Example: Renk
id
​integer

Varyant grubu için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255

URL dostu benzersiz tanımlayıcı

Example: renk
sortOrder
​integer · min: 0 · max: 9999

Görüntüleme sırası

Example: 999
predefined
​integer · enum · writeOnly

Sistem öntanımlı mı?

Enum values:
0
1
Example: 0
filterStatus
​integer · enum

Filtre menüsünde göster

Enum values:
0
1
Example: 1
aggregator
​integer · enum

Filtre menüde gruplanma durumu

Enum values:
0
1
Example: 0
​OptionSummary[]

Varyant seçenekleri listesi (Kırmızı, Mavi vb.)


OptionGroup POST

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

OptionGroup POST › Request Body

Varyant grubu objesi (renk, beden vb.)
title
​string · maxLength: 255 · required

Varyant grubu başlığı

Example: Renk
id
​integer

Varyant grubu için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255

URL dostu benzersiz tanımlayıcı

Example: renk
sortOrder
​integer · min: 0 · max: 9999

Görüntüleme sırası

Example: 999
predefined
​integer · enum · writeOnly

Sistem öntanımlı mı?

Enum values:
0
1
Example: 0
filterStatus
​integer · enum

Filtre menüsünde göster

Enum values:
0
1
Example: 1
aggregator
​integer · enum

Filtre menüde gruplanma durumu

Enum values:
0
1
Example: 0
​OptionSummary[]

Varyant seçenekleri listesi (Kırmızı, Mavi vb.)

OptionGroup POST › Responses

The create request (POST) completed successfully.

Varyant grubu objesi (renk, beden vb.)
title
​string · maxLength: 255 · required

Varyant grubu başlığı

Example: Renk
id
​integer

Varyant grubu için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255

URL dostu benzersiz tanımlayıcı

Example: renk
sortOrder
​integer · min: 0 · max: 9999

Görüntüleme sırası

Example: 999
predefined
​integer · enum · writeOnly

Sistem öntanımlı mı?

Enum values:
0
1
Example: 0
filterStatus
​integer · enum

Filtre menüsünde göster

Enum values:
0
1
Example: 1
aggregator
​integer · enum

Filtre menüde gruplanma durumu

Enum values:
0
1
Example: 0
​OptionSummary[]

Varyant seçenekleri listesi (Kırmızı, Mavi vb.)


OptionGroup COUNT

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

Tüm Varyant Grubu (OptionGroup) nesnelerini filtreleyerek ve sayfalandırarak listeler. Sıralama (sort), sayfalama (limit, page), tekil veya çoklu ID (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

OptionGroup 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). Varyant grubu başlıklarında genel arama yapmak için kullanılır.

OptionGroup COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


OptionGroup GET

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

OptionGroup GET › path Parameters

id
​string · pattern: \d+ · required

OptionGroup GET › Responses

The request (GET or PUT) completed successfully.

Varyant grubu objesi (renk, beden vb.)
title
​string · maxLength: 255 · required

Varyant grubu başlığı

Example: Renk
id
​integer

Varyant grubu için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255

URL dostu benzersiz tanımlayıcı

Example: renk
sortOrder
​integer · min: 0 · max: 9999

Görüntüleme sırası

Example: 999
predefined
​integer · enum · writeOnly

Sistem öntanımlı mı?

Enum values:
0
1
Example: 0
filterStatus
​integer · enum

Filtre menüsünde göster

Enum values:
0
1
Example: 1
aggregator
​integer · enum

Filtre menüde gruplanma durumu

Enum values:
0
1
Example: 0
​OptionSummary[]

Varyant seçenekleri listesi (Kırmızı, Mavi vb.)


OptionGroup PUT

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

OptionGroup PUT › path Parameters

id
​string · pattern: \d+ · required

OptionGroup PUT › Request Body

Varyant grubu objesi (renk, beden vb.)
title
​string · maxLength: 255 · required

Varyant grubu başlığı

Example: Renk
id
​integer

Varyant grubu için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255

URL dostu benzersiz tanımlayıcı

Example: renk
sortOrder
​integer · min: 0 · max: 9999

Görüntüleme sırası

Example: 999
predefined
​integer · enum · writeOnly

Sistem öntanımlı mı?

Enum values:
0
1
Example: 0
filterStatus
​integer · enum

Filtre menüsünde göster

Enum values:
0
1
Example: 1
aggregator
​integer · enum

Filtre menüde gruplanma durumu

Enum values:
0
1
Example: 0
​OptionSummary[]

Varyant seçenekleri listesi (Kırmızı, Mavi vb.)

OptionGroup PUT › Responses

The request (GET or PUT) completed successfully.

Varyant grubu objesi (renk, beden vb.)
title
​string · maxLength: 255 · required

Varyant grubu başlığı

Example: Renk
id
​integer

Varyant grubu için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255

URL dostu benzersiz tanımlayıcı

Example: renk
sortOrder
​integer · min: 0 · max: 9999

Görüntüleme sırası

Example: 999
predefined
​integer · enum · writeOnly

Sistem öntanımlı mı?

Enum values:
0
1
Example: 0
filterStatus
​integer · enum

Filtre menüsünde göster

Enum values:
0
1
Example: 1
aggregator
​integer · enum

Filtre menüde gruplanma durumu

Enum values:
0
1
Example: 0
​OptionSummary[]

Varyant seçenekleri listesi (Kırmızı, Mavi vb.)


OptionGroup DELETE

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

OptionGroup DELETE › path Parameters

id
​string · pattern: \d+ · required

OptionGroup DELETE › Responses

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

No data returned