İçeriğe geç
Admin API

Package

Serverhttps://magaza-adiniz.myideasoft.com

Package LIST

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

Package 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 görüntülenecek Package sayısı

Default: 20
page
​integer · min: 1

Başlanacak sayfa numarası

Default: 1
id
​integer · min: 1

Tekli Package listeleme için id değeri

ids
​string

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

sinceId
​integer · min: 1

Belirtilen id değerinden sonraki kayıtları getirir

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

createdAt başlangıç tarihi

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

createdAt bitiş tarihi

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

updatedAt başlangıç tarihi

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

updatedAt bitiş tarihi

q
​string

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

s
​string

Arama anahtarı ile filtreleme

Package LIST › Responses

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

id
​integer · required

Paket nesnesi kimlik değeri.

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

Paket nesnesi ismi.

Example: Ofis Seti
slug
​string · maxLength: 255

Slug değeri, ilgili nesnenin URL değeridir.

Example: ofis-seti
description
​string

Paket nesnesi açıklama alanı.

Example: Ofis malzemeleri içeren avantajlı paket.
​PackageItemSummary[] · maxItems: 20

Paket kalemi nesnesi listesi.

status
​integer · enum

Paket aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Sayfa başlığı.

Example: Ofis Seti - Kaliteli Ürünler
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
updatedAt
​string · date-time

Paket nesnesinin güncellenme zamanı.

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

Paket nesnesinin oluşturulma zamanı.

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

Package POST

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

Package POST › Request Body

id
​integer · required

Paket nesnesi kimlik değeri.

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

Paket nesnesi ismi.

Example: Ofis Seti
slug
​string · maxLength: 255

Slug değeri, ilgili nesnenin URL değeridir.

Example: ofis-seti
description
​string

Paket nesnesi açıklama alanı.

Example: Ofis malzemeleri içeren avantajlı paket.
​PackageItemSummary[] · maxItems: 20

Paket kalemi nesnesi listesi.

status
​integer · enum

Paket aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Sayfa başlığı.

Example: Ofis Seti - Kaliteli Ürünler
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
updatedAt
​string · date-time

Paket nesnesinin güncellenme zamanı.

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

Paket nesnesinin oluşturulma zamanı.

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

Package POST › Responses

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

id
​integer · required

Paket nesnesi kimlik değeri.

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

Paket nesnesi ismi.

Example: Ofis Seti
slug
​string · maxLength: 255

Slug değeri, ilgili nesnenin URL değeridir.

Example: ofis-seti
description
​string

Paket nesnesi açıklama alanı.

Example: Ofis malzemeleri içeren avantajlı paket.
​PackageItemSummary[] · maxItems: 20

Paket kalemi nesnesi listesi.

status
​integer · enum

Paket aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Sayfa başlığı.

Example: Ofis Seti - Kaliteli Ürünler
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
updatedAt
​string · date-time

Paket nesnesinin güncellenme zamanı.

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

Paket nesnesinin oluşturulma zamanı.

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

Package COUNT

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

Package 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 görüntülenecek Package sayısı

Default: 20
page
​integer · min: 1

Başlanacak sayfa numarası

Default: 1
id
​integer · min: 1

Tekli Package listeleme için id değeri

ids
​string

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

sinceId
​integer · min: 1

Belirtilen id değerinden sonraki kayıtları getirir

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

createdAt başlangıç tarihi

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

createdAt bitiş tarihi

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

updatedAt başlangıç tarihi

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

updatedAt bitiş tarihi

q
​string

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

s
​string

Arama anahtarı ile filtreleme

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


Package GET

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

Package GET › path Parameters

id
​string · pattern: \d+ · required

Package GET › Responses

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

id
​integer · required

Paket nesnesi kimlik değeri.

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

Paket nesnesi ismi.

Example: Ofis Seti
slug
​string · maxLength: 255

Slug değeri, ilgili nesnenin URL değeridir.

Example: ofis-seti
description
​string

Paket nesnesi açıklama alanı.

Example: Ofis malzemeleri içeren avantajlı paket.
​PackageItemSummary[] · maxItems: 20

Paket kalemi nesnesi listesi.

status
​integer · enum

Paket aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Sayfa başlığı.

Example: Ofis Seti - Kaliteli Ürünler
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
updatedAt
​string · date-time

Paket nesnesinin güncellenme zamanı.

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

Paket nesnesinin oluşturulma zamanı.

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

Package PUT

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

Package PUT › path Parameters

id
​string · pattern: \d+ · required

Package PUT › Request Body

id
​integer · required

Paket nesnesi kimlik değeri.

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

Paket nesnesi ismi.

Example: Ofis Seti
slug
​string · maxLength: 255

Slug değeri, ilgili nesnenin URL değeridir.

Example: ofis-seti
description
​string

Paket nesnesi açıklama alanı.

Example: Ofis malzemeleri içeren avantajlı paket.
​PackageItemSummary[] · maxItems: 20

Paket kalemi nesnesi listesi.

status
​integer · enum

Paket aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Sayfa başlığı.

Example: Ofis Seti - Kaliteli Ürünler
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
updatedAt
​string · date-time

Paket nesnesinin güncellenme zamanı.

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

Paket nesnesinin oluşturulma zamanı.

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

Package PUT › Responses

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

id
​integer · required

Paket nesnesi kimlik değeri.

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

Paket nesnesi ismi.

Example: Ofis Seti
slug
​string · maxLength: 255

Slug değeri, ilgili nesnenin URL değeridir.

Example: ofis-seti
description
​string

Paket nesnesi açıklama alanı.

Example: Ofis malzemeleri içeren avantajlı paket.
​PackageItemSummary[] · maxItems: 20

Paket kalemi nesnesi listesi.

status
​integer · enum

Paket aktiflik durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

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

Sayfa başlığı.

Example: Ofis Seti - Kaliteli Ürünler
metaKeywords
​string

Arama motorları tarafından tespit edilebilecek anahtar kelimeler.

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

Arama motorları tarafından tespit edilebilecek açıklama yazısı.

Example: Kaliteli kırtasiye ürünleri.
updatedAt
​string · date-time

Paket nesnesinin güncellenme zamanı.

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

Paket nesnesinin oluşturulma zamanı.

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

Package DELETE

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

Package DELETE › path Parameters

id
​string · pattern: \d+ · required

Package DELETE › Responses

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

No data returned