Skip to content
Ideasoft
Admin API

Option

Serverhttps://your-store.myideasoft.com

Option LIST

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

Option 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 dönecek Option 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. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen id değerinden sonraki kayıtları getirir

q
​string

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

optionGroup
​integer · min: 1

Option Group Id değeriyle filtreleme yapılır

s
​string

Arama anahtarı ile genel filtreleme yapılır

Option LIST › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Varyant nesnesinin kimlik değeri

Example: 123
title
​string · maxLength: 255 · required

Varyant başlığı. Örneğin, Varyant Grubu renk ise bu değer "Kırmızı" olabilir.

Example: Kırmızı 1
sortOrder
​integer · min: 0 · max: 9999 · required

Varyantın sıralama değeri

Example: 999
slug
​string · minLength: 1 · maxLength: 255

Slug değeri, ilgili varyantın URL'de kullanılacak değeri

Example: kirmizi-1
logo
​string

Varyant logosu

attachment
​string · writeOnly

Varyant logosunun dosya bilgisi

imageUrl
​string

Varyant imajının URL adresi

size
​integer · enum · writeOnly

Varyant logosu boyutu (piksel) Seçenekler: | 16: 16 px | 24: 24 px | 32: 32 px | 64: 64 px | 128: 128 px

Enum values:
16
24
32
64
128
256
512
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

updatedAt
​string · date-time

Varyantın güncellenme zamanı

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Varyantın oluşturulma zamanı

Example: 2022-04-20T14:33:45+03:00

Option POST

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

Option POST › Request Body

id
​integer · required

Varyant nesnesinin kimlik değeri

Example: 123
title
​string · maxLength: 255 · required

Varyant başlığı. Örneğin, Varyant Grubu renk ise bu değer "Kırmızı" olabilir.

Example: Kırmızı 1
sortOrder
​integer · min: 0 · max: 9999 · required

Varyantın sıralama değeri

Example: 999
slug
​string · minLength: 1 · maxLength: 255

Slug değeri, ilgili varyantın URL'de kullanılacak değeri

Example: kirmizi-1
logo
​string

Varyant logosu

attachment
​string · writeOnly

Varyant logosunun dosya bilgisi

imageUrl
​string

Varyant imajının URL adresi

size
​integer · enum · writeOnly

Varyant logosu boyutu (piksel) Seçenekler: | 16: 16 px | 24: 24 px | 32: 32 px | 64: 64 px | 128: 128 px

Enum values:
16
24
32
64
128
256
512
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

updatedAt
​string · date-time

Varyantın güncellenme zamanı

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Varyantın oluşturulma zamanı

Example: 2022-04-20T14:33:45+03:00

Option POST › Responses

The create request (POST) completed successfully.

id
​integer · required

Varyant nesnesinin kimlik değeri

Example: 123
title
​string · maxLength: 255 · required

Varyant başlığı. Örneğin, Varyant Grubu renk ise bu değer "Kırmızı" olabilir.

Example: Kırmızı 1
sortOrder
​integer · min: 0 · max: 9999 · required

Varyantın sıralama değeri

Example: 999
slug
​string · minLength: 1 · maxLength: 255

Slug değeri, ilgili varyantın URL'de kullanılacak değeri

Example: kirmizi-1
logo
​string

Varyant logosu

attachment
​string · writeOnly

Varyant logosunun dosya bilgisi

imageUrl
​string

Varyant imajının URL adresi

size
​integer · enum · writeOnly

Varyant logosu boyutu (piksel) Seçenekler: | 16: 16 px | 24: 24 px | 32: 32 px | 64: 64 px | 128: 128 px

Enum values:
16
24
32
64
128
256
512
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

updatedAt
​string · date-time

Varyantın güncellenme zamanı

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Varyantın oluşturulma zamanı

Example: 2022-04-20T14:33:45+03:00

Option COUNT

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

Option 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 dönecek Option 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. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen id değerinden sonraki kayıtları getirir

q
​string

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

optionGroup
​integer · min: 1

Option Group Id değeriyle filtreleme yapılır

s
​string

Arama anahtarı ile genel filtreleme yapılır

Option COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


Option GET

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

Option GET › path Parameters

id
​string · pattern: \d+ · required

Option GET › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Varyant nesnesinin kimlik değeri

Example: 123
title
​string · maxLength: 255 · required

Varyant başlığı. Örneğin, Varyant Grubu renk ise bu değer "Kırmızı" olabilir.

Example: Kırmızı 1
sortOrder
​integer · min: 0 · max: 9999 · required

Varyantın sıralama değeri

Example: 999
slug
​string · minLength: 1 · maxLength: 255

Slug değeri, ilgili varyantın URL'de kullanılacak değeri

Example: kirmizi-1
logo
​string

Varyant logosu

attachment
​string · writeOnly

Varyant logosunun dosya bilgisi

imageUrl
​string

Varyant imajının URL adresi

size
​integer · enum · writeOnly

Varyant logosu boyutu (piksel) Seçenekler: | 16: 16 px | 24: 24 px | 32: 32 px | 64: 64 px | 128: 128 px

Enum values:
16
24
32
64
128
256
512
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

updatedAt
​string · date-time

Varyantın güncellenme zamanı

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Varyantın oluşturulma zamanı

Example: 2022-04-20T14:33:45+03:00

Option PUT

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

Option PUT › path Parameters

id
​string · pattern: \d+ · required

Option PUT › Request Body

id
​integer · required

Varyant nesnesinin kimlik değeri

Example: 123
title
​string · maxLength: 255 · required

Varyant başlığı. Örneğin, Varyant Grubu renk ise bu değer "Kırmızı" olabilir.

Example: Kırmızı 1
sortOrder
​integer · min: 0 · max: 9999 · required

Varyantın sıralama değeri

Example: 999
slug
​string · minLength: 1 · maxLength: 255

Slug değeri, ilgili varyantın URL'de kullanılacak değeri

Example: kirmizi-1
logo
​string

Varyant logosu

attachment
​string · writeOnly

Varyant logosunun dosya bilgisi

imageUrl
​string

Varyant imajının URL adresi

size
​integer · enum · writeOnly

Varyant logosu boyutu (piksel) Seçenekler: | 16: 16 px | 24: 24 px | 32: 32 px | 64: 64 px | 128: 128 px

Enum values:
16
24
32
64
128
256
512
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

updatedAt
​string · date-time

Varyantın güncellenme zamanı

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Varyantın oluşturulma zamanı

Example: 2022-04-20T14:33:45+03:00

Option PUT › Responses

The request (GET or PUT) completed successfully.

id
​integer · required

Varyant nesnesinin kimlik değeri

Example: 123
title
​string · maxLength: 255 · required

Varyant başlığı. Örneğin, Varyant Grubu renk ise bu değer "Kırmızı" olabilir.

Example: Kırmızı 1
sortOrder
​integer · min: 0 · max: 9999 · required

Varyantın sıralama değeri

Example: 999
slug
​string · minLength: 1 · maxLength: 255

Slug değeri, ilgili varyantın URL'de kullanılacak değeri

Example: kirmizi-1
logo
​string

Varyant logosu

attachment
​string · writeOnly

Varyant logosunun dosya bilgisi

imageUrl
​string

Varyant imajının URL adresi

size
​integer · enum · writeOnly

Varyant logosu boyutu (piksel) Seçenekler: | 16: 16 px | 24: 24 px | 32: 32 px | 64: 64 px | 128: 128 px

Enum values:
16
24
32
64
128
256
512
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

updatedAt
​string · date-time

Varyantın güncellenme zamanı

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Varyantın oluşturulma zamanı

Example: 2022-04-20T14:33:45+03:00

Option DELETE

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

Option DELETE › path Parameters

id
​string · pattern: \d+ · required

Option DELETE › Responses

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

No data returned