API

Mendapatkan daftar pesanan

GET/api/crm/v2/ordersv2
operationId: orders.default

Otorisasi

api-token + language + role

Parameter permintaan

cursorinteger

Posisi untuk mulai membaca halaman: pagination.next_cursor — maju, pagination.previous_cursor — mundur; untuk halaman pertama, jangan kirimkan parameter ini. Ini adalah batas perbandingan, bukan referensi ke baris: baris yang ditunjuk oleh nilai tersebut mungkin tidak ada, sehingga tautan lama tetap membuka halaman dari posisi yang sama. Error 346 hanya dikembalikan jika nilai tidak dapat diurai sebagai bilangan bulat positif.

Contoh: 84512

directionstring

Arah pembacaan dari kursor; last membuka akhir daftar dan mengabaikan kursor

Nilai:nextpreviouslast

Secara default: next

date_creation_fromstring

Contoh: 25/04/2024

date_creation_tostring

Contoh: 26/04/2024

chain_idinteger
branch_idinteger
phone_format_idinteger
phone_numberstring
emailstring
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

order_numberinteger
client_branch_profile_idinteger
client_account_idinteger
operator_idinteger
courier_idinteger
promo_codestring

Filter pesanan berdasarkan kode promo (cocok persis dengan kode promo yang diterapkan pada promosi pesanan)

Contoh: Promo1

hide_completed_ordersstring

Nilai:true

Contoh: true

downloadstring

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

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

phone_format_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

phone_numberobject (FilterInput)
valuestring

Contoh: example

typestringwajib

Contoh: integer or string

placeholderstring

Contoh: 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

emailobject (FilterInput)
valuestring

Contoh: example

typestringwajib

Contoh: integer or string

placeholderstring

Contoh: 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

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

order_numberobject (FilterId)
valueany

Contoh: 0

typestringwajib

Contoh: integer

placeholderstring

Contoh: integer

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

client_branch_profile_idobject (FilterId)
valueany

Contoh: 0

typestringwajib

Contoh: integer

placeholderstring

Contoh: integer

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

client_account_idobject (FilterId)
valueany

Contoh: 0

typestringwajib

Contoh: integer

placeholderstring

Contoh: integer

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

promo_codeobject (FilterInput)
valuestring

Contoh: example

typestringwajib

Contoh: integer or string

placeholderstring

Contoh: 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

hide_completed_ordersobject (FilterBooleanCheckbox)
valueboolean

Для true передайте 1 в запросе, для false ничего не передавайте

Contoh: false

typestringwajib

Contoh: checkbox

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

listarray of object
idintegerwajib

Contoh: 12863367

branch_idintegerwajib

Contoh: 9054

sms_statusstring (OrderSmsStatus) wajib

Status SMS

Nilai:errorsuccessempty_fieldswrong_phonewrong_api_fieldsserver_not_availablenot_enough_moneywaitingneed_phoneoperators_not_connected_to_botssend_via_bots_failedsending_via_botssent_via_botssent_via_maxsent_via_telegramunsupported_sms_serviceapi_disabledwrong_sender_name

email_statusstring (OrderEmailStatus) wajib

Status email

Nilai:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) wajib

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

cart_totalnumberwajib

Contoh: 100.55

order_numberinteger

Contoh: 1

date_creationstring (DataTimeFormatSQL) wajib

Contoh: 2024-05-02 08:31:16

date_preorderstring (DataTimeFormatSQL)

Contoh: 2024-05-02 08:31:16

timestamp_countdownintegerwajib

Contoh: 1718625496

time_preorderinteger

Contoh: 7160

seconds_for_timerinteger

Contoh: -14500

last_order_doneboolean

Contoh: true

minutes_to_doneinteger

Contoh: 60

payment_statusstring (OrderPayment) wajib

Status pembayaran: belum dibayar, menunggu, dibayar

Nilai:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Metode pembayaran

Nilai:cashonlinecard_upon_receipt

platformstring (Platform) wajib

Nilai:androidiosallmobile_appssitesocial_apps

Contoh: all

operator_phone_format_idinteger (PhoneFormatId)

Kode negara: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Contoh: 1

operator_phone_numberstring

Contoh: 9114579423

operator_emailstring

Contoh: email@example.com

percent_rateintegerwajib

Contoh: 4

sender_namestring

Contoh: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Kode negara: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Contoh: 1

sender_phone_numberstring

Contoh: 9114579423

sender_emailstring

Contoh: email@example.com

recipient_namestring

Contoh: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Kode negara: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Contoh: 1

recipient_phone_numberstring

Contoh: 9114579423

address_zip_codestring

Contoh: 236039

address_line_1string

Contoh: Korablestroiteley st. 9 bld. 2

address_line_2string

Contoh: Korablestroiteley st. 9 bld. 2

address_streetstring

Contoh: Partizanskaya street

address_housestring

Contoh: 20

address_buildingstring

Contoh: 20

address_entrance_numberstring

Contoh: 20

address_entrance_codestring

Contoh: 1234

address_floorstring

Contoh: 10

address_apartmentstring

Contoh: 10

additional_changestring

Contoh: 100

additional_personsstring

Contoh: 2

additional_commentstring

Contoh: Test order, remove

additional_greeting_cardstring

Contoh: example

additional_discountstring

Contoh: example

tokenstring

Contoh: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) wajib

Metode pengiriman: no — tidak ada, all — semua, courier — kurir, pickup — ambil sendiri

Nilai:noallcourierpickup

phone_settingsobject
mask_enableboolean

Contoh: true

formatboolean

Contoh: true

internationalboolean

Contoh: true

branch_namestring

Contoh: Green Basket | Main

chain_namestringwajib

Contoh: Green Basket

city_namestringwajib

Contoh: Voronezh

courier_namestring

Contoh: courier name

district_namestring

Contoh: Voronezh-Uh

district_idinteger

Contoh: 55329

application_uuidstring

Contoh: 03addc0d-1051-4534-9ba8-792b763a274b

paginationobject (PaginationCursor)
max_countintegerwajib

Jumlah elemen per halaman

Contoh: 30

cursorintegerwajibdapat bernilai null

Cursor yang digunakan untuk meminta halaman saat ini; null — untuk halaman pertama

next_cursorintegerwajibdapat bernilai null

id dari baris terakhir di halaman ini: kirimkan bersama direction=next untuk melanjutkan ke depan; null — jika tidak ada data berikutnya

Contoh: 84512

previous_cursorintegerwajibdapat bernilai null

id dari baris pertama di halaman ini: kirimkan bersama direction=previous untuk menavigasi ke belakang; null — jika tidak ada data sebelumnya

Contoh: 84543

has_nextbooleanwajib

Apakah ada halaman berikutnya

Contoh: true

has_previousbooleanwajib

Apakah ada halaman sebelumnya

Contoh: false