Developer Kolay Deniz Market API v1.0 Mağazaya dön
API referansı · 12 uç nokta

Admin · Orders

Sipariş panosu ve karşılama operasyonu — toplama, kasa, sevk, teslim, iptal ve iade. ADMIN rolü gerekir.

GET /v1/admin/orders Bearer

Sipariş panosu

Parametreler

AdYerTipAçıklama
status query OrderStatus
branchId query string
slotId query string
date query string (date) Europe/Istanbul takvim günü (YYYY-MM-DD) — teknenin çıktığı gün.
q query string en fazla 64 karakter Serbest metin araması.
page query integer ≥ 1 · varsayılan 1
perPage query integer 1–100 · varsayılan 24

Yanıtlar

DurumGövdeAçıklama
200 PageMeta + { items: AdminOrderDto[] } Sipariş sayfası.
400 ApiError validation_failed — gövde veya query şemaya uymuyor (details).
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
GET /v1/admin/orders/{id} Bearer

Sipariş detayı

Müşteri, transfer, fatura ve KDV kırılımı dahil.

Parametreler

AdYerTipAçıklama
id * path string

Yanıtlar

DurumGövdeAçıklama
200 AdminOrderDto Sipariş.
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
404 ApiError order_not_found.
POST /v1/admin/orders/{id}/start-picking Bearer

Toplamaya başlar

PAIDPICKING.

Parametreler

AdYerTipAçıklama
id * path string

Yanıtlar

DurumGövdeAçıklama
200 AdminOrderDto Güncel sipariş.
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
404 ApiError order_not_found.
409 ApiError order_status_conflict — gövde expected ve actual taşır.
PATCH /v1/admin/orders/{id}/items/{itemId} Bearer

Eksik toplamayı kaydeder

pickedQty yalnızca azaltılabilir. Kayıt, stok defteri hareketi, raf sayım uyarısı ve müşterinin kısmi iadesi bu çağrının arkasından gelir. Satıcı entegrasyonundaki pick ucu da tam olarak bu yolu çalıştırır.

Parametreler

AdYerTipAçıklama
id * path string
itemId * path string

İstek gövdesi PickItemRequest

Yanıtlar

DurumGövdeAçıklama
200 ShortPickResult Eksik toplama sonucu.
400 ApiError validation_failed — gövde veya query şemaya uymuyor (details).
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
404 ApiError order_not_found veya order_item_not_found.
409 ApiError order_not_picking, picked_qty_above_ordered veya picked_qty_cannot_increase.
POST /v1/admin/orders/{id}/mark-packed Bearer

Kasayı hazır işaretler

PICKINGPACKED. Satıcı karşılamasında bu, kasanın teslim noktasında bizim personelimizce kabulüdür; zilyetlik burada geçer.

Parametreler

AdYerTipAçıklama
id * path string

Yanıtlar

DurumGövdeAçıklama
200 AdminOrderDto Güncel sipariş.
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
404 ApiError order_not_found.
409 ApiError order_status_conflict.
POST /v1/admin/orders/{id}/mark-out-for-delivery Bearer

Yola çıktı

PACKEDOUT_FOR_DELIVERY.

Parametreler

AdYerTipAçıklama
id * path string

Yanıtlar

DurumGövdeAçıklama
200 AdminOrderDto Güncel sipariş.
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
404 ApiError order_not_found.
409 ApiError order_status_conflict.
POST /v1/admin/orders/{id}/mark-delivered Bearer

Teslim edildi

OUT_FOR_DELIVERYDELIVERED.

Parametreler

AdYerTipAçıklama
id * path string

Yanıtlar

DurumGövdeAçıklama
200 AdminOrderDto Güncel sipariş.
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
404 ApiError order_not_found.
409 ApiError order_status_conflict.
POST /v1/admin/orders/{id}/mark-failed-delivery Bearer

Teslim edilemedi

OUT_FOR_DELIVERYFAILED_DELIVERY.

Parametreler

AdYerTipAçıklama
id * path string

İstek gövdesi FailedDeliveryRequest

Yanıtlar

DurumGövdeAçıklama
200 AdminOrderDto Güncel sipariş.
400 ApiError validation_failed — gövde veya query şemaya uymuyor (details).
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
404 ApiError order_not_found.
409 ApiError order_status_conflict.
POST /v1/admin/orders/{id}/assign-transfer Bearer

Transfer partneri atar

Parametreler

AdYerTipAçıklama
id * path string

İstek gövdesi AssignTransferRequest

Yanıtlar

DurumGövdeAçıklama
200 AdminOrderDto Güncel sipariş.
400 ApiError validation_failed — gövde veya query şemaya uymuyor (details).
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
404 ApiError order_not_found veya transfer_not_found.
409 ApiError transfer_inactive.
POST /v1/admin/orders/{id}/reslot Bearer

Slotu değiştirir

Parametreler

AdYerTipAçıklama
id * path string

İstek gövdesi ReslotRequest

Yanıtlar

DurumGövdeAçıklama
200 AdminOrderDto Güncel sipariş.
400 ApiError validation_failed veya slot_unchanged.
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
404 ApiError order_not_found, order_not_reslottable veya slot_not_found.
409 ApiError slot_unavailable veya order_status_conflict.
POST /v1/admin/orders/{id}/cancel Bearer

Siparişi iptal eder

Müşteri ucunun aksine PICKING ve sonrasında da çalışır. Tahsil edilmiş para varsa iade açılır ve yanıt açılan iadeleri taşır.

Parametreler

AdYerTipAçıklama
id * path string

İstek gövdesi CancelOrderRequest

Yanıtlar

DurumGövdeAçıklama
200 { order: AdminOrderDto, refunds: RefundDto[] } Sipariş ve açılan iadeler.
400 ApiError validation_failed — gövde veya query şemaya uymuyor (details).
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
404 ApiError order_not_found veya order_not_cancellable.
409 ApiError order_status_conflict.
POST /v1/admin/orders/{id}/refunds Bearer

İade açar

Ya bütün kalemler (orderItemIds) ya da açık bir tutar (amountKurus) — tam olarak biri. İkisi birden gönderilirse reddedilir: hangisinin kastedildiğini tahmin etmek müşteriye iki kez iade yapmanın yoludur.

Parametreler

AdYerTipAçıklama
id * path string

İstek gövdesi CreateRefundRequest

Yanıtlar

DurumGövdeAçıklama
201 RefundDto[] Açılan iadeler.
400 ApiError validation_failed — gövde veya query şemaya uymuyor (details).
401 ApiError missing_token, invalid_token veya unauthenticated.
403 ApiError insufficient_role — kimlik doğru, rol yetkili değil.
404 ApiError order_not_found, order_item_not_found veya no_captured_payment.
409 ApiError nothing_to_refund, invalid_refund_amount, refund_exceeds_payment, refund_not_allocatable, refund_target_ambiguous veya refund_target_missing.