API

Тапсырыстар тізімін алу

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

Авторизация

api-token + language + role

Сұраныс параметрлері

cursorinteger

Бетті оқу басталатын позиция: алға — pagination.next_cursor, артқа — pagination.previous_cursor; бірінші бет үшін жібермеңіз. Бұл — салыстыру шекарасы, жолға сілтеме емес: мән көрсеткен жол болмауы мүмкін, сондықтан ескірген сілтеме де бетті сол жерден ашады. Қате 346 тек мәнді оң бүтін сан ретінде талдау мүмкін болмаған жағдайда қайтарылады.

Мысал: 84512

directionstring

Курсордан оқу бағыты; last тізімнің соңын ашады және курсорды елемейді

Мәндер:nextpreviouslast

Әдепкі бойынша: next

date_creation_fromstring

Мысал: 25/04/2024

date_creation_tostring

Мысал: 26/04/2024

chain_idinteger
branch_idinteger
phone_format_idinteger
phone_numberstring
emailstring
order_statusstring (OrderStatus)

Тапсырыс күйі: жолда, орындалды, жинау, асханада, өңделмеген, жіберуге дайын, асханаға жіберуді күтуде, қайта жасауды күтуде, күшін жойды, расталды, дайындалды

Мәндер:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Мысал: confirmed

platformstring (OrderPlatform)

Тапсырыс платформасы

Мәндер:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Жеткізу тәсілі: курьер немесе өздігінен алып кету

Мәндер:courierpickup

payment_statusstring (OrderPayment)

Төлем күйі: төленбеген, күтілуде, төленген

Мәндер:not_paidwaitingpaid

order_numberinteger
client_branch_profile_idinteger
client_account_idinteger
operator_idinteger
courier_idinteger
promo_codestring

Тапсырыстарды промокод бойынша сүзу (тапсырыстағы акцияларға қолданылған промокодпен дәл сәйкестік)

Мысал: Promo1

hide_completed_ordersstring

Мәндер:true

Мысал: true

downloadstring

Мәндер:yes

Мысал: yes

Жауаптар

OK

object
statusstringміндетті

Мәндер:successerror

Мысал: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringnull мәнін қабылдай алады

Мысал: 2026-08-01 00:00:00

typestringміндетті

Мысал: date

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

date_creation_toobject (FilterDateTo)
valuestringnull мәнін қабылдай алады

Мысал: 2026-08-31 23:59:59

typestringміндетті

Мысал: date

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

date_creation_rangeobject (FilterDateRange)

Дайын күндер бойынша сүзгілеу кезеңдері; төменгі шегі пайдаланушының уақыт белдеуінде есептеледі. value — ағымдағы *_from және *_to сәйкес келетін кезең; null — еркін кезең. default — сервер күндерсіз сұраныста қолданатын кезең: бұл кезең бөлім алғаш жүктелгенде және қалпына келтіру кезінде қолданылады. Кезеңнің жоғарғы шегі әрқашан пайдаланушының ағымдағы күніне тең, сондықтан option оны қамтымайды: дайын кезең үшін *_to жіберудің қажеті жоқ, сервер оны өзі орнатады. Бір жылдан ұзақ кезең жаңа шегінен қысқартылады.

valuestring (DateRange) null мәнін қабылдай алады

Дайын күн бойынша сүзгі кезеңі. Оның жеке сұраныс параметрі жоқ: төменгі шегі есептелген түрде option ішінде келеді және *_from орнына қойылады. Жоғарғы шегі жауапта да, сұраныста да берілмейді — ол әрқашан пайдаланушының ағымдағы күніне тең және сервер арқылы орнатылады.

Мәндер:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Мысал: today

defaultstring (DateRange) міндетті

Дайын күн бойынша сүзгі кезеңі. Оның жеке сұраныс параметрі жоқ: төменгі шегі есептелген түрде option ішінде келеді және *_from орнына қойылады. Жоғарғы шегі жауапта да, сұраныста да берілмейді — ол әрқашан пайдаланушының ағымдағы күніне тең және сервер арқылы орнатылады.

Мәндер:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Мысал: today

typestringміндетті

Мысал: select

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

optionarray of objectміндетті
valuestring (DateRange) міндетті

Дайын күн бойынша сүзгі кезеңі. Оның жеке сұраныс параметрі жоқ: төменгі шегі есептелген түрде option ішінде келеді және *_from орнына қойылады. Жоғарғы шегі жауапта да, сұраныста да берілмейді — ол әрқашан пайдаланушының ағымдағы күніне тең және сервер арқылы орнатылады.

Мәндер:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Мысал: today

date_fromstringміндетті

Мысал: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Мысал: 8920

typestringміндетті

Мысал: select

optionarray of object
valueintegerміндетті

Мысал: 8920

namestringміндетті

Мысал: Green Basket | Kaliningrad

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Мысал: 8920

typestringміндетті

Мысал: select

optionarray of object
valueintegerміндетті

Мысал: 8920

namestringміндетті

Мысал: Green Basket | Kaliningrad

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Мысал: 8920

typestringміндетті

Мысал: select

optionarray of object
valueintegerміндетті

Мысал: 8920

namestringміндетті

Мысал: Green Basket | Kaliningrad

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

phone_numberobject (FilterInput)
valuestring

Мысал: example

typestringміндетті

Мысал: integer or string

placeholderstring

Мысал: string

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

emailobject (FilterInput)
valuestring

Мысал: example

typestringміндетті

Мысал: integer or string

placeholderstring

Мысал: string

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

order_statusobject (FilterEnum)

Фильтр-тізім — enum мәндерінің жазық тізімі

valuestring

Мысал: example

typestringміндетті

Мысал: select

optionarray of string
modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

platformobject (FilterEnum)

Фильтр-тізім — enum мәндерінің жазық тізімі

valuestring

Мысал: example

typestringміндетті

Мысал: select

optionarray of string
modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

delivery_methodobject (FilterEnum)

Фильтр-тізім — enum мәндерінің жазық тізімі

valuestring

Мысал: example

typestringміндетті

Мысал: select

optionarray of string
modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

payment_statusobject (FilterEnum)

Фильтр-тізім — enum мәндерінің жазық тізімі

valuestring

Мысал: example

typestringміндетті

Мысал: select

optionarray of string
modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

order_numberobject (FilterId)
valueany

Мысал: 0

typestringміндетті

Мысал: integer

placeholderstring

Мысал: integer

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

client_branch_profile_idobject (FilterId)
valueany

Мысал: 0

typestringміндетті

Мысал: integer

placeholderstring

Мысал: integer

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

client_account_idobject (FilterId)
valueany

Мысал: 0

typestringміндетті

Мысал: integer

placeholderstring

Мысал: integer

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Мысал: 8920

typestringміндетті

Мысал: select

optionarray of object
valueintegerміндетті

Мысал: 8920

namestringміндетті

Мысал: Green Basket | Kaliningrad

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

courier_idobject (FilterSelectInteger)
valueinteger

Мысал: 8920

typestringміндетті

Мысал: select

optionarray of object
valueintegerміндетті

Мысал: 8920

namestringміндетті

Мысал: Green Basket | Kaliningrad

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

promo_codeobject (FilterInput)
valuestring

Мысал: example

typestringміндетті

Мысал: integer or string

placeholderstring

Мысал: string

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

hide_completed_ordersobject (FilterBooleanCheckbox)
valueboolean

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

Мысал: false

typestringміндетті

Мысал: checkbox

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

downloadobject (FilterButtonDownloadCsv)

Таңдау жүктеу түймесі: басқанда download=yes жіберіңіз

valuestring

Мысал: Download

typestringміндетті

Мысал: button_download_csv

listarray of object
idintegerміндетті

Мысал: 12863367

branch_idintegerміндетті

Мысал: 9054

sms_statusstring (OrderSmsStatus) міндетті

SMS күйі

Мәндер: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) міндетті

Email күйі

Мәндер:errorwaitingsuccessneed_email

order_statusstring (OrderStatus) міндетті

Тапсырыс күйі: жолда, орындалды, жинау, асханада, өңделмеген, жіберуге дайын, асханаға жіберуді күтуде, қайта жасауды күтуде, күшін жойды, расталды, дайындалды

Мәндер:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Мысал: confirmed

cart_totalnumberміндетті

Мысал: 100.55

order_numberinteger

Мысал: 1

date_creationstring (DataTimeFormatSQL) міндетті

Мысал: 2024-05-02 08:31:16

date_preorderstring (DataTimeFormatSQL)

Мысал: 2024-05-02 08:31:16

timestamp_countdownintegerміндетті

Мысал: 1718625496

time_preorderinteger

Мысал: 7160

seconds_for_timerinteger

Мысал: -14500

last_order_doneboolean

Мысал: true

minutes_to_doneinteger

Мысал: 60

payment_statusstring (OrderPayment) міндетті

Төлем күйі: төленбеген, күтілуде, төленген

Мәндер:not_paidwaitingpaid

payment_methodstring (OrderPaymentMethod)

Төлем әдісі

Мәндер:cashonlinecard_upon_receipt

platformstring (Platform) міндетті

Мәндер:androidiosallmobile_appssitesocial_apps

Мысал: all

operator_phone_format_idinteger (PhoneFormatId)

Ел коды: 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)

Мысал: 1

operator_phone_numberstring

Мысал: 9114579423

operator_emailstring

Мысал: email@example.com

percent_rateintegerміндетті

Мысал: 4

sender_namestring

Мысал: John Doe

sender_phone_format_idinteger (PhoneFormatId)

Ел коды: 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)

Мысал: 1

sender_phone_numberstring

Мысал: 9114579423

sender_emailstring

Мысал: email@example.com

recipient_namestring

Мысал: John Doe

recipient_phone_format_idinteger (PhoneFormatId)

Ел коды: 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)

Мысал: 1

recipient_phone_numberstring

Мысал: 9114579423

address_zip_codestring

Мысал: 236039

address_line_1string

Мысал: Korablestroiteley st. 9 bld. 2

address_line_2string

Мысал: Korablestroiteley st. 9 bld. 2

address_streetstring

Мысал: Partizanskaya street

address_housestring

Мысал: 20

address_buildingstring

Мысал: 20

address_entrance_numberstring

Мысал: 20

address_entrance_codestring

Мысал: 1234

address_floorstring

Мысал: 10

address_apartmentstring

Мысал: 10

additional_changestring

Мысал: 100

additional_personsstring

Мысал: 2

additional_commentstring

Мысал: Test order, remove

additional_greeting_cardstring

Мысал: example

additional_discountstring

Мысал: example

tokenstring

Мысал: 72901fbe661d3e142ea9af5248856f20

delivery_methodstring (DeliveryMethod) міндетті

Жеткізу әдісі: no — жоқ, all — барлық, courier — курьер, pickup — өзімен алып кету

Мәндер:noallcourierpickup

phone_settingsobject
mask_enableboolean

Мысал: true

formatboolean

Мысал: true

internationalboolean

Мысал: true

branch_namestring

Мысал: Green Basket | Main

chain_namestringміндетті

Мысал: Green Basket

city_namestringміндетті

Мысал: Voronezh

courier_namestring

Мысал: courier name

district_namestring

Мысал: Voronezh-Uh

district_idinteger

Мысал: 55329

application_uuidstring

Мысал: 03addc0d-1051-4534-9ba8-792b763a274b

paginationobject (PaginationCursor)
max_countintegerміндетті

Беттегі элементтер саны

Мысал: 30

cursorintegerміндеттіnull мәнін қабылдай алады

Ағымдағы бет сұралған курсор; бірінші бет үшін — null

next_cursorintegerміндеттіnull мәнін қабылдай алады

Осы беттегі соңғы жолдың id: алға өту үшін оны direction=next параметрімен жіберіңіз; әрі қарай ештеңе болмаса — null

Мысал: 84512

previous_cursorintegerміндеттіnull мәнін қабылдай алады

Осы беттегі бірінші жолдың id: оны direction=previous параметрімен жіберіңіз, артқа өту үшін; бұрын ештеңе болмаса — null

Мысал: 84543

has_nextbooleanміндетті

Келесі бет бар ма

Мысал: true

has_previousbooleanміндетті

Алдыңғы бет бар ма

Мысал: false