İçeriğe geç
Admin API

Brand

Serverhttps://magaza-adiniz.myideasoft.com

Brand LIST

GET
https://magaza-adiniz.myideasoft.com
/admin-api/brands
Bearer
or
OAuth 2.0

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
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.

distributor
​string

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

displayShowcaseContent
​string · enum

displayShowcaseContent can be 0 1 or 2

Enum values:
0
1
2
status
​string · enum

Brand status search filter.

Enum values:
0
1
displayShowcaseFooterContent
​string · enum

displayShowcaseFooterContent can be 0 1 or 2

Enum values:
0
1
2
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). Marka adında genel arama yapmak için kullanılır.

Brand LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Marka objesi
id
​integer · required

Marka için benzersiz kimlik

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

Marka adı

Example: Idea Kalem
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası

Example: 999
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

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
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
metaDescription
​string

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
metaKeywords
​string

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
imageUrl
​string

Marka logo URL'i

Example: //test.myideasoft.com/test/a/01/marka/marka.jpg
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

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

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

Kayıt son güncellenme tarihi

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

Kayıt oluşturulma tarihi

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

Brand POST

POST
https://magaza-adiniz.myideasoft.com
/admin-api/brands
Bearer
or
OAuth 2.0

Brand POST › Request Body

Marka objesi
id
​integer · required

Marka için benzersiz kimlik

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

Marka adı

Example: Idea Kalem
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası

Example: 999
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

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
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
metaDescription
​string

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
metaKeywords
​string

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
imageUrl
​string

Marka logo URL'i

Example: //test.myideasoft.com/test/a/01/marka/marka.jpg
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

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

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

Kayıt son güncellenme tarihi

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

Kayıt oluşturulma tarihi

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

Brand POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

Marka objesi
id
​integer · required

Marka için benzersiz kimlik

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

Marka adı

Example: Idea Kalem
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası

Example: 999
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

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
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
metaDescription
​string

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
metaKeywords
​string

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
imageUrl
​string

Marka logo URL'i

Example: //test.myideasoft.com/test/a/01/marka/marka.jpg
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

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

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

Kayıt son güncellenme tarihi

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

Kayıt oluşturulma tarihi

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

Brand COUNT

GET
https://magaza-adiniz.myideasoft.com
/admin-api/brands/count
Bearer
or
OAuth 2.0

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 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.

distributor
​string

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

displayShowcaseContent
​string · enum

displayShowcaseContent can be 0 1 or 2

Enum values:
0
1
2
status
​string · enum

Brand status search filter.

Enum values:
0
1
displayShowcaseFooterContent
​string · enum

displayShowcaseFooterContent can be 0 1 or 2

Enum values:
0
1
2
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). Marka adında genel arama yapmak için kullanılır.

Brand COUNT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Kayıt sayısı yanıtı.
total_count
​integer · required

Filtrelere uyan toplam kayıt sayısı.


Brand GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/brands/{id}
Bearer
or
OAuth 2.0

Brand GET › path Parameters

id
​string · pattern: \d+ · required

Brand GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Marka objesi
id
​integer · required

Marka için benzersiz kimlik

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

Marka adı

Example: Idea Kalem
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası

Example: 999
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

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
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
metaDescription
​string

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
metaKeywords
​string

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
imageUrl
​string

Marka logo URL'i

Example: //test.myideasoft.com/test/a/01/marka/marka.jpg
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

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

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

Kayıt son güncellenme tarihi

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

Kayıt oluşturulma tarihi

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

Brand PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/brands/{id}
Bearer
or
OAuth 2.0

Brand PUT › path Parameters

id
​string · pattern: \d+ · required

Brand PUT › Request Body

Marka objesi
id
​integer · required

Marka için benzersiz kimlik

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

Marka adı

Example: Idea Kalem
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası

Example: 999
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

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
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
metaDescription
​string

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
metaKeywords
​string

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
imageUrl
​string

Marka logo URL'i

Example: //test.myideasoft.com/test/a/01/marka/marka.jpg
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

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

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

Kayıt son güncellenme tarihi

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

Kayıt oluşturulma tarihi

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

Brand PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Marka objesi
id
​integer · required

Marka için benzersiz kimlik

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

Marka adı

Example: Idea Kalem
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum

Marka aktiflik durumu

Enum values:
0
1
Example: 1
sortOrder
​integer · min: 0 · max: 999

Görüntüleme sırası

Example: 999
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

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
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
pageTitle
​string · maxLength: 255

SEO sayfa başlığı

Example: Idea Kalem - Kaliteli Kırtasiye
metaDescription
​string

SEO meta açıklama

Example: Kaliteli kırtasiye ürünleri
metaKeywords
​string

SEO meta anahtar kelimeler

Example: kırmızı, kalem, kırtasiye
canonicalUrl
​string · pattern: ^[a-z0-9-/]+$

Canonical URL (domain hariç)

Example: marka/idea-kalem
imageUrl
​string

Marka logo URL'i

Example: //test.myideasoft.com/test/a/01/marka/marka.jpg
attachment
​string · writeOnly · pattern: ^data:image\/(jpeg|j…

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

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

Kayıt son güncellenme tarihi

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

Kayıt oluşturulma tarihi

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

Brand DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/admin-api/brands/{id}
Bearer
or
OAuth 2.0

Brand DELETE › path Parameters

id
​string · pattern: \d+ · required

Brand DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned

Brand GetUsedIntegrationDistributors GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/brands/integration_distributors
Bearer
or
OAuth 2.0

Brand getUsedIntegrationDistributors

Brand GetUsedIntegrationDistributors GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

No data returned