Skip to content
Ideasoft
Store API

Brand

Serverhttps://your-store.myideasoft.com

Brand LIST

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

Tüm Marka (Brand) 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.

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

Belirtilen ID değerinden daha büyük ID'ye sahip (sonraki) kayıtları getirir.

ids
​string

Çoklu listeleme için virgülle ayrılmış benzersiz kimlik değerleri (IDs) listesi.

name
​string

Brand Name.

status
​string · enum

Status can be 0 or 1

Enum values:
0
1
distributor
​string

Markanın ilişkili olduğu Tedarikçiye (Distributor) göre filtreleme yapar.

startDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

Start of the time frame

endDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

End of the time frame

startUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

Start of the time frame

endUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

End of the time frame

q
​string

Gelişmiş Filtreleme (Query Filter). Alan bazlı kesin filtreleme yapmak için kullanılır. Kullanım: q[<alan_adı>]=<değer>

Brand LIST › Responses

The request (GET or PUT) completed successfully.

Marka objesi
name
​string · maxLength: 255 · required

Marka adı

Example: Idea Kalem
id
​integer

Marka için benzersiz kimlik

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

Görüntüleme sırası

Example: 999
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
distributorCode
​string · maxLength: 255

Tedarikçi kodu

Example: TED-123
distributor
​string · maxLength: 255

Tedarikçi adı

Example: Super Tedarik
imageFile
​string · maxLength: 255

Marka logo dosya adı (JPG, PNG, GIF)

Example: kalem.jpg
showcaseContent
​string · maxLength: 65535

Marka sayfası üst içerik metni (HTML)

Example: <p>Üst içerik metni</p>
displayShowcaseContent
​integer · enum

Üst içerik gösterim durumu

Enum values:
0
1
Example: 1
showcaseFooterContent
​string · maxLength: 65535
displayShowcaseFooterContent
​integer
metaKeywords
​string · maxLength: 65535

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 65535

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
canonicalUrl
​string · maxLength: 255 · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded logo verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
isSearchable
​integer · enum
Enum values:
0
1
createdAt
​string · date-time

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255

Brand POST

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

Brand POST › Request Body

Marka objesi
name
​string · maxLength: 255 · required

Marka adı

Example: Idea Kalem
id
​integer

Marka için benzersiz kimlik

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

Görüntüleme sırası

Example: 999
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
distributorCode
​string · maxLength: 255

Tedarikçi kodu

Example: TED-123
distributor
​string · maxLength: 255

Tedarikçi adı

Example: Super Tedarik
imageFile
​string · maxLength: 255

Marka logo dosya adı (JPG, PNG, GIF)

Example: kalem.jpg
showcaseContent
​string · maxLength: 65535

Marka sayfası üst içerik metni (HTML)

Example: <p>Üst içerik metni</p>
displayShowcaseContent
​integer · enum

Üst içerik gösterim durumu

Enum values:
0
1
Example: 1
showcaseFooterContent
​string · maxLength: 65535
displayShowcaseFooterContent
​integer
metaKeywords
​string · maxLength: 65535

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 65535

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
canonicalUrl
​string · maxLength: 255 · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded logo verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
isSearchable
​integer · enum
Enum values:
0
1
createdAt
​string · date-time

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255

Brand POST › Responses

The create request (POST) completed successfully.

Marka objesi
name
​string · maxLength: 255 · required

Marka adı

Example: Idea Kalem
id
​integer

Marka için benzersiz kimlik

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

Görüntüleme sırası

Example: 999
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
distributorCode
​string · maxLength: 255

Tedarikçi kodu

Example: TED-123
distributor
​string · maxLength: 255

Tedarikçi adı

Example: Super Tedarik
imageFile
​string · maxLength: 255

Marka logo dosya adı (JPG, PNG, GIF)

Example: kalem.jpg
showcaseContent
​string · maxLength: 65535

Marka sayfası üst içerik metni (HTML)

Example: <p>Üst içerik metni</p>
displayShowcaseContent
​integer · enum

Üst içerik gösterim durumu

Enum values:
0
1
Example: 1
showcaseFooterContent
​string · maxLength: 65535
displayShowcaseFooterContent
​integer
metaKeywords
​string · maxLength: 65535

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 65535

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
canonicalUrl
​string · maxLength: 255 · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded logo verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
isSearchable
​integer · enum
Enum values:
0
1
createdAt
​string · date-time

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255

Brand GET

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

Brand GET › path Parameters

id
​string · pattern: \d+ · required

Brand GET › Responses

The request (GET or PUT) completed successfully.

Marka objesi
name
​string · maxLength: 255 · required

Marka adı

Example: Idea Kalem
id
​integer

Marka için benzersiz kimlik

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

Görüntüleme sırası

Example: 999
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
distributorCode
​string · maxLength: 255

Tedarikçi kodu

Example: TED-123
distributor
​string · maxLength: 255

Tedarikçi adı

Example: Super Tedarik
imageFile
​string · maxLength: 255

Marka logo dosya adı (JPG, PNG, GIF)

Example: kalem.jpg
showcaseContent
​string · maxLength: 65535

Marka sayfası üst içerik metni (HTML)

Example: <p>Üst içerik metni</p>
displayShowcaseContent
​integer · enum

Üst içerik gösterim durumu

Enum values:
0
1
Example: 1
showcaseFooterContent
​string · maxLength: 65535
displayShowcaseFooterContent
​integer
metaKeywords
​string · maxLength: 65535

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 65535

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
canonicalUrl
​string · maxLength: 255 · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded logo verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
isSearchable
​integer · enum
Enum values:
0
1
createdAt
​string · date-time

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255

Brand PUT

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

Brand PUT › path Parameters

id
​string · pattern: \d+ · required

Brand PUT › Request Body

Marka objesi
name
​string · maxLength: 255 · required

Marka adı

Example: Idea Kalem
id
​integer

Marka için benzersiz kimlik

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

Görüntüleme sırası

Example: 999
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
distributorCode
​string · maxLength: 255

Tedarikçi kodu

Example: TED-123
distributor
​string · maxLength: 255

Tedarikçi adı

Example: Super Tedarik
imageFile
​string · maxLength: 255

Marka logo dosya adı (JPG, PNG, GIF)

Example: kalem.jpg
showcaseContent
​string · maxLength: 65535

Marka sayfası üst içerik metni (HTML)

Example: <p>Üst içerik metni</p>
displayShowcaseContent
​integer · enum

Üst içerik gösterim durumu

Enum values:
0
1
Example: 1
showcaseFooterContent
​string · maxLength: 65535
displayShowcaseFooterContent
​integer
metaKeywords
​string · maxLength: 65535

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 65535

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
canonicalUrl
​string · maxLength: 255 · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded logo verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
isSearchable
​integer · enum
Enum values:
0
1
createdAt
​string · date-time

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255

Brand PUT › Responses

The request (GET or PUT) completed successfully.

Marka objesi
name
​string · maxLength: 255 · required

Marka adı

Example: Idea Kalem
id
​integer

Marka için benzersiz kimlik

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

Görüntüleme sırası

Example: 999
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
distributorCode
​string · maxLength: 255

Tedarikçi kodu

Example: TED-123
distributor
​string · maxLength: 255

Tedarikçi adı

Example: Super Tedarik
imageFile
​string · maxLength: 255

Marka logo dosya adı (JPG, PNG, GIF)

Example: kalem.jpg
showcaseContent
​string · maxLength: 65535

Marka sayfası üst içerik metni (HTML)

Example: <p>Üst içerik metni</p>
displayShowcaseContent
​integer · enum

Üst içerik gösterim durumu

Enum values:
0
1
Example: 1
showcaseFooterContent
​string · maxLength: 65535
displayShowcaseFooterContent
​integer
metaKeywords
​string · maxLength: 65535

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
metaDescription
​string · maxLength: 65535

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
canonicalUrl
​string · maxLength: 255 · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

Base64 encoded logo verisi (POST/PUT için)

Example: data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAA...
isSearchable
​integer · enum
Enum values:
0
1
createdAt
​string · date-time

Kayıt oluşturulma tarihi

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

Kayıt son güncellenme tarihi

Example: 2022-04-20T14:33:45+03:00
targetKeyword
​string · maxLength: 255

Brand DELETE

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

Brand DELETE › path Parameters

id
​string · pattern: \d+ · required

Brand DELETE › Responses

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

No data returned