API

Dapatkan statistik saluran penjualan

GET/api/crm/v2/sales_channelsv2
operationId: salesChannels.default

Mengembalikan pendapatan, jumlah pesanan, dan rata-rata nilai transaksi untuk setiap saluran penjualan. Dalam satu permintaan, hingga dua periode dapat dikembalikan untuk membandingkan bulan ke bulan. Total periode sudah dihitung, dan untuk grafik dikembalikan jam-jam yang tidak kosong dalam UTC. Konversikan ke zona waktu pengguna dan kelompokkan berdasarkan hari atau bulan. Pendapatan hanya mencakup pesanan yang telah diselesaikan.

Otorisasi

api-token + language + role

Parameter permintaan

date_creation_fromstring

Contoh: 01/08/2026

date_creation_tostring

Contoh: 31/08/2026

date_comparison_fromstring

Periode kedua; kosong jika tidak ada perbandingan

Contoh: 01/07/2026

date_comparison_tostring

Contoh: 31/07/2026

chain_idinteger
branch_idinteger
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
downloadstring

Mengembalikan tabel ringkasan untuk periode A dalam format CSV, bukan JSON

Nilai:yes

Contoh: yes

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

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

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

downloadobject (FilterButtonDownloadCsv)

Tombol unduh hasil filter: saat ditekan, kirimkan download=yes

valuestring

Contoh: Download

typestringwajib

Contoh: button_download_csv

periodsarray of object

Satu elemen per periode; yang kedua — hanya jika periode perbandingan ditentukan

keystringwajib

a — periode utama, b — periode perbandingan

Nilai:ab

Contoh: a

date_fromstringwajib

Contoh: 01/08/2026

date_tostringwajib

Contoh: 31/08/2026

totalobject (SalesChannelsTotal) wajib

Ringkasan periode untuk semua saluran

orders_countintegerwajib

Contoh: 4120

completed_countintegerwajib

Contoh: 3894

completed_percentnumberwajib

Contoh: 94.51

revenuenumberwajib

Contoh: 4361280

averagenumberwajib

Contoh: 1120

channelsarray of objectwajib

Satu elemen untuk setiap saluran dengan pesanan, dalam urutan tetap. Tidak ada elemen "semua saluran": untuk ini gunakan total.

platformstring (OrderPlatform) wajib

Platform pemesanan

Nilai:androidapifbiosvksite

orders_countintegerwajib

Contoh: 1810

orders_sharenumberwajib

Persentase pesanan selama periode

Contoh: 43.93

completed_countintegerwajib

Contoh: 1702

completed_percentnumberwajib

Contoh: 94.03

revenuenumberwajib

Contoh: 1855180

revenue_sharenumberwajib

Persentase pendapatan periode

Contoh: 42.54

averagenumberwajib

Pendapatan dibagi dengan jumlah pesanan yang diselesaikan

Contoh: 1090

deltaobject (SalesChannelsDelta) wajibdapat bernilai null

Perbandingan saluran dengan saluran yang sama pada periode B. null jika periode B tidak ditentukan.

revenue_absolutenumberwajib

Contoh: -120400

revenue_percentnumberwajibdapat bernilai null

null, jika pada periode B saluran tidak memiliki pendapatan: tidak ada pertumbuhan persentase dari nol

Contoh: -6.09

bucketsarray of objectwajib

Pesanan yang dikelompokkan per jam; hanya jam yang tidak kosong. Konversikan waktu ke zona waktu pengguna, lalu kelompokkan jam menjadi titik grafik: grafik garis — per hari atau bulan, grafik batang — per bulan kalender. Jumlahkan count, completed_count, dan revenue; jangan rata-ratakan nilai rata-rata.

datetimestringwajib

Jam terkait pesanan, dalam UTC

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

countintegerwajib

Contoh: 12

completed_countintegerwajib

Contoh: 11

revenuenumberwajib

Contoh: 12100