API

Obține statistici despre canalele de vânzări

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

Returnează venitul, numărul de comenzi și bonul mediu pentru fiecare canal de vânzare. Pentru o singură cerere se pot returna până la două perioade, pentru a compara lună la lună. Totalurile pentru perioadă sunt deja calculate, iar pentru grafice se returnează doar orele nenule în UTC. Conversia acestora în fusul orar al utilizatorului și agregarea pe zile sau luni trebuie realizate de către client. În venit sunt incluse doar comenzile finalizate.

Autorizare

api-token + language + role

Parametri de interogare

date_creation_fromstring

Exemplu: 01/08/2026

date_creation_tostring

Exemplu: 31/08/2026

date_comparison_fromstring

A doua perioadă; gol dacă nu există cu ce compara

Exemplu: 01/07/2026

date_comparison_tostring

Exemplu: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

Metoda de livrare: curier sau ridicare personală

Valori:courierpickup

payment_statusstring (OrderPayment)

Stare plată: neplătit, în așteptare, plătit

Valori:not_paidwaitingpaid

operator_idinteger
downloadstring

Returnează un tabel sumar pentru perioada A în format CSV în loc de JSON

Valori:yes

Exemplu: yes

Răspunsuri

OK

object
statusstringobligatoriu

Valori:successerror

Exemplu: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpoate fi null

Exemplu: 2026-08-01 00:00:00

typestringobligatoriu

Exemplu: date

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

date_creation_toobject (FilterDateTo)
valuestringpoate fi null

Exemplu: 2026-08-31 23:59:59

typestringobligatoriu

Exemplu: date

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

date_creation_rangeobject (FilterDateRange)

Perioade predefinite pentru filtrul de dată; limita inferioară este calculată în fusul orar al utilizatorului. value — perioada pentru care corespund valorile curente *_from și *_to; null — perioadă personalizată. default — perioada pe care serverul o setează în cererile fără date: aceasta se aplică la prima încărcare a secțiunii și la resetare. Limita superioară a perioadei este întotdeauna egală cu ziua curentă a utilizatorului, de aceea option nu o conține: nu este necesar să transmiteți *_to pentru o perioadă predefinită, serverul o setează automat. O perioadă mai lungă de un an este tăiată dinspre limita recentă.

valuestring (DateRange) poate fi null

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

defaultstring (DateRange) obligatoriu

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

typestringobligatoriu

Exemplu: select

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

optionarray of objectobligatoriu
valuestring (DateRange) obligatoriu

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

date_fromstringobligatoriu

Exemplu: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringpoate fi null

Exemplu: 2026-08-01 00:00:00

typestringobligatoriu

Exemplu: date

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

date_comparison_toobject (FilterDateTo)
valuestringpoate fi null

Exemplu: 2026-08-31 23:59:59

typestringobligatoriu

Exemplu: date

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Perioade predefinite pentru filtrul de date fără valoare implicită: default este întotdeauna null.

valuestring (DateRange) poate fi null

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

defaultstring (DateRange) poate fi null

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

typestringobligatoriu

Exemplu: select

optionarray of objectobligatoriu
valuestring (DateRange) obligatoriu

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

date_fromstringobligatoriu

Exemplu: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

delivery_methodobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

payment_statusobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

downloadobject (FilterButtonDownloadCsv)

Buton de descărcare a selecției: la apăsare, transmiteți download=yes

valuestring

Exemplu: Download

typestringobligatoriu

Exemplu: button_download_csv

periodsarray of object

Un element pentru perioada curentă; al doilea — doar dacă este specificată o perioadă de comparație

keystringobligatoriu

a — perioada principală, b — perioada de comparație

Valori:ab

Exemplu: a

date_fromstringobligatoriu

Exemplu: 01/08/2026

date_tostringobligatoriu

Exemplu: 31/08/2026

totalobject (SalesChannelsTotal) obligatoriu

Totalul perioadei pentru toate canalele

orders_countintegerobligatoriu

Exemplu: 4120

completed_countintegerobligatoriu

Exemplu: 3894

completed_percentnumberobligatoriu

Exemplu: 94.51

revenuenumberobligatoriu

Exemplu: 4361280

averagenumberobligatoriu

Exemplu: 1120

channelsarray of objectobligatoriu

Un element pentru fiecare canal cu comenzi, în ordine fixă. Nu există elementul „toate canalele”: pentru aceasta există total.

platformstring (OrderPlatform) obligatoriu

Platforma de comandă

Valori:androidapifbiosvksite

orders_countintegerobligatoriu

Exemplu: 1810

orders_sharenumberobligatoriu

Procentajul comenzilor pentru perioadă

Exemplu: 43.93

completed_countintegerobligatoriu

Exemplu: 1702

completed_percentnumberobligatoriu

Exemplu: 94.03

revenuenumberobligatoriu

Exemplu: 1855180

revenue_sharenumberobligatoriu

Cota procentuală din venit pentru perioadă

Exemplu: 42.54

averagenumberobligatoriu

Venituri împărțite la numărul de comenzi finalizate

Exemplu: 1090

deltaobject (SalesChannelsDelta) obligatoriupoate fi null

Compararea canalului cu același canal în perioada B. null dacă perioada B nu este setată.

revenue_absolutenumberobligatoriu

Exemplu: -120400

revenue_percentnumberobligatoriupoate fi null

null, dacă în perioada B canalul nu a avut venituri: nu există creștere procentuală de la zero

Exemplu: -6.09

bucketsarray of objectobligatoriu

Comenzi grupate pe ore; doar orele care nu sunt goale. Conversia timpului se face în fusul orar al utilizatorului, apoi orele sunt agregate ca puncte pe grafic: grafic liniar — pe zile sau luni, grafic cu bare — pe luni calendaristice. Sumați valorile count, completed_count și revenue; nu mediați valorile medii.

datetimestringobligatoriu

Ora la care se referă comenzile, în UTC

Exemplu: 2026-08-01 09:00:00

countintegerobligatoriu

Exemplu: 12

completed_countintegerobligatoriu

Exemplu: 11

revenuenumberobligatoriu

Exemplu: 12100