API

Dapatkan heatmap pesanan berdasarkan waktu

GET/api/crm/v2/orders_over_timev2
operationId: ordersOverTime.default

Mengembalikan heatmap pesanan: jam dalam sehari menurut hari dalam minggu, hari kalender, atau bulan. Maksimal dua periode dapat dikembalikan dalam satu permintaan untuk membandingkan minggu ke minggu atau bulan ke bulan. Pesanan diakumulasi per jam dalam UTC, dan hanya jam yang tidak kosong yang dikembalikan. Konversi ke zona waktu pengguna, pengelompokan baris, dan sel kosong dilakukan di sisi klien.

Otorisasi

api-token + language + role

Parameter permintaan

date_creation_fromstring

Contoh: 25/04/2024

date_creation_tostring

Contoh: 26/04/2024

date_comparison_fromstring

Periode kedua; kosong jika tidak ada perbandingan

Contoh: 25/03/2024

date_comparison_tostring

Contoh: 26/03/2024

granularitystring (OrdersOverTimeGranularity)

Baris grid: hari dalam seminggu, hari kalender, atau bulan. Hanya mempengaruhi tampilan dan tidak pernah mempengaruhi agregasi.

Nilai:weekdaydaymonth

chain_idinteger
branch_idinteger
order_statusstring (OrderStatus)

Status pesanan: dalam perjalanan, selesai, dalam perakitan, di dapur, belum diproses, siap dikirim, menunggu dikirim ke dapur, menunggu perbaikan, dibatalkan, dikonfirmasi, sudah dimasak

Nilai:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Contoh: confirmed

platformstring (OrderPlatform)

Platform pemesanan

Nilai:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Metode pengiriman: kurir atau ambil sendiri

Nilai:courierpickup

payment_statusstring (OrderPayment)

Status pembayaran: belum dibayar, menunggu, dibayar

Nilai:not_paidwaitingpaid

operator_idinteger
courier_idinteger

Tanggapan

OK

object
statusstringwajib

Nilai:successerror

Contoh: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringdapat bernilai null

Contoh: 2026-08-01 00:00:00

typestringwajib

Contoh: date

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

date_creation_toobject (FilterDateTo)
valuestringdapat bernilai null

Contoh: 2026-08-31 23:59:59

typestringwajib

Contoh: date

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

date_creation_rangeobject (FilterDateRange)

Periode filter tanggal yang sudah jadi; batas bawah dihitung berdasarkan zona waktu pengguna. value — periode yang sesuai dengan *_from dan *_to saat ini; null — periode kustom. default — periode yang akan diisi server dalam permintaan tanpa tanggal: juga digunakan saat pertama kali membuka bagian, dan saat reset kembali ke periode ini. Batas atas periode selalu sama dengan hari saat ini pengguna, sehingga option tidak menyertakannya: tidak perlu mengirimkan *_to untuk periode siap pakai, server akan menetapkannya secara otomatis. Periode yang lebih dari satu tahun akan dipotong dari sisi batas terbaru.

valuestring (DateRange) dapat bernilai null

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

defaultstring (DateRange) wajib

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

typestringwajib

Contoh: select

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

optionarray of objectwajib
valuestring (DateRange) wajib

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

date_fromstringwajib

Contoh: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringdapat bernilai null

Contoh: 2026-08-01 00:00:00

typestringwajib

Contoh: date

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

date_comparison_toobject (FilterDateTo)
valuestringdapat bernilai null

Contoh: 2026-08-31 23:59:59

typestringwajib

Contoh: date

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Periode filter tanggal siap pakai tanpa nilai default: default selalu bernilai null.

valuestring (DateRange) dapat bernilai null

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

defaultstring (DateRange) dapat bernilai null

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

typestringwajib

Contoh: select

optionarray of objectwajib
valuestring (DateRange) wajib

Periode filter tanggal yang sudah siap. Tidak memiliki parameter permintaan sendiri: batas bawah sudah dihitung di option dan dimasukkan ke *_from. Batas atas tidak dikirimkan baik dalam respons maupun permintaan — selalu sama dengan hari ini menurut pengguna dan ditetapkan oleh server.

Nilai:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Contoh: today

date_fromstringwajib

Contoh: 25/08/2026

granularityobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

chain_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

order_statusobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

platformobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

delivery_methodobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

payment_statusobject (FilterEnum)

Filter enum — daftar nilai enum datar

valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of string
modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

courier_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

periodsarray of object
keystringwajib

Nilai:ab

Contoh: a

date_fromstringwajib

Contoh: 25/04/2024

date_tostringwajib

Contoh: 26/04/2024

rangestringwajibdapat bernilai null

Periode siap pakai yang sesuai dengan batas; null jika periode bersifat sewenang-wenang

Contoh: week

totalobject (OrdersOverTimeValues) wajib
countintegerwajib

Contoh: 47

sumnumberwajib

Contoh: 52640

averagenumberwajib

Contoh: 1120

bucketsarray of objectwajibdapat bernilai null

Pesanan yang dikelompokkan per jam; hanya jam yang tidak kosong. Konversikan waktu ke zona waktu pengguna, lalu tentukan baris dan kolom berdasarkan hasilnya dan isi kekosongan dengan nol.

datetimestringwajib

Jam terkait pesanan, dalam UTC

Contoh: 2024-04-25 14:00:00

countintegerwajib

Contoh: 47

sumnumberwajib

Contoh: 52640