İçeriğe geç
Admin API

Order

Serverhttps://magaza-adiniz.myideasoft.com

Order LIST

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

Order 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 dönecek Order 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 listesi. Örn: ids=1,2,3,4.

sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir.

q
​string

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

status
​string · enum

Order durumu filtresi.

Enum values:
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
being_prepared
paymentStatus
​string · enum

Order ödeme durumu filtresi.

Enum values:
success
in_transaction
failed
paymentTypeName
​string · enum

Order ödeme tipi filtresi.

Enum values:
Havale
Özel Ödeme Sistemi
Kredi Kartı
Paypal
GarantiPay
Mail Order
BKM Express
Kapıda Ödeme Nakit
shippingProviderCode
​string

Kargo sağlayıcı kodu filtresi.

shippingCompany
​string

Kargo şirketi filtresi.

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

Start of the time frame

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

End of the time frame

filterCurrency
​integer · min: 1

Currency filtresi.

minPrice
​string

Minimum fiyat filtresi.

maxPrice
​string

Maksimum fiyat filtresi.

member
​integer · min: 1

Member filtresi.

memberGroup
​integer · min: -1

Member group filtresi.

billingFullname
​string

Fatura ismi filtresi.

billingLocation
​string

Fatura lokasyonu filtresi.

customerFullname
​string

Müşteri ismi filtresi.

productName
​string

Ürün adı filtresi.

productId
​string

Ürün ID filtresi.

productSku
​string

Ürün SKU filtresi.

shippingMobilePhoneNumber
​string

Kargo telefon numarası filtresi.

referrer
​string

Order yönlendirme filtresi.

deviceType
​string · enum

Cihaz tipi filtresi.

Enum values:
desktop
mobile
paidFromCurrentAccount
​string · enum

Cari hesaptan ödeme filtresi.

Enum values:
0
1
cardSavingSystem
​string · enum

Kart saklama sistemi filtresi.

Enum values:
Masterpass
startShippingDate
​string · date · pattern: yyyy-mm-dd

Kargo başlangıç tarihi.

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

Kargo bitiş tarihi.

cargoTrackingCodeNonExisting
​string · enum

Takip kodu olmayan sipariş filtresi.

Enum values:
yurtici
mng
jetizz
aras
kargonomi
couponCode
​string

Kupon kodu filtresi.

couponUsage
​string

Coupon code usage filter.

userNote
​string

Order user note usage filter.

promotionCode
​string

Promotion code filter.

promotionUsage
​string

Promotion code usage filter.

gatewayCode
​string · enum

Ödeme gateway kodu filtresi.

Enum values:
anadolubank
axess
bonus_card
cardfinans
denizbank_bonus
halkbank_paraf
hsbc_advantage_kart
ing_bank
ideaexportOrderStatus
​string · enum

Order ideaexport status search filter.

Enum values:
0
1
transactionId
​string

Sipariş Numarası Filtresi. Örnek: transactionId=TXN123456

source
​string

Order source filter.

marketplaceStatus
​string

Order marketplace status filter.

s
​string

Arama anahtarı filtresi.

Order LIST › Responses

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

Sipariş detay objesi
id
​integer · required

Sipariş için benzersiz kimlik

Example: 123
customerFirstname
​string · maxLength: 255

Müşteri adı

Example: Ahmet
customerSurname
​string · maxLength: 255

Müşteri soyadı

Example: Yılmaz
customerEmail
​string · email

Müşteri e-posta adresi

Example: ahmet.yilmaz@example.com
customerPhone
​string

Müşteri telefon numarası

Example: +90 (216) 326 04 77
paymentTypeName
​string · maxLength: 128

Ödeme yöntemi adı

Example: Havale
paymentProviderCode
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı kodu (sistem otomatik atar)

Example: MoneyOrder
paymentProviderName
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı adı (sistem otomatik atar)

Example: Havale
paymentGatewayCode
​string · maxLength: 255 · readOnly

Ödeme gateway kodu (sistem otomatik atar)

Example: ideabank_1
paymentGatewayName
​string · maxLength: 255 · readOnly

Ödeme gateway adı (sistem otomatik atar)

Example: IdeaBank
bankName
​string · maxLength: 128 · readOnly

Banka adı (sistem otomatik atar)

Example: IdeaBank
clientIp
​string · ipv4 · maxLength: 40

Müşterinin IP adresi

Example: 192.168.1.1
userAgent
​string · maxLength: 1024

Tarayıcı ve cihaz bilgisi

Example: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.167 Safari/537.36
currency
​string · enum

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
currencyRates
​string · maxLength: 65535

İşlem anındaki döviz kurları (JSON string)

Example: {"TL":[1,1],"USD":[3.7698,3.7766],"EUR":[4.6575,4.6659],"GBP":[5.2597,5.2872]}
amount
​number · decimal · min: 0

Vergi hariç toplam tutar

Example: 100
couponDiscount
​number · decimal · min: 0

Hediye çeki indirim tutarı

Example: 0
taxAmount
​number · decimal · min: 0

Toplam vergi tutarı

Example: 18
totalCustomTaxAmount
​number · decimal · min: 0

Özel vergi toplam tutarı

Example: 0
promotionDiscount
​number · decimal · min: 0

Promosyon indirim tutarı

Example: 0
generalAmount
​number · decimal · min: 0

Genel toplam (ürün + vergi + kargo + ek hizmet - indirimler)

Example: 125
shippingAmount
​number · decimal · min: 0

Kargo ücreti

Example: 15
additionalServiceAmount
​number · decimal · min: 0

Ek hizmet bedeli (hediye paketi vb.)

Example: 0
finalAmount
​number · decimal · min: 0

Son ödeme tutarı (taksit farkı dahil)

Example: 125
sumOfGainedPoints
​number · decimal · min: 0

Kazanılan toplam puan

Example: 200
installment
​integer · min: 0

Taksit sayısı

Example: 3
installmentRate
​number · decimal · min: 0

Taksit oranı (1.0 = vade farkı yok)

Example: 1.05
extraInstallment
​integer · min: 0

Ekstra kampanya taksit sayısı

Example: 0
transactionId
​string · maxLength: 255

Benzersiz işlem numarası

Example: c88728ce28151
hasUserNote
​integer · enum

Müşteri notu var mı?

Enum values:
0
1
Example: 0
status
​string · enum

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: waiting_for_approval
paymentStatus
​string · enum

Ödeme işlem durumu

Enum values:
in_transaction
failed
success
Example: success
errorMessage
​string · maxLength: 65535

Hata mesajı (başarısız işlemler için)

Example: Limit yetersiz
sessionId
​string · maxLength: 255 · writeOnly

Oturum kimliği

Example: abc123def456
deviceType
​string · enum

Sipariş verildiği cihaz tipi

Enum values:
desktop
mobile
tablet
Example: desktop
referrer
​string · maxLength: 65535

Yönlendiren web sitesi URL'i

Example: www.referrer.com
invoicePrintCount
​integer · min: 0

Fatura çıktısı alınma sayısı

Example: 1
useGiftPackage
​integer · enum

Hediye paketi tercihi

Enum values:
0
1
Example: 0
giftNote
​string

Hediye notu

Example: Doğum günün kutlu olsun
giftAmount
​number · float · min: 0
memberGroupName
​string · maxLength: 255

Üye grubu adı

Example: Üyeliksiz alışveriş
usePromotion
​integer · enum

Promosyon kullanım durumu

Enum values:
0
1
Example: 0
shippingProviderCode
​string · maxLength: 255 · readOnly

Kargo sağlayıcı kodu (sistem otomatik atar)

Example: idea
shippingProviderName
​string · maxLength: 255 · readOnly

Kargo sağlayıcı adı (sistem otomatik atar)

Example: Idea Cargo
shippingCompanyName
​string · maxLength: 255 · readOnly

Kargo firması adı (sistem otomatik atar)

Example: Idea Cargo
shippingPaymentType
​string · enum

Kargo ödeme tipi

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
shippingTrackingCode
​string · maxLength: 255

Kargo takip kodu

Example: 123123IDEA
source
​string · maxLength: 255

Sipariş kaynağı (yazılım/platform)

Example: IdeaShop Payment
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
​MaillistSummary
​MemberSummary

Üye hesap bilgilerini içeren obje

​OrderDetailSummary[]

Sipariş detayı nesnesi

​OrderCustomTaxLineSummary[]

Özel vergi oranları nesnesi

​OrderItemSummary[]

Sipariş kalemi nesnesi listesi

​ShippingAddressSummary

Teslimat adresi objesi

​BillingAddressSummary
​FraudOrderSummary
​PromotionSummary
autoPayback
​integer · enum · writeOnly

Otomatik iade durumu

Enum values:
0
1
Example: 0
orderItemCount
​integer
lastShipmentStatus
​integer
next
​string · writeOnly
prev
​string · writeOnly

Order COUNT

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

Order 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 dönecek Order 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 listesi. Örn: ids=1,2,3,4.

sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir.

q
​string

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

status
​string · enum

Order durumu filtresi.

Enum values:
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
being_prepared
paymentStatus
​string · enum

Order ödeme durumu filtresi.

Enum values:
success
in_transaction
failed
paymentTypeName
​string · enum

Order ödeme tipi filtresi.

Enum values:
Havale
Özel Ödeme Sistemi
Kredi Kartı
Paypal
GarantiPay
Mail Order
BKM Express
Kapıda Ödeme Nakit
shippingProviderCode
​string

Kargo sağlayıcı kodu filtresi.

shippingCompany
​string

Kargo şirketi filtresi.

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

Start of the time frame

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

End of the time frame

filterCurrency
​integer · min: 1

Currency filtresi.

minPrice
​string

Minimum fiyat filtresi.

maxPrice
​string

Maksimum fiyat filtresi.

member
​integer · min: 1

Member filtresi.

memberGroup
​integer · min: -1

Member group filtresi.

billingFullname
​string

Fatura ismi filtresi.

billingLocation
​string

Fatura lokasyonu filtresi.

customerFullname
​string

Müşteri ismi filtresi.

productName
​string

Ürün adı filtresi.

productId
​string

Ürün ID filtresi.

productSku
​string

Ürün SKU filtresi.

shippingMobilePhoneNumber
​string

Kargo telefon numarası filtresi.

referrer
​string

Order yönlendirme filtresi.

deviceType
​string · enum

Cihaz tipi filtresi.

Enum values:
desktop
mobile
paidFromCurrentAccount
​string · enum

Cari hesaptan ödeme filtresi.

Enum values:
0
1
cardSavingSystem
​string · enum

Kart saklama sistemi filtresi.

Enum values:
Masterpass
startShippingDate
​string · date · pattern: yyyy-mm-dd

Kargo başlangıç tarihi.

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

Kargo bitiş tarihi.

cargoTrackingCodeNonExisting
​string · enum

Takip kodu olmayan sipariş filtresi.

Enum values:
yurtici
mng
jetizz
aras
kargonomi
couponCode
​string

Kupon kodu filtresi.

couponUsage
​string

Coupon code usage filter.

userNote
​string

Order user note usage filter.

promotionCode
​string

Promotion code filter.

promotionUsage
​string

Promotion code usage filter.

gatewayCode
​string · enum

Ödeme gateway kodu filtresi.

Enum values:
anadolubank
axess
bonus_card
cardfinans
denizbank_bonus
halkbank_paraf
hsbc_advantage_kart
ing_bank
ideaexportOrderStatus
​string · enum

Order ideaexport status search filter.

Enum values:
0
1
transactionId
​string

Sipariş Numarası Filtresi. Örnek: transactionId=TXN123456

source
​string

Order source filter.

marketplaceStatus
​string

Order marketplace status filter.

s
​string

Arama anahtarı filtresi.

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


Order GET

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

Order GET › path Parameters

id
​string · pattern: \d+ · required

Order GET › Responses

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

Sipariş detay objesi
id
​integer · required

Sipariş için benzersiz kimlik

Example: 123
customerFirstname
​string · maxLength: 255

Müşteri adı

Example: Ahmet
customerSurname
​string · maxLength: 255

Müşteri soyadı

Example: Yılmaz
customerEmail
​string · email

Müşteri e-posta adresi

Example: ahmet.yilmaz@example.com
customerPhone
​string

Müşteri telefon numarası

Example: +90 (216) 326 04 77
paymentTypeName
​string · maxLength: 128

Ödeme yöntemi adı

Example: Havale
paymentProviderCode
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı kodu (sistem otomatik atar)

Example: MoneyOrder
paymentProviderName
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı adı (sistem otomatik atar)

Example: Havale
paymentGatewayCode
​string · maxLength: 255 · readOnly

Ödeme gateway kodu (sistem otomatik atar)

Example: ideabank_1
paymentGatewayName
​string · maxLength: 255 · readOnly

Ödeme gateway adı (sistem otomatik atar)

Example: IdeaBank
bankName
​string · maxLength: 128 · readOnly

Banka adı (sistem otomatik atar)

Example: IdeaBank
clientIp
​string · ipv4 · maxLength: 40

Müşterinin IP adresi

Example: 192.168.1.1
userAgent
​string · maxLength: 1024

Tarayıcı ve cihaz bilgisi

Example: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.167 Safari/537.36
currency
​string · enum

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
currencyRates
​string · maxLength: 65535

İşlem anındaki döviz kurları (JSON string)

Example: {"TL":[1,1],"USD":[3.7698,3.7766],"EUR":[4.6575,4.6659],"GBP":[5.2597,5.2872]}
amount
​number · decimal · min: 0

Vergi hariç toplam tutar

Example: 100
couponDiscount
​number · decimal · min: 0

Hediye çeki indirim tutarı

Example: 0
taxAmount
​number · decimal · min: 0

Toplam vergi tutarı

Example: 18
totalCustomTaxAmount
​number · decimal · min: 0

Özel vergi toplam tutarı

Example: 0
promotionDiscount
​number · decimal · min: 0

Promosyon indirim tutarı

Example: 0
generalAmount
​number · decimal · min: 0

Genel toplam (ürün + vergi + kargo + ek hizmet - indirimler)

Example: 125
shippingAmount
​number · decimal · min: 0

Kargo ücreti

Example: 15
additionalServiceAmount
​number · decimal · min: 0

Ek hizmet bedeli (hediye paketi vb.)

Example: 0
finalAmount
​number · decimal · min: 0

Son ödeme tutarı (taksit farkı dahil)

Example: 125
sumOfGainedPoints
​number · decimal · min: 0

Kazanılan toplam puan

Example: 200
installment
​integer · min: 0

Taksit sayısı

Example: 3
installmentRate
​number · decimal · min: 0

Taksit oranı (1.0 = vade farkı yok)

Example: 1.05
extraInstallment
​integer · min: 0

Ekstra kampanya taksit sayısı

Example: 0
transactionId
​string · maxLength: 255

Benzersiz işlem numarası

Example: c88728ce28151
hasUserNote
​integer · enum

Müşteri notu var mı?

Enum values:
0
1
Example: 0
status
​string · enum

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: waiting_for_approval
paymentStatus
​string · enum

Ödeme işlem durumu

Enum values:
in_transaction
failed
success
Example: success
errorMessage
​string · maxLength: 65535

Hata mesajı (başarısız işlemler için)

Example: Limit yetersiz
sessionId
​string · maxLength: 255 · writeOnly

Oturum kimliği

Example: abc123def456
deviceType
​string · enum

Sipariş verildiği cihaz tipi

Enum values:
desktop
mobile
tablet
Example: desktop
referrer
​string · maxLength: 65535

Yönlendiren web sitesi URL'i

Example: www.referrer.com
invoicePrintCount
​integer · min: 0

Fatura çıktısı alınma sayısı

Example: 1
useGiftPackage
​integer · enum

Hediye paketi tercihi

Enum values:
0
1
Example: 0
giftNote
​string

Hediye notu

Example: Doğum günün kutlu olsun
giftAmount
​number · float · min: 0
memberGroupName
​string · maxLength: 255

Üye grubu adı

Example: Üyeliksiz alışveriş
usePromotion
​integer · enum

Promosyon kullanım durumu

Enum values:
0
1
Example: 0
shippingProviderCode
​string · maxLength: 255 · readOnly

Kargo sağlayıcı kodu (sistem otomatik atar)

Example: idea
shippingProviderName
​string · maxLength: 255 · readOnly

Kargo sağlayıcı adı (sistem otomatik atar)

Example: Idea Cargo
shippingCompanyName
​string · maxLength: 255 · readOnly

Kargo firması adı (sistem otomatik atar)

Example: Idea Cargo
shippingPaymentType
​string · enum

Kargo ödeme tipi

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
shippingTrackingCode
​string · maxLength: 255

Kargo takip kodu

Example: 123123IDEA
source
​string · maxLength: 255

Sipariş kaynağı (yazılım/platform)

Example: IdeaShop Payment
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
​MaillistSummary
​MemberSummary

Üye hesap bilgilerini içeren obje

​OrderDetailSummary[]

Sipariş detayı nesnesi

​OrderCustomTaxLineSummary[]

Özel vergi oranları nesnesi

​OrderItemSummary[]

Sipariş kalemi nesnesi listesi

​ShippingAddressSummary

Teslimat adresi objesi

​BillingAddressSummary
​FraudOrderSummary
​PromotionSummary
autoPayback
​integer · enum · writeOnly

Otomatik iade durumu

Enum values:
0
1
Example: 0
orderItemCount
​integer
lastShipmentStatus
​integer
next
​string · writeOnly
prev
​string · writeOnly

Order PUT

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

Order PUT › path Parameters

id
​string · pattern: \d+ · required

Order PUT › Request Body

Sipariş detay objesi
id
​integer · required

Sipariş için benzersiz kimlik

Example: 123
customerFirstname
​string · maxLength: 255

Müşteri adı

Example: Ahmet
customerSurname
​string · maxLength: 255

Müşteri soyadı

Example: Yılmaz
customerEmail
​string · email

Müşteri e-posta adresi

Example: ahmet.yilmaz@example.com
customerPhone
​string

Müşteri telefon numarası

Example: +90 (216) 326 04 77
paymentTypeName
​string · maxLength: 128

Ödeme yöntemi adı

Example: Havale
paymentProviderCode
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı kodu (sistem otomatik atar)

Example: MoneyOrder
paymentProviderName
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı adı (sistem otomatik atar)

Example: Havale
paymentGatewayCode
​string · maxLength: 255 · readOnly

Ödeme gateway kodu (sistem otomatik atar)

Example: ideabank_1
paymentGatewayName
​string · maxLength: 255 · readOnly

Ödeme gateway adı (sistem otomatik atar)

Example: IdeaBank
bankName
​string · maxLength: 128 · readOnly

Banka adı (sistem otomatik atar)

Example: IdeaBank
clientIp
​string · ipv4 · maxLength: 40

Müşterinin IP adresi

Example: 192.168.1.1
userAgent
​string · maxLength: 1024

Tarayıcı ve cihaz bilgisi

Example: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.167 Safari/537.36
currency
​string · enum

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
currencyRates
​string · maxLength: 65535

İşlem anındaki döviz kurları (JSON string)

Example: {"TL":[1,1],"USD":[3.7698,3.7766],"EUR":[4.6575,4.6659],"GBP":[5.2597,5.2872]}
amount
​number · decimal · min: 0

Vergi hariç toplam tutar

Example: 100
couponDiscount
​number · decimal · min: 0

Hediye çeki indirim tutarı

Example: 0
taxAmount
​number · decimal · min: 0

Toplam vergi tutarı

Example: 18
totalCustomTaxAmount
​number · decimal · min: 0

Özel vergi toplam tutarı

Example: 0
promotionDiscount
​number · decimal · min: 0

Promosyon indirim tutarı

Example: 0
generalAmount
​number · decimal · min: 0

Genel toplam (ürün + vergi + kargo + ek hizmet - indirimler)

Example: 125
shippingAmount
​number · decimal · min: 0

Kargo ücreti

Example: 15
additionalServiceAmount
​number · decimal · min: 0

Ek hizmet bedeli (hediye paketi vb.)

Example: 0
finalAmount
​number · decimal · min: 0

Son ödeme tutarı (taksit farkı dahil)

Example: 125
sumOfGainedPoints
​number · decimal · min: 0

Kazanılan toplam puan

Example: 200
installment
​integer · min: 0

Taksit sayısı

Example: 3
installmentRate
​number · decimal · min: 0

Taksit oranı (1.0 = vade farkı yok)

Example: 1.05
extraInstallment
​integer · min: 0

Ekstra kampanya taksit sayısı

Example: 0
transactionId
​string · maxLength: 255

Benzersiz işlem numarası

Example: c88728ce28151
hasUserNote
​integer · enum

Müşteri notu var mı?

Enum values:
0
1
Example: 0
status
​string · enum

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: waiting_for_approval
paymentStatus
​string · enum

Ödeme işlem durumu

Enum values:
in_transaction
failed
success
Example: success
errorMessage
​string · maxLength: 65535

Hata mesajı (başarısız işlemler için)

Example: Limit yetersiz
sessionId
​string · maxLength: 255 · writeOnly

Oturum kimliği

Example: abc123def456
deviceType
​string · enum

Sipariş verildiği cihaz tipi

Enum values:
desktop
mobile
tablet
Example: desktop
referrer
​string · maxLength: 65535

Yönlendiren web sitesi URL'i

Example: www.referrer.com
invoicePrintCount
​integer · min: 0

Fatura çıktısı alınma sayısı

Example: 1
useGiftPackage
​integer · enum

Hediye paketi tercihi

Enum values:
0
1
Example: 0
giftNote
​string

Hediye notu

Example: Doğum günün kutlu olsun
giftAmount
​number · float · min: 0
memberGroupName
​string · maxLength: 255

Üye grubu adı

Example: Üyeliksiz alışveriş
usePromotion
​integer · enum

Promosyon kullanım durumu

Enum values:
0
1
Example: 0
shippingProviderCode
​string · maxLength: 255 · readOnly

Kargo sağlayıcı kodu (sistem otomatik atar)

Example: idea
shippingProviderName
​string · maxLength: 255 · readOnly

Kargo sağlayıcı adı (sistem otomatik atar)

Example: Idea Cargo
shippingCompanyName
​string · maxLength: 255 · readOnly

Kargo firması adı (sistem otomatik atar)

Example: Idea Cargo
shippingPaymentType
​string · enum

Kargo ödeme tipi

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
shippingTrackingCode
​string · maxLength: 255

Kargo takip kodu

Example: 123123IDEA
source
​string · maxLength: 255

Sipariş kaynağı (yazılım/platform)

Example: IdeaShop Payment
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
​MaillistSummary
​MemberSummary

Üye hesap bilgilerini içeren obje

​OrderDetailSummary[]

Sipariş detayı nesnesi

​OrderCustomTaxLineSummary[]

Özel vergi oranları nesnesi

​OrderItemSummary[]

Sipariş kalemi nesnesi listesi

​ShippingAddressSummary

Teslimat adresi objesi

​BillingAddressSummary
​FraudOrderSummary
​PromotionSummary
autoPayback
​integer · enum · writeOnly

Otomatik iade durumu

Enum values:
0
1
Example: 0
orderItemCount
​integer
lastShipmentStatus
​integer
next
​string · writeOnly
prev
​string · writeOnly

Order PUT › Responses

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

Sipariş detay objesi
id
​integer · required

Sipariş için benzersiz kimlik

Example: 123
customerFirstname
​string · maxLength: 255

Müşteri adı

Example: Ahmet
customerSurname
​string · maxLength: 255

Müşteri soyadı

Example: Yılmaz
customerEmail
​string · email

Müşteri e-posta adresi

Example: ahmet.yilmaz@example.com
customerPhone
​string

Müşteri telefon numarası

Example: +90 (216) 326 04 77
paymentTypeName
​string · maxLength: 128

Ödeme yöntemi adı

Example: Havale
paymentProviderCode
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı kodu (sistem otomatik atar)

Example: MoneyOrder
paymentProviderName
​string · maxLength: 128 · readOnly

Ödeme sağlayıcı adı (sistem otomatik atar)

Example: Havale
paymentGatewayCode
​string · maxLength: 255 · readOnly

Ödeme gateway kodu (sistem otomatik atar)

Example: ideabank_1
paymentGatewayName
​string · maxLength: 255 · readOnly

Ödeme gateway adı (sistem otomatik atar)

Example: IdeaBank
bankName
​string · maxLength: 128 · readOnly

Banka adı (sistem otomatik atar)

Example: IdeaBank
clientIp
​string · ipv4 · maxLength: 40

Müşterinin IP adresi

Example: 192.168.1.1
userAgent
​string · maxLength: 1024

Tarayıcı ve cihaz bilgisi

Example: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.167 Safari/537.36
currency
​string · enum

Para birimi kodu

Enum values:
TL
USD
EUR
GBP
JPY
CNY
GR
CHF
Example: TL
currencyRates
​string · maxLength: 65535

İşlem anındaki döviz kurları (JSON string)

Example: {"TL":[1,1],"USD":[3.7698,3.7766],"EUR":[4.6575,4.6659],"GBP":[5.2597,5.2872]}
amount
​number · decimal · min: 0

Vergi hariç toplam tutar

Example: 100
couponDiscount
​number · decimal · min: 0

Hediye çeki indirim tutarı

Example: 0
taxAmount
​number · decimal · min: 0

Toplam vergi tutarı

Example: 18
totalCustomTaxAmount
​number · decimal · min: 0

Özel vergi toplam tutarı

Example: 0
promotionDiscount
​number · decimal · min: 0

Promosyon indirim tutarı

Example: 0
generalAmount
​number · decimal · min: 0

Genel toplam (ürün + vergi + kargo + ek hizmet - indirimler)

Example: 125
shippingAmount
​number · decimal · min: 0

Kargo ücreti

Example: 15
additionalServiceAmount
​number · decimal · min: 0

Ek hizmet bedeli (hediye paketi vb.)

Example: 0
finalAmount
​number · decimal · min: 0

Son ödeme tutarı (taksit farkı dahil)

Example: 125
sumOfGainedPoints
​number · decimal · min: 0

Kazanılan toplam puan

Example: 200
installment
​integer · min: 0

Taksit sayısı

Example: 3
installmentRate
​number · decimal · min: 0

Taksit oranı (1.0 = vade farkı yok)

Example: 1.05
extraInstallment
​integer · min: 0

Ekstra kampanya taksit sayısı

Example: 0
transactionId
​string · maxLength: 255

Benzersiz işlem numarası

Example: c88728ce28151
hasUserNote
​integer · enum

Müşteri notu var mı?

Enum values:
0
1
Example: 0
status
​string · enum

Sipariş durumu

Enum values:
deleted
waiting_for_approval
approved
fulfilled
cancelled
delivered
on_accumulation
waiting_for_payment
Example: waiting_for_approval
paymentStatus
​string · enum

Ödeme işlem durumu

Enum values:
in_transaction
failed
success
Example: success
errorMessage
​string · maxLength: 65535

Hata mesajı (başarısız işlemler için)

Example: Limit yetersiz
sessionId
​string · maxLength: 255 · writeOnly

Oturum kimliği

Example: abc123def456
deviceType
​string · enum

Sipariş verildiği cihaz tipi

Enum values:
desktop
mobile
tablet
Example: desktop
referrer
​string · maxLength: 65535

Yönlendiren web sitesi URL'i

Example: www.referrer.com
invoicePrintCount
​integer · min: 0

Fatura çıktısı alınma sayısı

Example: 1
useGiftPackage
​integer · enum

Hediye paketi tercihi

Enum values:
0
1
Example: 0
giftNote
​string

Hediye notu

Example: Doğum günün kutlu olsun
giftAmount
​number · float · min: 0
memberGroupName
​string · maxLength: 255

Üye grubu adı

Example: Üyeliksiz alışveriş
usePromotion
​integer · enum

Promosyon kullanım durumu

Enum values:
0
1
Example: 0
shippingProviderCode
​string · maxLength: 255 · readOnly

Kargo sağlayıcı kodu (sistem otomatik atar)

Example: idea
shippingProviderName
​string · maxLength: 255 · readOnly

Kargo sağlayıcı adı (sistem otomatik atar)

Example: Idea Cargo
shippingCompanyName
​string · maxLength: 255 · readOnly

Kargo firması adı (sistem otomatik atar)

Example: Idea Cargo
shippingPaymentType
​string · enum

Kargo ödeme tipi

Enum values:
cash_on_delivery
standart_delivery
not_applicable
Example: standart_delivery
shippingTrackingCode
​string · maxLength: 255

Kargo takip kodu

Example: 123123IDEA
source
​string · maxLength: 255

Sipariş kaynağı (yazılım/platform)

Example: IdeaShop Payment
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
​MaillistSummary
​MemberSummary

Üye hesap bilgilerini içeren obje

​OrderDetailSummary[]

Sipariş detayı nesnesi

​OrderCustomTaxLineSummary[]

Özel vergi oranları nesnesi

​OrderItemSummary[]

Sipariş kalemi nesnesi listesi

​ShippingAddressSummary

Teslimat adresi objesi

​BillingAddressSummary
​FraudOrderSummary
​PromotionSummary
autoPayback
​integer · enum · writeOnly

Otomatik iade durumu

Enum values:
0
1
Example: 0
orderItemCount
​integer
lastShipmentStatus
​integer
next
​string · writeOnly
prev
​string · writeOnly

Order DELETE

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

Order DELETE › path Parameters

id
​string · pattern: \d+ · required

Order DELETE › Responses

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

No data returned