Skip to content
Ideasoft
Store API

Option

Serverhttps://your-store.myideasoft.com

Option LIST

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

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
sinceId
​integer · min: 1

Belirtilen id değerinden sonraki kayıtları getirir

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. Örnek: ids=1,2,3,4

title
​string

Options title.

optionGroup
​integer · min: 1

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

q
​string

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

Option LIST › Responses

The request (GET or PUT) completed successfully.

Varyant seçenek objesi (renk değeri, beden değeri vb.)
title
​string · maxLength: 255 · required

Varyant değeri adı (Kırmızı, L, 42 vb.)

Example: Kırmızı
id
​integer

Varyant seçeneği için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255
sortOrder
​integer · min: 1 · max: 9999

Görüntüleme sırası

Example: 999
logo
​string · enum · pattern: ^[a-zA-Z0-9-_]+\.(jp…

Varyant görseli dosya adı (uzantı ile birlikte)

Enum values:
jpg
png
gif
jpeg
webp
avif
Example: kirmizi-logo.jpg
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded görsel verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
size
​integer · writeOnly
updatedAt
​string · date-time
createdAt
​string · date-time

Option POST

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

Option POST › Request Body

Varyant seçenek objesi (renk değeri, beden değeri vb.)
title
​string · maxLength: 255 · required

Varyant değeri adı (Kırmızı, L, 42 vb.)

Example: Kırmızı
id
​integer

Varyant seçeneği için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255
sortOrder
​integer · min: 1 · max: 9999

Görüntüleme sırası

Example: 999
logo
​string · enum · pattern: ^[a-zA-Z0-9-_]+\.(jp…

Varyant görseli dosya adı (uzantı ile birlikte)

Enum values:
jpg
png
gif
jpeg
webp
avif
Example: kirmizi-logo.jpg
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded görsel verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
size
​integer · writeOnly
updatedAt
​string · date-time
createdAt
​string · date-time

Option POST › Responses

The create request (POST) completed successfully.

Varyant seçenek objesi (renk değeri, beden değeri vb.)
title
​string · maxLength: 255 · required

Varyant değeri adı (Kırmızı, L, 42 vb.)

Example: Kırmızı
id
​integer

Varyant seçeneği için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255
sortOrder
​integer · min: 1 · max: 9999

Görüntüleme sırası

Example: 999
logo
​string · enum · pattern: ^[a-zA-Z0-9-_]+\.(jp…

Varyant görseli dosya adı (uzantı ile birlikte)

Enum values:
jpg
png
gif
jpeg
webp
avif
Example: kirmizi-logo.jpg
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded görsel verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
size
​integer · writeOnly
updatedAt
​string · date-time
createdAt
​string · date-time

Option GET

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

Option GET › path Parameters

id
​string · pattern: \d+ · required

Option GET › Responses

The request (GET or PUT) completed successfully.

Varyant seçenek objesi (renk değeri, beden değeri vb.)
title
​string · maxLength: 255 · required

Varyant değeri adı (Kırmızı, L, 42 vb.)

Example: Kırmızı
id
​integer

Varyant seçeneği için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255
sortOrder
​integer · min: 1 · max: 9999

Görüntüleme sırası

Example: 999
logo
​string · enum · pattern: ^[a-zA-Z0-9-_]+\.(jp…

Varyant görseli dosya adı (uzantı ile birlikte)

Enum values:
jpg
png
gif
jpeg
webp
avif
Example: kirmizi-logo.jpg
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded görsel verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
size
​integer · writeOnly
updatedAt
​string · date-time
createdAt
​string · date-time

Option PUT

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

Option PUT › path Parameters

id
​string · pattern: \d+ · required

Option PUT › Request Body

Varyant seçenek objesi (renk değeri, beden değeri vb.)
title
​string · maxLength: 255 · required

Varyant değeri adı (Kırmızı, L, 42 vb.)

Example: Kırmızı
id
​integer

Varyant seçeneği için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255
sortOrder
​integer · min: 1 · max: 9999

Görüntüleme sırası

Example: 999
logo
​string · enum · pattern: ^[a-zA-Z0-9-_]+\.(jp…

Varyant görseli dosya adı (uzantı ile birlikte)

Enum values:
jpg
png
gif
jpeg
webp
avif
Example: kirmizi-logo.jpg
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded görsel verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
size
​integer · writeOnly
updatedAt
​string · date-time
createdAt
​string · date-time

Option PUT › Responses

The request (GET or PUT) completed successfully.

Varyant seçenek objesi (renk değeri, beden değeri vb.)
title
​string · maxLength: 255 · required

Varyant değeri adı (Kırmızı, L, 42 vb.)

Example: Kırmızı
id
​integer

Varyant seçeneği için benzersiz kimlik

Example: 123
slug
​string · maxLength: 255
sortOrder
​integer · min: 1 · max: 9999

Görüntüleme sırası

Example: 999
logo
​string · enum · pattern: ^[a-zA-Z0-9-_]+\.(jp…

Varyant görseli dosya adı (uzantı ile birlikte)

Enum values:
jpg
png
gif
jpeg
webp
avif
Example: kirmizi-logo.jpg
​OptionGroupSummary

Varyant grubu objesi (renk, beden vb.)

attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded görsel verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
size
​integer · writeOnly
updatedAt
​string · date-time
createdAt
​string · date-time

Option DELETE

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

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