API

Saada müügikanalite statistika

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

Tagastab käibe, tellimuste arvu ja keskmise tšeki iga müügikanali kohta. Ühe päringuga tagastatakse kuni kaks perioodi, et võrrelda näiteks kuud kuuga. Perioodi kokkuvõtted on juba arvutatud, graafikute jaoks tagastatakse ainult mitte-tühjad tunnid UTC-s. Teisendage need kasutaja ajavööndisse ja koondage päevade või kuude kaupa. Käibesse arvestatakse ainult täidetud tellimused.

Autoriseerimine

api-token + language + role

Päringu parameetrid

date_creation_fromstring

Näide: 01/08/2026

date_creation_tostring

Näide: 31/08/2026

date_comparison_fromstring

Teine periood; tühi, kui pole millegagi võrrelda

Näide: 01/07/2026

date_comparison_tostring

Näide: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

Tarneviis: kuller või ise järele tulemine

Väärtused:courierpickup

payment_statusstring (OrderPayment)

Makse staatus: maksmata, ootel, makstud

Väärtused:not_paidwaitingpaid

operator_idinteger
downloadstring

Tagastab perioodi A kokkuvõtliku tabeli CSV-vormingus JSON-i asemel

Väärtused:yes

Näide: yes

Vastused

OK

object
statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringvõib olla null

Näide: 2026-08-01 00:00:00

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_creation_toobject (FilterDateTo)
valuestringvõib olla null

Näide: 2026-08-31 23:59:59

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_creation_rangeobject (FilterDateRange)

Valmis kuupäevafiltri perioodid; alumine piir arvutatakse kasutaja ajavööndi järgi. value — periood, millele vastavad praegused *_from ja *_to; null — suvaline periood. default — periood, mille server lisab päringusse ilma kuupäevadeta: seda kasutatakse ka jaotise esmasel laadimisel ning lähtestamisel. Perioodi ülemine piir on alati kasutaja tänane päev, seetõttu option seda ei sisalda: valmisperioodi puhul pole vaja *_to edastada, server määrab selle ise. Üle aasta pikkune periood kärbitakse uuema piiri poolt.

valuestring (DateRange) võib olla null

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

defaultstring (DateRange) kohustuslik

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

typestringkohustuslik

Näide: select

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

optionarray of objectkohustuslik
valuestring (DateRange) kohustuslik

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

date_fromstringkohustuslik

Näide: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringvõib olla null

Näide: 2026-08-01 00:00:00

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_comparison_toobject (FilterDateTo)
valuestringvõib olla null

Näide: 2026-08-31 23:59:59

typestringkohustuslik

Näide: date

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Valmis kuupäevavahemiku filtrid ilma vaikimisi väärtuseta: default on alati null.

valuestring (DateRange) võib olla null

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

defaultstring (DateRange) võib olla null

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

typestringkohustuslik

Näide: select

optionarray of objectkohustuslik
valuestring (DateRange) kohustuslik

Valmis kuupäevafiltri periood. Sellel ei ole oma päringuparameetrit: alumine piir arvutatakse ette ja edastatakse option kaudu ning kasutatakse väljal *_from. Ülemist piiri ei edastata vastuses ega päringus — see on alati võrdne kasutaja jooksva kuupäevaga ja määratakse serveri poolt.

Väärtused:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Näide: today

date_fromstringkohustuslik

Näide: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

delivery_methodobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of string
modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

payment_statusobject (FilterEnum)

Filtri enum — tasane loend enum väärtustest

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of string
modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

downloadobject (FilterButtonDownloadCsv)

Allalaadimisnupp: vajutamisel edastage download=yes

valuestring

Näide: Download

typestringkohustuslik

Näide: button_download_csv

periodsarray of object

Üks element perioodi kohta; teine — ainult siis, kui on määratud võrdlusperiood

keystringkohustuslik

a — põhiperiood, b — võrdlusperiood

Väärtused:ab

Näide: a

date_fromstringkohustuslik

Näide: 01/08/2026

date_tostringkohustuslik

Näide: 31/08/2026

totalobject (SalesChannelsTotal) kohustuslik

Perioodi kokkuvõte kõigi kanalite lõikes

orders_countintegerkohustuslik

Näide: 4120

completed_countintegerkohustuslik

Näide: 3894

completed_percentnumberkohustuslik

Näide: 94.51

revenuenumberkohustuslik

Näide: 4361280

averagenumberkohustuslik

Näide: 1120

channelsarray of objectkohustuslik

Üks element iga tellimustega kanali kohta, fikseeritud järjekorras. Elementi „kõik kanalid” ei ole: selleks on olemas total.

platformstring (OrderPlatform) kohustuslik

Tellimuse platvorm

Väärtused:androidapifbiosvksite

orders_countintegerkohustuslik

Näide: 1810

orders_sharenumberkohustuslik

Perioodi tellimuste osakaal protsentides

Näide: 43.93

completed_countintegerkohustuslik

Näide: 1702

completed_percentnumberkohustuslik

Näide: 94.03

revenuenumberkohustuslik

Näide: 1855180

revenue_sharenumberkohustuslik

Perioodi tulude osakaal protsentides

Näide: 42.54

averagenumberkohustuslik

Tulu, jagatud täidetud tellimuste arvuga

Näide: 1090

deltaobject (SalesChannelsDelta) kohustuslikvõib olla null

Võrdlus kanaliga samas kanalis perioodil B. null, kui periood B pole määratud.

revenue_absolutenumberkohustuslik

Näide: -120400

revenue_percentnumberkohustuslikvõib olla null

null, kui perioodil B kanalil puudus tulu: protsendiline kasv nullist puudub

Näide: -6.09

bucketsarray of objectkohustuslik

Tellimused, rühmitatud tundide kaupa; ainult mitte-tühjad tunnid. Teisenda aeg kasutaja ajavööndisse, seejärel koonda tunnid graafiku punktideks: joondiagramm — päevade või kuude kaupa, tulpdiagramm — kalendrikuude kaupa. Summeeri count, completed_count ja revenue; ära arvuta keskmisi väärtusi.

datetimestringkohustuslik

Tund, millele tellimused viitavad, UTC-s

Näide: 2026-08-01 09:00:00

countintegerkohustuslik

Näide: 12

completed_countintegerkohustuslik

Näide: 11

revenuenumberkohustuslik

Näide: 12100