API

Сату арналары бойынша статистиканы алу

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

Әрбір сату арнасы бойынша түсім, тапсырыстар саны және орташа чек мәнін қайтарады. Бір сұраныста екі кезеңге дейін қайтарылады, бұл айларды салыстыруға мүмкіндік береді. Кезең бойынша қорытындылар алдын ала есептелген, ал графиктер үшін UTC уақытындағы бос емес сағаттар қайтарылады. Оларды пайдаланушының уақыт белдеуіне ауыстырып, күндерге немесе айларға біріктіріңіз. Түсімге тек орындалған тапсырыстар кіреді.

Авторизация

api-token + language + role

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

date_creation_fromstring

Мысал: 01/08/2026

date_creation_tostring

Мысал: 31/08/2026

date_comparison_fromstring

Екінші кезең; салыстыратын ештеңе болмаса, бос

Мысал: 01/07/2026

date_comparison_tostring

Мысал: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

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

Мәндер:courierpickup

payment_statusstring (OrderPayment)

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

Мәндер:not_paidwaitingpaid

operator_idinteger
downloadstring

A кезеңінің жиынтық кестесін CSV форматында қайтарады, JSON орнына

Мәндер: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

date_comparison_fromobject (FilterDateFrom)
valuestringnull мәнін қабылдай алады

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

typestringміндетті

Мысал: date

modestring (FilterMode)

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

Мәндер:force_shownvalue_required

Мысал: value_required

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

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

typestringміндетті

Мысал: date

modestring (FilterMode)

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

Мәндер:force_shownvalue_required

Мысал: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Дайын күндер ауқымының фильтрлері әдепкі мәнсіз: default әрқашан null мәніне тең.

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

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

Мәндер:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Мысал: today

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

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

Мәндер:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Мысал: today

typestringміндетті

Мысал: select

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

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

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

downloadobject (FilterButtonDownloadCsv)

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

valuestring

Мысал: Download

typestringміндетті

Мысал: button_download_csv

periodsarray of object

Бір элемент — негізгі кезең үшін; екіншісі — тек салыстыру кезеңі көрсетілсе

keystringміндетті

a — негізгі кезең, b — салыстыру кезеңі

Мәндер:ab

Мысал: a

date_fromstringміндетті

Мысал: 01/08/2026

date_tostringміндетті

Мысал: 31/08/2026

totalobject (SalesChannelsTotal) міндетті

Период бойынша барлық арналар бойынша қорытындылар

orders_countintegerміндетті

Мысал: 4120

completed_countintegerміндетті

Мысал: 3894

completed_percentnumberміндетті

Мысал: 94.51

revenuenumberміндетті

Мысал: 4361280

averagenumberміндетті

Мысал: 1120

channelsarray of objectміндетті

Әр тапсырыс арнасына бір элемент, бекітілген ретпен. «Барлық арналар» элементі жоқ: ол үшін total қолданылады.

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

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

Мәндер:androidapifbiosvksite

orders_countintegerміндетті

Мысал: 1810

orders_sharenumberміндетті

Периодтағы тапсырыстардың үлесі (пайызбен)

Мысал: 43.93

completed_countintegerміндетті

Мысал: 1702

completed_percentnumberміндетті

Мысал: 94.03

revenuenumberміндетті

Мысал: 1855180

revenue_sharenumberміндетті

Периодтағы кіріс үлесі (пайызбен)

Мысал: 42.54

averagenumberміндетті

Түсім, орындалған тапсырыстар санына бөлінген

Мысал: 1090

deltaobject (SalesChannelsDelta) міндеттіnull мәнін қабылдай алады

Каналдың B кезеңіндегі сол арнамен салыстырылуы. Егер B кезеңі көрсетілмесе, null.

revenue_absolutenumberміндетті

Мысал: -120400

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

null, егері B кезеңінде арнада кіріс болмаған болса: нөлден пайыздық өсу болмайды

Мысал: -6.09

bucketsarray of objectміндетті

Тапсырыстар сағат бойынша топтастырылған; тек бос емес сағаттар. Уақытты пайдаланушының уақыт белдеуіне ауыстырыңыз, содан кейін сағаттарды график нүктелеріне біріктіріңіз: сызықтық график — күндер немесе айлар бойынша, бағандық — күнтізбелік айлар бойынша. count, completed_count және revenue мәндерін қосыңыз; орташа мәндерді орташа есептемеңіз.

datetimestringміндетті

Тапсырыстарға қатысты уақыт, UTC бойынша

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

countintegerміндетті

Мысал: 12

completed_countintegerміндетті

Мысал: 11

revenuenumberміндетті

Мысал: 12100