Skip to content
Ideasoft
Admin API

Label

Serverhttps://your-store.myideasoft.com

Label LIST

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

Label 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 gelecek Labels 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. ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

parent
​string

Parent Id

root
​string · enum

Label root id

Enum values:
8
9
10
startCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt değeri için başlangıç tarihi

endCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt değeri için bitiş tarihi

startUpdatedAt
​string · date · pattern: yyyy-mm-dd

updatedAt değeri için başlangıç tarihi

endUpdatedAt
​string · date · pattern: yyyy-mm-dd

updatedAt değeri için bitiş tarihi

q
​string

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

s
​string

Arama anahtarı ile filtreleme.

Label LIST › Responses

The request (GET or PUT) completed successfully.

Kişisel etiket nesnesi
id
​integer · required

Kişisel etiket nesnesine ait benzersiz kimlik numarası.

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

Kişisel etiket Adı

slug
​string · minLength: 1 · maxLength: 255

Etiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.

Example: indirimli-urunler
sortOrder
​integer · min: 0 · max: 999

Kişisel etiket nesnesi için sıralama değeri.

Example: 10
status
​integer · enum

Etiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.

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

Kişisel etiket nesnesinin alt etiket barındırma durumu. Bu değer otomatik oluşturulur.

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

Kişisel etiket nesnesi sayfa başlığı.

Example: Etiket 1
metaDescription
​string
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
tree
​string

Etiket hiyerarşisi ağacı. Üst ve alt etiketler arasındaki ilişkileri gösterir.

​LabelSummary

Kişisel etiket nesnesi

​object

Bu etiketin sahip olduğu alt etiketlerin listesi.

updatedAt
​string · date-time

Kişisel etiket nesnesinin son güncellenme zamanı.

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

Kişisel etiket nesnesinin oluşturulma zamanı.

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

Label POST

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

Label POST › Request Body

Kişisel etiket nesnesi
id
​integer · required

Kişisel etiket nesnesine ait benzersiz kimlik numarası.

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

Kişisel etiket Adı

slug
​string · minLength: 1 · maxLength: 255

Etiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.

Example: indirimli-urunler
sortOrder
​integer · min: 0 · max: 999

Kişisel etiket nesnesi için sıralama değeri.

Example: 10
status
​integer · enum

Etiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.

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

Kişisel etiket nesnesinin alt etiket barındırma durumu. Bu değer otomatik oluşturulur.

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

Kişisel etiket nesnesi sayfa başlığı.

Example: Etiket 1
metaDescription
​string
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
tree
​string

Etiket hiyerarşisi ağacı. Üst ve alt etiketler arasındaki ilişkileri gösterir.

​LabelSummary

Kişisel etiket nesnesi

​object

Bu etiketin sahip olduğu alt etiketlerin listesi.

updatedAt
​string · date-time

Kişisel etiket nesnesinin son güncellenme zamanı.

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

Kişisel etiket nesnesinin oluşturulma zamanı.

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

Label POST › Responses

The create request (POST) completed successfully.

Kişisel etiket nesnesi
id
​integer · required

Kişisel etiket nesnesine ait benzersiz kimlik numarası.

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

Kişisel etiket Adı

slug
​string · minLength: 1 · maxLength: 255

Etiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.

Example: indirimli-urunler
sortOrder
​integer · min: 0 · max: 999

Kişisel etiket nesnesi için sıralama değeri.

Example: 10
status
​integer · enum

Etiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.

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

Kişisel etiket nesnesinin alt etiket barındırma durumu. Bu değer otomatik oluşturulur.

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

Kişisel etiket nesnesi sayfa başlığı.

Example: Etiket 1
metaDescription
​string
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
tree
​string

Etiket hiyerarşisi ağacı. Üst ve alt etiketler arasındaki ilişkileri gösterir.

​LabelSummary

Kişisel etiket nesnesi

​object

Bu etiketin sahip olduğu alt etiketlerin listesi.

updatedAt
​string · date-time

Kişisel etiket nesnesinin son güncellenme zamanı.

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

Kişisel etiket nesnesinin oluşturulma zamanı.

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

Label COUNT

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

Label 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 gelecek Labels 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. ids=1,2,3,4

sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

parent
​string

Parent Id

root
​string · enum

Label root id

Enum values:
8
9
10
startCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt değeri için başlangıç tarihi

endCreatedAt
​string · date · pattern: yyyy-mm-dd

createdAt değeri için bitiş tarihi

startUpdatedAt
​string · date · pattern: yyyy-mm-dd

updatedAt değeri için başlangıç tarihi

endUpdatedAt
​string · date · pattern: yyyy-mm-dd

updatedAt değeri için bitiş tarihi

q
​string

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

s
​string

Arama anahtarı ile filtreleme.

Label COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


Label GET

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

Label GET › path Parameters

id
​string · pattern: \d+ · required

Label GET › Responses

The request (GET or PUT) completed successfully.

Kişisel etiket nesnesi
id
​integer · required

Kişisel etiket nesnesine ait benzersiz kimlik numarası.

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

Kişisel etiket Adı

slug
​string · minLength: 1 · maxLength: 255

Etiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.

Example: indirimli-urunler
sortOrder
​integer · min: 0 · max: 999

Kişisel etiket nesnesi için sıralama değeri.

Example: 10
status
​integer · enum

Etiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.

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

Kişisel etiket nesnesinin alt etiket barındırma durumu. Bu değer otomatik oluşturulur.

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

Kişisel etiket nesnesi sayfa başlığı.

Example: Etiket 1
metaDescription
​string
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
tree
​string

Etiket hiyerarşisi ağacı. Üst ve alt etiketler arasındaki ilişkileri gösterir.

​LabelSummary

Kişisel etiket nesnesi

​object

Bu etiketin sahip olduğu alt etiketlerin listesi.

updatedAt
​string · date-time

Kişisel etiket nesnesinin son güncellenme zamanı.

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

Kişisel etiket nesnesinin oluşturulma zamanı.

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

Label PUT

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

Label PUT › path Parameters

id
​string · pattern: \d+ · required

Label PUT › Request Body

Kişisel etiket nesnesi
id
​integer · required

Kişisel etiket nesnesine ait benzersiz kimlik numarası.

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

Kişisel etiket Adı

slug
​string · minLength: 1 · maxLength: 255

Etiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.

Example: indirimli-urunler
sortOrder
​integer · min: 0 · max: 999

Kişisel etiket nesnesi için sıralama değeri.

Example: 10
status
​integer · enum

Etiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.

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

Kişisel etiket nesnesinin alt etiket barındırma durumu. Bu değer otomatik oluşturulur.

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

Kişisel etiket nesnesi sayfa başlığı.

Example: Etiket 1
metaDescription
​string
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
tree
​string

Etiket hiyerarşisi ağacı. Üst ve alt etiketler arasındaki ilişkileri gösterir.

​LabelSummary

Kişisel etiket nesnesi

​object

Bu etiketin sahip olduğu alt etiketlerin listesi.

updatedAt
​string · date-time

Kişisel etiket nesnesinin son güncellenme zamanı.

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

Kişisel etiket nesnesinin oluşturulma zamanı.

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

Label PUT › Responses

The request (GET or PUT) completed successfully.

Kişisel etiket nesnesi
id
​integer · required

Kişisel etiket nesnesine ait benzersiz kimlik numarası.

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

Kişisel etiket Adı

slug
​string · minLength: 1 · maxLength: 255

Etiketin URL’de kullanılacak slug değeri. SEO dostu kısa bir metin olmalıdır.

Example: indirimli-urunler
sortOrder
​integer · min: 0 · max: 999

Kişisel etiket nesnesi için sıralama değeri.

Example: 10
status
​integer · enum

Etiketin aktiflik durumu (0 = Pasif, 1 = Aktif). Pasif etiketler kullanıcıya gösterilmez.

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

Kişisel etiket nesnesinin alt etiket barındırma durumu. Bu değer otomatik oluşturulur.

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

Kişisel etiket nesnesi sayfa başlığı.

Example: Etiket 1
metaDescription
​string
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

Example: kırmızı, kalem, kırtasiye
tree
​string

Etiket hiyerarşisi ağacı. Üst ve alt etiketler arasındaki ilişkileri gösterir.

​LabelSummary

Kişisel etiket nesnesi

​object

Bu etiketin sahip olduğu alt etiketlerin listesi.

updatedAt
​string · date-time

Kişisel etiket nesnesinin son güncellenme zamanı.

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

Kişisel etiket nesnesinin oluşturulma zamanı.

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

Label DELETE

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

Label DELETE › path Parameters

id
​string · pattern: \d+ · required

Label DELETE › Responses

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

No data returned

Label TreeAction GET

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

Label TreeAction GET › query Parameters

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek Labels adedi

id
​integer · min: 1

Tekli listeleme için id değeri.

q
​string

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

s
​string

Arama anahtarı ile filtreleme.

Label TreeAction GET › Responses

The request (GET or PUT) completed successfully.

No data returned

Label SearchTreeAction GET

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

Label SearchTreeAction GET › query Parameters

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek Labels adedi

id
​integer · min: 1

Tekli listeleme için id değeri.

q
​string

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

s
​string

Arama anahtarı ile filtreleme.

onlyChild
​string · enum

Is only child

Enum values:
0
1
parent
​string

Parent Id

Label SearchTreeAction GET › Responses

The request (GET or PUT) completed successfully.

No data returned