İçeriğe geç
Store API

ShipmentItem

Serverhttps://magaza-adiniz.myideasoft.com

ShipmentItem LIST

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

ShipmentItem 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 sonuç 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. Örnek ids=1,2,3,4

product
​integer · min: 1

Ürün id

shipment
​integer · min: 1

Teslimat id

orderItem
​integer · min: 1

Sipariş kalemi id

startDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

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

endDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

createdAt değeri için bitiş tarihi

startUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

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

endUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

updatedAt değeri için bitiş tarihi

ShipmentItem LIST › Responses

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

Sevkiyat kalemi objesi
amount
​integer · min: 0 · required

Gönderilen miktar (stok tipi cinsinden)

Example: 2
price
​number · float · min: 0 · required

Birim fiyat

Example: 20
currency
​string · enum · maxLength: 255 · required

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
dm3
​number · float · min: 0 · required

Desi (hacimsel ağırlık)

Example: 1.5
status
​integer · enum · required

Sevkiyat kalemi aktiflik durumu

Enum values:
0
1
Example: 1
​OrderItemSummary · required
id
​integer

Sevkiyat kalemi için benzersiz kimlik

Example: 123
rootProductId
​integer · min: 0

Ana ürün kimliği (varyantlar için)

Example: 123
productLabel
​string · maxLength: 255

Ürün adı/başlığı

Example: Kırmızı Kalem
tax
​integer · min: 0

KDV oranı (%)

Example: 18
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​ProductSummary

Ürün detay objesi

​ShipmentSummary

ShipmentItem POST

POST
https://magaza-adiniz.myideasoft.com
/api/shipment_items
Bearer

ShipmentItem POST › Request Body

Sevkiyat kalemi objesi
amount
​integer · min: 0 · required

Gönderilen miktar (stok tipi cinsinden)

Example: 2
price
​number · float · min: 0 · required

Birim fiyat

Example: 20
currency
​string · enum · maxLength: 255 · required

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
dm3
​number · float · min: 0 · required

Desi (hacimsel ağırlık)

Example: 1.5
status
​integer · enum · required

Sevkiyat kalemi aktiflik durumu

Enum values:
0
1
Example: 1
​OrderItemSummary · required
id
​integer

Sevkiyat kalemi için benzersiz kimlik

Example: 123
rootProductId
​integer · min: 0

Ana ürün kimliği (varyantlar için)

Example: 123
productLabel
​string · maxLength: 255

Ürün adı/başlığı

Example: Kırmızı Kalem
tax
​integer · min: 0

KDV oranı (%)

Example: 18
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​ProductSummary

Ürün detay objesi

​ShipmentSummary

ShipmentItem POST › Responses

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

Sevkiyat kalemi objesi
amount
​integer · min: 0 · required

Gönderilen miktar (stok tipi cinsinden)

Example: 2
price
​number · float · min: 0 · required

Birim fiyat

Example: 20
currency
​string · enum · maxLength: 255 · required

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
dm3
​number · float · min: 0 · required

Desi (hacimsel ağırlık)

Example: 1.5
status
​integer · enum · required

Sevkiyat kalemi aktiflik durumu

Enum values:
0
1
Example: 1
​OrderItemSummary · required
id
​integer

Sevkiyat kalemi için benzersiz kimlik

Example: 123
rootProductId
​integer · min: 0

Ana ürün kimliği (varyantlar için)

Example: 123
productLabel
​string · maxLength: 255

Ürün adı/başlığı

Example: Kırmızı Kalem
tax
​integer · min: 0

KDV oranı (%)

Example: 18
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​ProductSummary

Ürün detay objesi

​ShipmentSummary

ShipmentItem GET

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

ShipmentItem GET › path Parameters

id
​string · pattern: \d+ · required

Teslimat Kalemi nesnesinin id değeri

ShipmentItem GET › Responses

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

Sevkiyat kalemi objesi
amount
​integer · min: 0 · required

Gönderilen miktar (stok tipi cinsinden)

Example: 2
price
​number · float · min: 0 · required

Birim fiyat

Example: 20
currency
​string · enum · maxLength: 255 · required

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
dm3
​number · float · min: 0 · required

Desi (hacimsel ağırlık)

Example: 1.5
status
​integer · enum · required

Sevkiyat kalemi aktiflik durumu

Enum values:
0
1
Example: 1
​OrderItemSummary · required
id
​integer

Sevkiyat kalemi için benzersiz kimlik

Example: 123
rootProductId
​integer · min: 0

Ana ürün kimliği (varyantlar için)

Example: 123
productLabel
​string · maxLength: 255

Ürün adı/başlığı

Example: Kırmızı Kalem
tax
​integer · min: 0

KDV oranı (%)

Example: 18
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​ProductSummary

Ürün detay objesi

​ShipmentSummary

ShipmentItem PUT

PUT
https://magaza-adiniz.myideasoft.com
/api/shipment_items/{id}
Bearer

ShipmentItem PUT › path Parameters

id
​string · pattern: \d+ · required

Teslimat Kalemi nesnesinin id değeri

ShipmentItem PUT › Request Body

Sevkiyat kalemi objesi
amount
​integer · min: 0 · required

Gönderilen miktar (stok tipi cinsinden)

Example: 2
price
​number · float · min: 0 · required

Birim fiyat

Example: 20
currency
​string · enum · maxLength: 255 · required

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
dm3
​number · float · min: 0 · required

Desi (hacimsel ağırlık)

Example: 1.5
status
​integer · enum · required

Sevkiyat kalemi aktiflik durumu

Enum values:
0
1
Example: 1
​OrderItemSummary · required
id
​integer

Sevkiyat kalemi için benzersiz kimlik

Example: 123
rootProductId
​integer · min: 0

Ana ürün kimliği (varyantlar için)

Example: 123
productLabel
​string · maxLength: 255

Ürün adı/başlığı

Example: Kırmızı Kalem
tax
​integer · min: 0

KDV oranı (%)

Example: 18
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​ProductSummary

Ürün detay objesi

​ShipmentSummary

ShipmentItem PUT › Responses

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

Sevkiyat kalemi objesi
amount
​integer · min: 0 · required

Gönderilen miktar (stok tipi cinsinden)

Example: 2
price
​number · float · min: 0 · required

Birim fiyat

Example: 20
currency
​string · enum · maxLength: 255 · required

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
dm3
​number · float · min: 0 · required

Desi (hacimsel ağırlık)

Example: 1.5
status
​integer · enum · required

Sevkiyat kalemi aktiflik durumu

Enum values:
0
1
Example: 1
​OrderItemSummary · required
id
​integer

Sevkiyat kalemi için benzersiz kimlik

Example: 123
rootProductId
​integer · min: 0

Ana ürün kimliği (varyantlar için)

Example: 123
productLabel
​string · maxLength: 255

Ürün adı/başlığı

Example: Kırmızı Kalem
tax
​integer · min: 0

KDV oranı (%)

Example: 18
createdAt
​string · date-time

Kayıt oluşturulma tarihi

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Kayıt son güncellenme tarihi

Example: 2018-02-21T15:01:03+0300
​ProductSummary

Ürün detay objesi

​ShipmentSummary

ShipmentItem DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/api/shipment_items/{id}
Bearer

ShipmentItem DELETE › path Parameters

id
​string · pattern: \d+ · required

Teslimat Kalemi nesnesinin id değeri

ShipmentItem DELETE › Responses

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

No data returned