İçeriğe geç
Admin API

OrderRefundRequest

Serverhttps://magaza-adiniz.myideasoft.com

OrderRefundRequest LIST

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

OrderRefundRequest 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 Order Refund Request 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. ids=1,2,3,4

sinceId
​integer · min: 1

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

q
​string

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

status
​string · enum

Status alanının alabilceği değerler: approved veya waiting_for_approval veya cancelled

Enum values:
approved
waiting_for_approval
cancelled
refundReasonOrderSpecial1
refundReasonOrderSpecial2
member
​integer · min: 1

Member Id

order
​integer · min: 1

Order Id

s
​string

Arama anahtarı ile filtreleme.

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

Start of the time frame

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

End of the time frame

customerFirstname
​string

Customer Firstname

customerSurname
​string

Customer Surname

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

Start of the time frame

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

End of the time frame

OrderRefundRequest LIST › Responses

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

status
​string · enum · required

Sipariş iptal talebinin durumu. Seçenekler: | approved: Onaylandı. | waiting_for_approval: Onay bekliyor. | cancelled: İptal edildi.

Enum values:
approved
waiting_for_approval
cancelled
refundReasonOrderSpecial1
refundReasonOrderSpecial2
Example: approved
autoPayback
​integer · enum · required

Otomatik geri ödeme durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Sipariş iptal talebi nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Sipariş iptal talebi için oluşturulan benzersiz kod değeri.

Example: KOD-1234
fee
​number · float

Müşteriye ödenecek tutar bilgisi.

Example: 15
shippingFee
​number · float

Kargo tutarı.

cancellationReason
​string · maxLength: 512

Sipariş iptal talebinin sebebine dair detaylı açıklama.

Example: Ürün kusurlu.
​OrderSummary

Sipariş detay objesi

​OrderRefundRequestItemSummary[]

Sipariş iptal talebi kalemleri.

createdAt
​string · date-time

Sipariş iptal talebi nesnesinin oluşturulma zamanı.

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

Sipariş iptal talebi nesnesinin güncellenme zamanı.

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

OrderRefundRequest POST

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

OrderRefundRequest POST › Request Body

status
​string · enum · required

Sipariş iptal talebinin durumu. Seçenekler: | approved: Onaylandı. | waiting_for_approval: Onay bekliyor. | cancelled: İptal edildi.

Enum values:
approved
waiting_for_approval
cancelled
refundReasonOrderSpecial1
refundReasonOrderSpecial2
Example: approved
autoPayback
​integer · enum · required

Otomatik geri ödeme durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Sipariş iptal talebi nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Sipariş iptal talebi için oluşturulan benzersiz kod değeri.

Example: KOD-1234
fee
​number · float

Müşteriye ödenecek tutar bilgisi.

Example: 15
shippingFee
​number · float

Kargo tutarı.

cancellationReason
​string · maxLength: 512

Sipariş iptal talebinin sebebine dair detaylı açıklama.

Example: Ürün kusurlu.
​OrderSummary

Sipariş detay objesi

​OrderRefundRequestItemSummary[]

Sipariş iptal talebi kalemleri.

createdAt
​string · date-time

Sipariş iptal talebi nesnesinin oluşturulma zamanı.

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

Sipariş iptal talebi nesnesinin güncellenme zamanı.

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

OrderRefundRequest POST › Responses

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

status
​string · enum · required

Sipariş iptal talebinin durumu. Seçenekler: | approved: Onaylandı. | waiting_for_approval: Onay bekliyor. | cancelled: İptal edildi.

Enum values:
approved
waiting_for_approval
cancelled
refundReasonOrderSpecial1
refundReasonOrderSpecial2
Example: approved
autoPayback
​integer · enum · required

Otomatik geri ödeme durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Sipariş iptal talebi nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Sipariş iptal talebi için oluşturulan benzersiz kod değeri.

Example: KOD-1234
fee
​number · float

Müşteriye ödenecek tutar bilgisi.

Example: 15
shippingFee
​number · float

Kargo tutarı.

cancellationReason
​string · maxLength: 512

Sipariş iptal talebinin sebebine dair detaylı açıklama.

Example: Ürün kusurlu.
​OrderSummary

Sipariş detay objesi

​OrderRefundRequestItemSummary[]

Sipariş iptal talebi kalemleri.

createdAt
​string · date-time

Sipariş iptal talebi nesnesinin oluşturulma zamanı.

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

Sipariş iptal talebi nesnesinin güncellenme zamanı.

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

OrderRefundRequest COUNT

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

OrderRefundRequest 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 Order Refund Request 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. ids=1,2,3,4

sinceId
​integer · min: 1

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

q
​string

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

status
​string · enum

Status alanının alabilceği değerler: approved veya waiting_for_approval veya cancelled

Enum values:
approved
waiting_for_approval
cancelled
refundReasonOrderSpecial1
refundReasonOrderSpecial2
member
​integer · min: 1

Member Id

order
​integer · min: 1

Order Id

s
​string

Arama anahtarı ile filtreleme.

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

Start of the time frame

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

End of the time frame

customerFirstname
​string

Customer Firstname

customerSurname
​string

Customer Surname

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

Start of the time frame

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

End of the time frame

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


OrderRefundRequest GET

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

OrderRefundRequest GET › path Parameters

id
​string · pattern: \d+ · required

OrderRefundRequest GET › Responses

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

status
​string · enum · required

Sipariş iptal talebinin durumu. Seçenekler: | approved: Onaylandı. | waiting_for_approval: Onay bekliyor. | cancelled: İptal edildi.

Enum values:
approved
waiting_for_approval
cancelled
refundReasonOrderSpecial1
refundReasonOrderSpecial2
Example: approved
autoPayback
​integer · enum · required

Otomatik geri ödeme durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Sipariş iptal talebi nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Sipariş iptal talebi için oluşturulan benzersiz kod değeri.

Example: KOD-1234
fee
​number · float

Müşteriye ödenecek tutar bilgisi.

Example: 15
shippingFee
​number · float

Kargo tutarı.

cancellationReason
​string · maxLength: 512

Sipariş iptal talebinin sebebine dair detaylı açıklama.

Example: Ürün kusurlu.
​OrderSummary

Sipariş detay objesi

​OrderRefundRequestItemSummary[]

Sipariş iptal talebi kalemleri.

createdAt
​string · date-time

Sipariş iptal talebi nesnesinin oluşturulma zamanı.

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

Sipariş iptal talebi nesnesinin güncellenme zamanı.

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

OrderRefundRequest PUT

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

OrderRefundRequest PUT › path Parameters

id
​string · pattern: \d+ · required

OrderRefundRequest PUT › Request Body

status
​string · enum · required

Sipariş iptal talebinin durumu. Seçenekler: | approved: Onaylandı. | waiting_for_approval: Onay bekliyor. | cancelled: İptal edildi.

Enum values:
approved
waiting_for_approval
cancelled
refundReasonOrderSpecial1
refundReasonOrderSpecial2
Example: approved
autoPayback
​integer · enum · required

Otomatik geri ödeme durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Sipariş iptal talebi nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Sipariş iptal talebi için oluşturulan benzersiz kod değeri.

Example: KOD-1234
fee
​number · float

Müşteriye ödenecek tutar bilgisi.

Example: 15
shippingFee
​number · float

Kargo tutarı.

cancellationReason
​string · maxLength: 512

Sipariş iptal talebinin sebebine dair detaylı açıklama.

Example: Ürün kusurlu.
​OrderSummary

Sipariş detay objesi

​OrderRefundRequestItemSummary[]

Sipariş iptal talebi kalemleri.

createdAt
​string · date-time

Sipariş iptal talebi nesnesinin oluşturulma zamanı.

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

Sipariş iptal talebi nesnesinin güncellenme zamanı.

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

OrderRefundRequest PUT › Responses

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

status
​string · enum · required

Sipariş iptal talebinin durumu. Seçenekler: | approved: Onaylandı. | waiting_for_approval: Onay bekliyor. | cancelled: İptal edildi.

Enum values:
approved
waiting_for_approval
cancelled
refundReasonOrderSpecial1
refundReasonOrderSpecial2
Example: approved
autoPayback
​integer · enum · required

Otomatik geri ödeme durumu. Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
id
​integer

Sipariş iptal talebi nesnesi kimlik değeri.

Example: 123
code
​string · maxLength: 255

Sipariş iptal talebi için oluşturulan benzersiz kod değeri.

Example: KOD-1234
fee
​number · float

Müşteriye ödenecek tutar bilgisi.

Example: 15
shippingFee
​number · float

Kargo tutarı.

cancellationReason
​string · maxLength: 512

Sipariş iptal talebinin sebebine dair detaylı açıklama.

Example: Ürün kusurlu.
​OrderSummary

Sipariş detay objesi

​OrderRefundRequestItemSummary[]

Sipariş iptal talebi kalemleri.

createdAt
​string · date-time

Sipariş iptal talebi nesnesinin oluşturulma zamanı.

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

Sipariş iptal talebi nesnesinin güncellenme zamanı.

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

OrderRefundRequest DELETE

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

OrderRefundRequest DELETE › path Parameters

id
​string · pattern: \d+ · required

OrderRefundRequest DELETE › Responses

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

No data returned