API

Statistiken zu Vertriebskanälen abrufen

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

Gibt Umsatz, Bestellanzahl und durchschnittlichen Bestellwert für jeden Vertriebskanal zurück. Pro Anfrage werden Daten für bis zu zwei Zeiträume geliefert, um z. B. einen Monatsvergleich zu ermöglichen. Die Periodensummen sind bereits berechnet; für Diagramme werden nur belegte Stunden in UTC zurückgegeben. Konvertieren Sie diese in die Zeitzone des Nutzers und aggregieren Sie sie nach Tagen oder Monaten. In den Umsatz fließen nur abgeschlossene Bestellungen ein.

Autorisierung

api-token + language + role

Abfrageparameter

date_creation_fromstring

Beispiel: 01/08/2026

date_creation_tostring

Beispiel: 31/08/2026

date_comparison_fromstring

Zweite Periode; leer, wenn kein Vergleich möglich ist

Beispiel: 01/07/2026

date_comparison_tostring

Beispiel: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

Lieferart: Kurier oder Selbstabholung

Werte:courierpickup

payment_statusstring (OrderPayment)

Zahlungsstatus: nicht bezahlt, ausstehend, bezahlt

Werte:not_paidwaitingpaid

operator_idinteger
downloadstring

Gibt die Zusammenfassungstabelle für den Zeitraum A im CSV-Format statt JSON zurück

Werte:yes

Beispiel: yes

Antworten

OK

object
statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringkann null sein

Beispiel: 2026-08-01 00:00:00

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_creation_toobject (FilterDateTo)
valuestringkann null sein

Beispiel: 2026-08-31 23:59:59

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_creation_rangeobject (FilterDateRange)

Vordefinierte Datumsfilterzeiträume; die Untergrenze wird in der Zeitzone des Benutzers berechnet. value — der Zeitraum, dem die aktuellen *_from und *_to entsprechen; null — benutzerdefinierter Zeitraum. default — der Zeitraum, den der Server bei Anfragen ohne Datumsangaben verwendet: Er wird auch beim ersten Laden des Bereichs angewendet und bei Zurücksetzen wiederhergestellt. Das obere Ende des Zeitraums entspricht immer dem aktuellen Tag des Benutzers, daher enthält option dieses nicht: Für vordefinierte Zeiträume muss *_to nicht übergeben werden, der Server setzt es automatisch. Zeiträume, die länger als ein Jahr sind, werden an der aktuellen Grenze abgeschnitten.

valuestring (DateRange) kann null sein

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

defaultstring (DateRange) erforderlich

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

typestringerforderlich

Beispiel: select

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

optionarray of objecterforderlich
valuestring (DateRange) erforderlich

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

date_fromstringerforderlich

Beispiel: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringkann null sein

Beispiel: 2026-08-01 00:00:00

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_comparison_toobject (FilterDateTo)
valuestringkann null sein

Beispiel: 2026-08-31 23:59:59

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Vorgefertigte Datumsbereichsfilter ohne Standardwert: default ist immer null.

valuestring (DateRange) kann null sein

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

defaultstring (DateRange) kann null sein

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

typestringerforderlich

Beispiel: select

optionarray of objecterforderlich
valuestring (DateRange) erforderlich

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

date_fromstringerforderlich

Beispiel: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

delivery_methodobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string
modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

payment_statusobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string
modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

downloadobject (FilterButtonDownloadCsv)

Download-Button für die Auswahl: Beim Klicken übergeben Sie download=yes

valuestring

Beispiel: Download

typestringerforderlich

Beispiel: button_download_csv

periodsarray of object

Ein Element pro Zeitraum; das zweite nur, wenn ein Vergleichszeitraum angegeben ist

keystringerforderlich

a — Hauptzeitraum, b — Vergleichszeitraum

Werte:ab

Beispiel: a

date_fromstringerforderlich

Beispiel: 01/08/2026

date_tostringerforderlich

Beispiel: 31/08/2026

totalobject (SalesChannelsTotal) erforderlich

Gesamtergebnisse des Zeitraums für alle Vertriebskanäle

orders_countintegererforderlich

Beispiel: 4120

completed_countintegererforderlich

Beispiel: 3894

completed_percentnumbererforderlich

Beispiel: 94.51

revenuenumbererforderlich

Beispiel: 4361280

averagenumbererforderlich

Beispiel: 1120

channelsarray of objecterforderlich

Ein Element für jeden Bestellkanal in fester Reihenfolge. Das Element „alle Kanäle“ ist nicht enthalten; hierfür gibt es total.

platformstring (OrderPlatform) erforderlich

Bestellplattform

Werte:androidapifbiosvksite

orders_countintegererforderlich

Beispiel: 1810

orders_sharenumbererforderlich

Anteil der Bestellungen im Zeitraum in Prozent

Beispiel: 43.93

completed_countintegererforderlich

Beispiel: 1702

completed_percentnumbererforderlich

Beispiel: 94.03

revenuenumbererforderlich

Beispiel: 1855180

revenue_sharenumbererforderlich

Umsatzanteil des Zeitraums in Prozent

Beispiel: 42.54

averagenumbererforderlich

Umsatz, geteilt durch die Anzahl der abgeschlossenen Bestellungen

Beispiel: 1090

deltaobject (SalesChannelsDelta) erforderlichkann null sein

Vergleich des Kanals mit demselben Kanal im Zeitraum B. null, wenn Zeitraum B nicht angegeben ist.

revenue_absolutenumbererforderlich

Beispiel: -120400

revenue_percentnumbererforderlichkann null sein

null, wenn im Zeitraum B kein Umsatz über den Kanal erzielt wurde: Es gibt kein prozentuales Wachstum von Null

Beispiel: -6.09

bucketsarray of objecterforderlich

Bestellungen, gruppiert nach Stunden; nur Stunden mit Bestellungen. Konvertieren Sie die Zeit in die Zeitzone des Benutzers und aggregieren Sie die Stunden zu Datenpunkten für das Diagramm: Liniendiagramm – nach Tagen oder Monaten, Säulendiagramm – nach Kalendermonaten. Summieren Sie count, completed_count und revenue; mittlere Werte nicht mitteln.

datetimestringerforderlich

Die Stunde, auf die sich die Bestellungen beziehen, in UTC

Beispiel: 2026-08-01 09:00:00

countintegererforderlich

Beispiel: 12

completed_countintegererforderlich

Beispiel: 11

revenuenumbererforderlich

Beispiel: 12100