API

Pobierz statystyki kanałów sprzedaży

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

Zwraca przychód, liczbę zamówień oraz średnią wartość zamówienia dla każdego kanału sprzedaży. W jednym żądaniu można pobrać dane maksymalnie dla dwóch okresów, aby porównać miesiąc do miesiąca. Podsumowania okresów są już obliczone, a do wykresów zwracane są niepuste godziny w UTC. Przekonwertuj je na strefę czasową użytkownika i zgrupuj według dni lub miesięcy. Do przychodu wliczane są tylko zrealizowane zamówienia.

Autoryzacja

api-token + language + role

Parametry zapytania

date_creation_fromstring

Przykład: 01/08/2026

date_creation_tostring

Przykład: 31/08/2026

date_comparison_fromstring

Drugi okres; pusty, jeśli nie ma z czym porównać

Przykład: 01/07/2026

date_comparison_tostring

Przykład: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

Sposób dostawy: kurier lub odbiór osobisty

Wartości:courierpickup

payment_statusstring (OrderPayment)

Status płatności: nieopłacone, oczekuje, opłacone

Wartości:not_paidwaitingpaid

operator_idinteger
downloadstring

Zwraca tabelę zbiorczą za okres A w formacie CSV zamiast JSON

Wartości:yes

Przykład: yes

Odpowiedzi

OK

object
statusstringwymagane

Wartości:successerror

Przykład: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringmoże być null

Przykład: 2026-08-01 00:00:00

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_creation_toobject (FilterDateTo)
valuestringmoże być null

Przykład: 2026-08-31 23:59:59

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_creation_rangeobject (FilterDateRange)

Gotowe okresy filtrowania według daty; dolna granica jest obliczana w strefie czasowej użytkownika. value — okres, któremu odpowiadają bieżące *_from i *_to; null — dowolny okres. default — okres, który serwer ustawia w zapytaniu bez dat: jest stosowany przy pierwszym ładowaniu sekcji oraz po resecie. Górna granica okresu zawsze odpowiada bieżącemu dniu użytkownika, dlatego option jej nie zawiera: nie trzeba przekazywać *_to dla gotowego okresu, serwer ustawia ją samodzielnie. Okres dłuższy niż rok jest obcinany od najnowszej granicy.

valuestring (DateRange) może być null

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

defaultstring (DateRange) wymagane

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

typestringwymagane

Przykład: select

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

optionarray of objectwymagane
valuestring (DateRange) wymagane

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

date_fromstringwymagane

Przykład: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringmoże być null

Przykład: 2026-08-01 00:00:00

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_comparison_toobject (FilterDateTo)
valuestringmoże być null

Przykład: 2026-08-31 23:59:59

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Gotowe okresy filtrowania dat bez wartości domyślnej: default zawsze równa się null.

valuestring (DateRange) może być null

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

defaultstring (DateRange) może być null

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

typestringwymagane

Przykład: select

optionarray of objectwymagane
valuestring (DateRange) wymagane

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

date_fromstringwymagane

Przykład: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

delivery_methodobject (FilterEnum)

Filtr-wyliczenie — płaska lista wartości wyliczenia

valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of string
modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

payment_statusobject (FilterEnum)

Filtr-wyliczenie — płaska lista wartości wyliczenia

valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of string
modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

downloadobject (FilterButtonDownloadCsv)

Przycisk pobierania wyników: po kliknięciu przekaż download=yes

valuestring

Przykład: Download

typestringwymagane

Przykład: button_download_csv

periodsarray of object

Jeden element na okres; drugi — tylko jeśli określono okres porównawczy

keystringwymagane

a — główny okres, b — okres porównawczy

Wartości:ab

Przykład: a

date_fromstringwymagane

Przykład: 01/08/2026

date_tostringwymagane

Przykład: 31/08/2026

totalobject (SalesChannelsTotal) wymagane

Podsumowanie okresu dla wszystkich kanałów

orders_countintegerwymagane

Przykład: 4120

completed_countintegerwymagane

Przykład: 3894

completed_percentnumberwymagane

Przykład: 94.51

revenuenumberwymagane

Przykład: 4361280

averagenumberwymagane

Przykład: 1120

channelsarray of objectwymagane

Jeden element dla każdego kanału z zamówieniami, w ustalonej kolejności. Element „wszystkie kanały” nie występuje: do tego służy total.

platformstring (OrderPlatform) wymagane

Platforma zamówień

Wartości:androidapifbiosvksite

orders_countintegerwymagane

Przykład: 1810

orders_sharenumberwymagane

Udział zamówień w okresie (w procentach)

Przykład: 43.93

completed_countintegerwymagane

Przykład: 1702

completed_percentnumberwymagane

Przykład: 94.03

revenuenumberwymagane

Przykład: 1855180

revenue_sharenumberwymagane

Udział przychodu za okres w procentach

Przykład: 42.54

averagenumberwymagane

Przychód podzielony przez liczbę zrealizowanych zamówień

Przykład: 1090

deltaobject (SalesChannelsDelta) wymaganemoże być null

Porównanie kanału z tym samym kanałem w okresie B. null, jeśli okres B nie jest określony.

revenue_absolutenumberwymagane

Przykład: -120400

revenue_percentnumberwymaganemoże być null

null, jeśli w okresie B kanał nie miał przychodu: nie ma procentowego wzrostu od zera

Przykład: -6.09

bucketsarray of objectwymagane

Zamówienia pogrupowane według godzin; tylko niepuste godziny. Przekonwertuj czas na strefę czasową użytkownika, następnie zgrupuj godziny jako punkty wykresu: wykres liniowy — według dni lub miesięcy, wykres słupkowy — według miesięcy kalendarzowych. Sumuj wartości count, completed_count i revenue; nie uśredniaj wartości średnich.

datetimestringwymagane

Godzina, do której odnoszą się zamówienia, w UTC

Przykład: 2026-08-01 09:00:00

countintegerwymagane

Przykład: 12

completed_countintegerwymagane

Przykład: 11

revenuenumberwymagane

Przykład: 12100