API

Gauti pardavimo kanalų statistiką

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

Grąžina pajamas, užsakymų skaičių ir vidutinę čekio sumą pagal kiekvieną pardavimo kanalą. Viename užklausoje grąžinami du laikotarpiai, kad būtų galima palyginti mėnesį su mėnesiu. Laikotarpio suvestinės jau apskaičiuotos, o grafikuose grąžinamos tik neužpildytos valandos UTC laiku. Konvertuokite jas į naudotojo laiko juostą ir sugrupuokite pagal dienas arba mėnesius. Į pajamas įtraukiami tik įvykdyti užsakymai.

Autorizacija

api-token + language + role

Užklausos parametrai

date_creation_fromstring

Pavyzdys: 01/08/2026

date_creation_tostring

Pavyzdys: 31/08/2026

date_comparison_fromstring

Antras laikotarpis; tuščias, jei nėra su kuo palyginti

Pavyzdys: 01/07/2026

date_comparison_tostring

Pavyzdys: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

Pristatymo būdas: kurjeris arba atsiėmimas

Reikšmės:courierpickup

payment_statusstring (OrderPayment)

Mokėjimo būsena: neapmokėta, laukiama, apmokėta

Reikšmės:not_paidwaitingpaid

operator_idinteger
downloadstring

Grąžina A laikotarpio suvestinę lentelę CSV formatu vietoje JSON

Reikšmės:yes

Pavyzdys: yes

Atsakymai

OK

object
statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringgali būti null

Pavyzdys: 2026-08-01 00:00:00

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_creation_toobject (FilterDateTo)
valuestringgali būti null

Pavyzdys: 2026-08-31 23:59:59

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_creation_rangeobject (FilterDateRange)

Paruošti datos filtro laikotarpiai; apatinė riba apskaičiuojama pagal naudotojo laiko juostą. value — laikotarpis, kuriam atitinka dabartiniai *_from ir *_to; null — pasirinktinis laikotarpis. default — laikotarpis, kurį serveris naudoja užklausoje be datų: jis taip pat taikomas pirmą kartą įkėlus skyrių ir grąžinamas atstatant nustatymus. Viršutinė laikotarpio riba visada lygi dabartinei naudotojo dienai, todėl option jos neturi: perduoti *_to paruoštam laikotarpiui nereikia, serveris ją nustato automatiškai. Laikotarpis, ilgesnis nei metai, nukerpamas nuo naujesnės ribos.

valuestring (DateRange) gali būti null

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

defaultstring (DateRange) privalomas

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

typestringprivalomas

Pavyzdys: select

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

optionarray of objectprivalomas
valuestring (DateRange) privalomas

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

date_fromstringprivalomas

Pavyzdys: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringgali būti null

Pavyzdys: 2026-08-01 00:00:00

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_comparison_toobject (FilterDateTo)
valuestringgali būti null

Pavyzdys: 2026-08-31 23:59:59

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Paruošti datų filtro laikotarpiai be numatytosios reikšmės: default visada yra null.

valuestring (DateRange) gali būti null

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

defaultstring (DateRange) gali būti null

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

typestringprivalomas

Pavyzdys: select

optionarray of objectprivalomas
valuestring (DateRange) privalomas

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

date_fromstringprivalomas

Pavyzdys: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

delivery_methodobject (FilterEnum)

Filtras-enumeracija — plokščias enumeracijos reikšmių sąrašas

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of string
modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

payment_statusobject (FilterEnum)

Filtras-enumeracija — plokščias enumeracijos reikšmių sąrašas

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of string
modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

downloadobject (FilterButtonDownloadCsv)

Atsisiuntimo mygtukas: paspaudus perduokite download=yes

valuestring

Pavyzdys: Download

typestringprivalomas

Pavyzdys: button_download_csv

periodsarray of object

Vienas elementas vienam laikotarpiui; antras — tik jei nurodytas palyginimo laikotarpis

keystringprivalomas

a — pagrindinis laikotarpis, b — palyginamasis laikotarpis

Reikšmės:ab

Pavyzdys: a

date_fromstringprivalomas

Pavyzdys: 01/08/2026

date_tostringprivalomas

Pavyzdys: 31/08/2026

totalobject (SalesChannelsTotal) privalomas

Laikotarpio rezultatai pagal visus kanalus

orders_countintegerprivalomas

Pavyzdys: 4120

completed_countintegerprivalomas

Pavyzdys: 3894

completed_percentnumberprivalomas

Pavyzdys: 94.51

revenuenumberprivalomas

Pavyzdys: 4361280

averagenumberprivalomas

Pavyzdys: 1120

channelsarray of objectprivalomas

Vienas elementas kiekvienam užsakymų kanalui, fiksuota tvarka. Nėra elemento „visi kanalai“: tam yra total.

platformstring (OrderPlatform) privalomas

Užsakymo platforma

Reikšmės:androidapifbiosvksite

orders_countintegerprivalomas

Pavyzdys: 1810

orders_sharenumberprivalomas

Užsakymų dalis periode procentais

Pavyzdys: 43.93

completed_countintegerprivalomas

Pavyzdys: 1702

completed_percentnumberprivalomas

Pavyzdys: 94.03

revenuenumberprivalomas

Pavyzdys: 1855180

revenue_sharenumberprivalomas

Pajamų dalis procentais per laikotarpį

Pavyzdys: 42.54

averagenumberprivalomas

Pajamos, padalytos iš įvykdytų užsakymų skaičiaus

Pavyzdys: 1090

deltaobject (SalesChannelsDelta) privalomasgali būti null

Palyginimas su tuo pačiu kanalu B laikotarpiu. null, jei B laikotarpis nenustatytas.

revenue_absolutenumberprivalomas

Pavyzdys: -120400

revenue_percentnumberprivalomasgali būti null

null, jei per B laikotarpį kanalas negavo pajamų: procentinis augimas nuo nulio neskaičiuojamas

Pavyzdys: -6.09

bucketsarray of objectprivalomas

Užsakymai, sugrupuoti pagal valandas; tik neužpildytos valandos neįtraukiamos. Laiką konvertuokite į naudotojo laiko juostą, tada valandas sujunkite į grafiko taškus: linijinė diagrama — pagal dienas arba mėnesius, stulpelinė — pagal kalendorinius mėnesius. Sumokite count, completed_count ir revenue; neskaičiuokite vidurkių.

datetimestringprivalomas

Laikas, kuriam priklauso užsakymai, UTC

Pavyzdys: 2026-08-01 09:00:00

countintegerprivalomas

Pavyzdys: 12

completed_countintegerprivalomas

Pavyzdys: 11

revenuenumberprivalomas

Pavyzdys: 12100