İçeriğe geç
Admin API

PackageItem

Serverhttps://magaza-adiniz.myideasoft.com

PackageItem LIST

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

Tüm Paket Kalemi (PackageItem) 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.

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

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

Oluşturulma tarihi (createdAt) için başlangıç zamanı.

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

Oluşturulma tarihi (createdAt) için bitiş zamanı.

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

Güncellenme tarihi (updatedAt) için başlangıç zamanı.

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

Güncellenme tarihi (updatedAt) için bitiş zamanı.

package
​integer · min: 1

Package ait olduğu Paket ID'sine (Package ID) göre filtreleme yapar.

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). Genel arama yapmak için kullanılır.

PackageItem LIST › Responses

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

Paket kalemi objesi
id
​integer · required

Paket kalemi için benzersiz kimlik

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

Paket kalemi adı

Example: Ana Ürün
choiceType
​string · enum

Seçim tipi

Enum values:
singular
plural
Example: singular
isRequired
​integer · enum

Zorunlu alan mı?

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

Görüntüleme sırası

Example: 999
​PackageSummary
​CategorySummary

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

​ProductSummary[] · maxItems: 50

Seçilebilir ürünler listesi

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

PackageItem POST

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

PackageItem POST › Request Body

Paket kalemi objesi
id
​integer · required

Paket kalemi için benzersiz kimlik

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

Paket kalemi adı

Example: Ana Ürün
choiceType
​string · enum

Seçim tipi

Enum values:
singular
plural
Example: singular
isRequired
​integer · enum

Zorunlu alan mı?

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

Görüntüleme sırası

Example: 999
​PackageSummary
​CategorySummary

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

​ProductSummary[] · maxItems: 50

Seçilebilir ürünler listesi

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

PackageItem POST › Responses

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

Paket kalemi objesi
id
​integer · required

Paket kalemi için benzersiz kimlik

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

Paket kalemi adı

Example: Ana Ürün
choiceType
​string · enum

Seçim tipi

Enum values:
singular
plural
Example: singular
isRequired
​integer · enum

Zorunlu alan mı?

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

Görüntüleme sırası

Example: 999
​PackageSummary
​CategorySummary

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

​ProductSummary[] · maxItems: 50

Seçilebilir ürünler listesi

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

PackageItem COUNT

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

Tüm Paket Kalemi (PackageItem) 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.

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

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

Oluşturulma tarihi (createdAt) için başlangıç zamanı.

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

Oluşturulma tarihi (createdAt) için bitiş zamanı.

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

Güncellenme tarihi (updatedAt) için başlangıç zamanı.

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

Güncellenme tarihi (updatedAt) için bitiş zamanı.

package
​integer · min: 1

Package ait olduğu Paket ID'sine (Package ID) göre filtreleme yapar.

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). Genel arama yapmak için kullanılır.

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


PackageItem GET

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

PackageItem GET › path Parameters

id
​string · pattern: \d+ · required

PackageItem GET › Responses

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

Paket kalemi objesi
id
​integer · required

Paket kalemi için benzersiz kimlik

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

Paket kalemi adı

Example: Ana Ürün
choiceType
​string · enum

Seçim tipi

Enum values:
singular
plural
Example: singular
isRequired
​integer · enum

Zorunlu alan mı?

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

Görüntüleme sırası

Example: 999
​PackageSummary
​CategorySummary

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

​ProductSummary[] · maxItems: 50

Seçilebilir ürünler listesi

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

PackageItem PUT

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

PackageItem PUT › path Parameters

id
​string · pattern: \d+ · required

PackageItem PUT › Request Body

Paket kalemi objesi
id
​integer · required

Paket kalemi için benzersiz kimlik

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

Paket kalemi adı

Example: Ana Ürün
choiceType
​string · enum

Seçim tipi

Enum values:
singular
plural
Example: singular
isRequired
​integer · enum

Zorunlu alan mı?

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

Görüntüleme sırası

Example: 999
​PackageSummary
​CategorySummary

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

​ProductSummary[] · maxItems: 50

Seçilebilir ürünler listesi

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

PackageItem PUT › Responses

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

Paket kalemi objesi
id
​integer · required

Paket kalemi için benzersiz kimlik

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

Paket kalemi adı

Example: Ana Ürün
choiceType
​string · enum

Seçim tipi

Enum values:
singular
plural
Example: singular
isRequired
​integer · enum

Zorunlu alan mı?

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

Görüntüleme sırası

Example: 999
​PackageSummary
​CategorySummary

Ürünlerin gruplandırıldığı kategori modelidir. Her kategori, ürünlerin mağazada nasıl listeleneceğini ve gösterileceğini belirler.

​ProductSummary[] · maxItems: 50

Seçilebilir ürünler listesi

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

PackageItem DELETE

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

PackageItem DELETE › path Parameters

id
​string · pattern: \d+ · required

PackageItem DELETE › Responses

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

No data returned