API

Liste der Push-Benachrichtigungen abrufen

GET/api/crm/v2/push_notificationsv2
operationId: pushNotifications.default

Autorisierung

api-token + language + role

Abfrageparameter

date_creation_fromstring

Beispiel: 25/04/2024

date_creation_tostring

Beispiel: 26/04/2024

chain_idinteger

Beispiel: 7124

branch_idinteger
page_numberinteger

Beispiel: 1

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

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

firms_prices_pushnumber

Beispiel: 0.06

holiday_datesarray of string
listarray of object
idintegererforderlich

Beispiel: 1

statusstring (StatusPushNotifications) erforderlich

Werte:in_queuerunsuccesserrorend_with_error

Beispiel: in_queue

branch_idintegererforderlich

Beispiel: 1

titlestring

Beispiel: title

ios_successintegererforderlich

Beispiel: 0

ios_failureintegererforderlich

Beispiel: 0

android_successintegererforderlich

Beispiel: 0

android_failureintegererforderlich

Beispiel: 0

site_successintegererforderlich

Beispiel: 0

site_failureintegererforderlich

Beispiel: 0

price_onenumbererforderlich

Beispiel: 0

messagestringerforderlich

Beispiel: Lorem Ipsum is simply dummy text of the printing and typesetting industry

platformstring (Platform) erforderlich

Werte:androidiosallmobile_appssitesocial_apps

Beispiel: all

genderstring (Gender)

Werte:womanman

Beispiel: man

date_of_birth_fromstring

Beispiel: 09/07

date_of_birth_tostring

Beispiel: 10/07

date_creationstring (DataTimeFormatSQL) erforderlich

Beispiel: 2024-05-02 08:31:16

date_sendingstring (DataTimeFormatSQL) erforderlich

Beispiel: 2024-05-02 08:31:16

date_last_order_fromstring (DataTimeFormatSQL)

Beispiel: 2024-05-02 08:31:16

date_last_order_tostring (DataTimeFormatSQL)

Beispiel: 2024-05-02 08:31:16

namestringerforderlich

Name des Netzwerks

Beispiel: Green Basket

city_namestringerforderlich

Beispiel: Voronezh

sumnumber

Kosten der Push-Benachrichtigung

Beispiel: 0

paginationobject (Pagination)
max_countintegererforderlich

Anzahl der Elemente pro Seite

Beispiel: 30

page_numberintegererforderlich

Nummer der aktuellen Seite; begrenzt, sodass der Offset 1000 nicht überschreitet

Beispiel: 1

has_nextbooleanerforderlich

Gibt es eine nächste Seite

Beispiel: true

has_previousbooleanerforderlich

Gibt es eine vorherige Seite

Beispiel: false