İçeriğe geç
Store API

OrderItem

Serverhttps://magaza-adiniz.myideasoft.com

OrderItem LIST

GET
https://magaza-adiniz.myideasoft.com
/api/order_items
Bearer

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

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı.

Default: 1
sinceId
​integer · min: 1

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

ids
​string

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

order
​integer · min: 1

Filtreleme için Order Id.

productName
​string

Product name.

productSku
​string

Product sku.

productBarcode
​string

Product barcode.

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

OrderItem LIST › Responses

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

id
​integer

Sipariş kaleminin benzersiz kimlik (ID) değeri.

Example: 123
productName
​string · maxLength: 255

Siparişteki ürünün adı.

Example: Kalem
productSku
​string · maxLength: 255

Ürünün stok kodu (SKU).

Example: KAL-1234
productBarcode
​string · maxLength: 255

Ürünün barkod numarası.

Example: 869456789874
productPrice
​number · float · min: 0

Ürünün birim fiyatı.

Example: 15
productCurrency
​string · maxLength: 32

Ürünün fiyatının para birimi. Seçenekler: | USD: Amerikan Doları | EUR: Euro | TL: Türk Lirası | GBP: İngiliz Sterlini | JPY: Japon Yeni | CNY: Çin Yuanı | GR: Yunan Drahmisi (tarihi kullanım) | CHF: İsviçre Frangı

Example: TL
productQuantity
​number · float · min: 0

Siparişteki ürün adedi (stok tipi cinsinden).

Example: 1
productTax
​integer · min: 0

Ürünün vergi oranı (yüzde cinsinden).

Example: 18
productDiscount
​number · float

Ürüne uygulanan standart indirim miktarı.

Example: 5
productMoneyOrderDiscount
​number · float · min: 0

Havale/EFT ile ödemede uygulanan indirim miktarı.

Example: 5
productWeight
​number · float · min: 0

Ürünün ağırlığı (kg veya ilgili stok tipi birimi).

Example: 1.2
productStockTypeLabel
​string · maxLength: 255

Ürünün stok tipi etiketi (ör. adet, kg, paket).

Example: Adet
isProductPromotioned
​integer · enum

Ürünün promosyon olup olmadığını belirten değer. Seçenekler: | 0: Ürün promosyon değil | 1: Ürün promosyon

Enum values:
0
1
Example: 0
discount
​number · float · min: 0

Ürüne uygulanan hediye çeki indirim değeri.

Example: 5
maxInstallment
​integer · writeOnly
priceRatio
​number · float · min: 0 · max: 5
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly
​ProductSummary

Ürün detay objesi

​DigitalProductSummary
​OrderItemCustomizationSummary[]

Sipariş kalemine uygulanan özelleştirmeler (OrderItemCustomization şeması ile ilişkili).

​OrderItemSubscriptionSummary

Sipariş kalemi ile ilişkili abonelik bilgilerini temsil eder.


OrderItem GET

GET
https://magaza-adiniz.myideasoft.com
/api/order_items/{id}
Bearer

OrderItem GET › path Parameters

id
​string · pattern: \d+ · required

OrderItem GET › Responses

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

id
​integer

Sipariş kaleminin benzersiz kimlik (ID) değeri.

Example: 123
productName
​string · maxLength: 255

Siparişteki ürünün adı.

Example: Kalem
productSku
​string · maxLength: 255

Ürünün stok kodu (SKU).

Example: KAL-1234
productBarcode
​string · maxLength: 255

Ürünün barkod numarası.

Example: 869456789874
productPrice
​number · float · min: 0

Ürünün birim fiyatı.

Example: 15
productCurrency
​string · maxLength: 32

Ürünün fiyatının para birimi. Seçenekler: | USD: Amerikan Doları | EUR: Euro | TL: Türk Lirası | GBP: İngiliz Sterlini | JPY: Japon Yeni | CNY: Çin Yuanı | GR: Yunan Drahmisi (tarihi kullanım) | CHF: İsviçre Frangı

Example: TL
productQuantity
​number · float · min: 0

Siparişteki ürün adedi (stok tipi cinsinden).

Example: 1
productTax
​integer · min: 0

Ürünün vergi oranı (yüzde cinsinden).

Example: 18
productDiscount
​number · float

Ürüne uygulanan standart indirim miktarı.

Example: 5
productMoneyOrderDiscount
​number · float · min: 0

Havale/EFT ile ödemede uygulanan indirim miktarı.

Example: 5
productWeight
​number · float · min: 0

Ürünün ağırlığı (kg veya ilgili stok tipi birimi).

Example: 1.2
productStockTypeLabel
​string · maxLength: 255

Ürünün stok tipi etiketi (ör. adet, kg, paket).

Example: Adet
isProductPromotioned
​integer · enum

Ürünün promosyon olup olmadığını belirten değer. Seçenekler: | 0: Ürün promosyon değil | 1: Ürün promosyon

Enum values:
0
1
Example: 0
discount
​number · float · min: 0

Ürüne uygulanan hediye çeki indirim değeri.

Example: 5
maxInstallment
​integer · writeOnly
priceRatio
​number · float · min: 0 · max: 5
createdAt
​string · date-time · writeOnly
updatedAt
​string · date-time · writeOnly
​ProductSummary

Ürün detay objesi

​DigitalProductSummary
​OrderItemCustomizationSummary[]

Sipariş kalemine uygulanan özelleştirmeler (OrderItemCustomization şeması ile ilişkili).

​OrderItemSubscriptionSummary

Sipariş kalemi ile ilişkili abonelik bilgilerini temsil eder.