Skip to content
Ideasoft
Admin API

DraftOrder

Serverhttps://your-store.myideasoft.com

DraftOrder LIST

GET
https://your-store.myideasoft.com
/admin-api/draft_orders
Bearer
or
OAuth 2.0

DraftOrder 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 DraftOrder nesnesi 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 değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

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

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

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

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

createdAt değeri için bitiş tarihi

q
​string

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

user
​integer · min: -1

User Id değeri

member
​integer · min: -1

Member Id değeri

s
​string

Arama anahtarı ile filtreleme

DraftOrder LIST › Responses

The request (GET or PUT) completed successfully.

name
​string · maxLength: 255 · required

Manuel sipariş nesnesi için isim değeri.

Example: Test Siparişi
​CartItemSummary[] · required

Sepet kalemi nesnesi listesi

id
​integer

Manuel sipariş nesnesi kimlik değeri

code
​string · maxLength: 255

Manuel sipariş kodu

Example: 35384d65-c450-4f48-adcc-beeb638554ad
​MemberSummary

Üye hesap bilgilerini içeren obje

​CouponSummary
subTotal
​number · float

Ara toplam

Example: 42.37
couponDiscount
​number · float

Hediye çeki indirimi

Example: 5
amountWithCouponDiscount
​number · float

Hediye çeki indirimi uygulanmış toplam fiyat

Example: 37.37
shipmentAmount
​number · float

Kargo ücreti

Example: 0
customTaxAmount
​number · float

Özel vergi oranı uygulanmış fiyat

Example: 0
moneyOrderDiscountAmount
​number · float

Havale indirimi miktarı

Example: 0
taxAmount
​number · float

Vergi miktarı

Example: 6.73
amountWithTax
​number · float

Vergi eklenmiş toplam fiyat

Example: 44.1
createdAt
​string · date-time
updatedAt
​string · date-time

DraftOrder POST

POST
https://your-store.myideasoft.com
/admin-api/draft_orders
Bearer
or
OAuth 2.0

DraftOrder POST › Request Body

name
​string · maxLength: 255 · required

Manuel sipariş nesnesi için isim değeri.

Example: Test Siparişi
​CartItemSummary[] · required

Sepet kalemi nesnesi listesi

id
​integer

Manuel sipariş nesnesi kimlik değeri

code
​string · maxLength: 255

Manuel sipariş kodu

Example: 35384d65-c450-4f48-adcc-beeb638554ad
​MemberSummary

Üye hesap bilgilerini içeren obje

​CouponSummary
subTotal
​number · float

Ara toplam

Example: 42.37
couponDiscount
​number · float

Hediye çeki indirimi

Example: 5
amountWithCouponDiscount
​number · float

Hediye çeki indirimi uygulanmış toplam fiyat

Example: 37.37
shipmentAmount
​number · float

Kargo ücreti

Example: 0
customTaxAmount
​number · float

Özel vergi oranı uygulanmış fiyat

Example: 0
moneyOrderDiscountAmount
​number · float

Havale indirimi miktarı

Example: 0
taxAmount
​number · float

Vergi miktarı

Example: 6.73
amountWithTax
​number · float

Vergi eklenmiş toplam fiyat

Example: 44.1
createdAt
​string · date-time
updatedAt
​string · date-time

DraftOrder POST › Responses

The create request (POST) completed successfully.

name
​string · maxLength: 255 · required

Manuel sipariş nesnesi için isim değeri.

Example: Test Siparişi
​CartItemSummary[] · required

Sepet kalemi nesnesi listesi

id
​integer

Manuel sipariş nesnesi kimlik değeri

code
​string · maxLength: 255

Manuel sipariş kodu

Example: 35384d65-c450-4f48-adcc-beeb638554ad
​MemberSummary

Üye hesap bilgilerini içeren obje

​CouponSummary
subTotal
​number · float

Ara toplam

Example: 42.37
couponDiscount
​number · float

Hediye çeki indirimi

Example: 5
amountWithCouponDiscount
​number · float

Hediye çeki indirimi uygulanmış toplam fiyat

Example: 37.37
shipmentAmount
​number · float

Kargo ücreti

Example: 0
customTaxAmount
​number · float

Özel vergi oranı uygulanmış fiyat

Example: 0
moneyOrderDiscountAmount
​number · float

Havale indirimi miktarı

Example: 0
taxAmount
​number · float

Vergi miktarı

Example: 6.73
amountWithTax
​number · float

Vergi eklenmiş toplam fiyat

Example: 44.1
createdAt
​string · date-time
updatedAt
​string · date-time

DraftOrder COUNT

GET
https://your-store.myideasoft.com
/admin-api/draft_orders/count
Bearer
or
OAuth 2.0

DraftOrder 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 gelecek DraftOrder nesnesi 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 değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

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

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

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

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

createdAt değeri için bitiş tarihi

q
​string

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

user
​integer · min: -1

User Id değeri

member
​integer · min: -1

Member Id değeri

s
​string

Arama anahtarı ile filtreleme

DraftOrder COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


DraftOrder GET

GET
https://your-store.myideasoft.com
/admin-api/draft_orders/{id}
Bearer
or
OAuth 2.0

DraftOrder GET › path Parameters

id
​string · pattern: \d+ · required

DraftOrder GET › Responses

The request (GET or PUT) completed successfully.

name
​string · maxLength: 255 · required

Manuel sipariş nesnesi için isim değeri.

Example: Test Siparişi
​CartItemSummary[] · required

Sepet kalemi nesnesi listesi

id
​integer

Manuel sipariş nesnesi kimlik değeri

code
​string · maxLength: 255

Manuel sipariş kodu

Example: 35384d65-c450-4f48-adcc-beeb638554ad
​MemberSummary

Üye hesap bilgilerini içeren obje

​CouponSummary
subTotal
​number · float

Ara toplam

Example: 42.37
couponDiscount
​number · float

Hediye çeki indirimi

Example: 5
amountWithCouponDiscount
​number · float

Hediye çeki indirimi uygulanmış toplam fiyat

Example: 37.37
shipmentAmount
​number · float

Kargo ücreti

Example: 0
customTaxAmount
​number · float

Özel vergi oranı uygulanmış fiyat

Example: 0
moneyOrderDiscountAmount
​number · float

Havale indirimi miktarı

Example: 0
taxAmount
​number · float

Vergi miktarı

Example: 6.73
amountWithTax
​number · float

Vergi eklenmiş toplam fiyat

Example: 44.1
createdAt
​string · date-time
updatedAt
​string · date-time

DraftOrder PUT

PUT
https://your-store.myideasoft.com
/admin-api/draft_orders/{id}
Bearer
or
OAuth 2.0

DraftOrder PUT › path Parameters

id
​string · pattern: \d+ · required

DraftOrder PUT › Request Body

name
​string · maxLength: 255 · required

Manuel sipariş nesnesi için isim değeri.

Example: Test Siparişi
​CartItemSummary[] · required

Sepet kalemi nesnesi listesi

id
​integer

Manuel sipariş nesnesi kimlik değeri

code
​string · maxLength: 255

Manuel sipariş kodu

Example: 35384d65-c450-4f48-adcc-beeb638554ad
​MemberSummary

Üye hesap bilgilerini içeren obje

​CouponSummary
subTotal
​number · float

Ara toplam

Example: 42.37
couponDiscount
​number · float

Hediye çeki indirimi

Example: 5
amountWithCouponDiscount
​number · float

Hediye çeki indirimi uygulanmış toplam fiyat

Example: 37.37
shipmentAmount
​number · float

Kargo ücreti

Example: 0
customTaxAmount
​number · float

Özel vergi oranı uygulanmış fiyat

Example: 0
moneyOrderDiscountAmount
​number · float

Havale indirimi miktarı

Example: 0
taxAmount
​number · float

Vergi miktarı

Example: 6.73
amountWithTax
​number · float

Vergi eklenmiş toplam fiyat

Example: 44.1
createdAt
​string · date-time
updatedAt
​string · date-time

DraftOrder PUT › Responses

The request (GET or PUT) completed successfully.

name
​string · maxLength: 255 · required

Manuel sipariş nesnesi için isim değeri.

Example: Test Siparişi
​CartItemSummary[] · required

Sepet kalemi nesnesi listesi

id
​integer

Manuel sipariş nesnesi kimlik değeri

code
​string · maxLength: 255

Manuel sipariş kodu

Example: 35384d65-c450-4f48-adcc-beeb638554ad
​MemberSummary

Üye hesap bilgilerini içeren obje

​CouponSummary
subTotal
​number · float

Ara toplam

Example: 42.37
couponDiscount
​number · float

Hediye çeki indirimi

Example: 5
amountWithCouponDiscount
​number · float

Hediye çeki indirimi uygulanmış toplam fiyat

Example: 37.37
shipmentAmount
​number · float

Kargo ücreti

Example: 0
customTaxAmount
​number · float

Özel vergi oranı uygulanmış fiyat

Example: 0
moneyOrderDiscountAmount
​number · float

Havale indirimi miktarı

Example: 0
taxAmount
​number · float

Vergi miktarı

Example: 6.73
amountWithTax
​number · float

Vergi eklenmiş toplam fiyat

Example: 44.1
createdAt
​string · date-time
updatedAt
​string · date-time

DraftOrder DELETE

DELETE
https://your-store.myideasoft.com
/admin-api/draft_orders/{id}
Bearer
or
OAuth 2.0

DraftOrder DELETE › path Parameters

id
​string · pattern: \d+ · required

DraftOrder DELETE › Responses

The delete request completed successfully (the response has no content).

No data returned