newsType

number

Nachrichtentyp (Pflichtfeld zum Anlegen eines Eintrags, kann nachträglich nicht geändert werden)

0 = Push-Nachricht
1 = News
2 = Teaser

0

Ja

title

string

Überschrift (max. 64 Zeichen)

""

Ja (außer Teaser)

text

string

Nachrichtentext, der im "News"-Reiter angezeigt werden soll. (max. 160 Zeichen)

""

Ja (außer Teaser)

urlType

string

Art der angegebenen URL
"internal-login" = Die angegebene URL wird innerhalb der App aufgerufen. Durch den mitgeschickten Authentifizierungstoken ist der User (wenn in der App angemeldet) direkt im Shop angemeldet
"internal" = Die angegebene URL wird innerhalb der App aufgerufen. In Gegensatz zu "internal-login" ist der User nicht automatisch im Shop angemeldet.
"external" = Die angegebene URL wird in einem separaten Browser aufgerufen (vorzugsweise für externe URLs geeignet).

""

Nein

url

string

URL, die bei Klick geöffnet werden soll (max. 160 Zeichen)

""

Ja, wenn "urlType" angegeben wurde

image_url

string

relativer Pfad zum Teaserbild (relativ ab benutzer/appdata/bilder )

""

Ja, wenn Nachricht vom Typ Teaser ist

validFrom

number

Timestamp, ab dem die Nachricht angezeigt werden soll

0

Ja

validUntil

number

Timestamp, bis zu dem die Nachricht angezeigt werden soll

0

Ja

active

bool

Schalter, damit die Nachricht aktiv an Geräte verteilt wird. Der Versand von Push-Nachrichten muss zusätzlich über einen separaten Endpunkt angestoßen werden.

false

Ja

400

Fehlerhafter Content. Genauerer Fehlergrund innerhalb vom Response-Body

title

string

Überschrift

""

Ja (außer Teaser)

text

string

Nachrichtentext, der im "News"-Reiter angezeigt werden soll

""

Ja (außer Teaser)

urlType

string

Art der angegebenen URL

"internal-login" = Die angegebene URL wird innerhalb der App aufgerufen. Durch den mitgeschickten Authentifizierungstoken ist der User (wenn in der App angemeldet) direkt im Shop angemeldet
"internal" = Die angegebene URL wird innerhalb der App aufgerufen. In Gegensatz zu "internal-login" ist der User nicht automatisch im Shop angemeldet.
"external" = Die angegebene URL wird in einem separaten Browser aufgerufen (vorzugsweise für externe URLs geeignet).

""

Nein

url

string

URL, die bei Klick geöffnet werden soll

""

Ja, wenn urlType angegeben wurde

image_url

string

relativer Pfad zum Teaserbild (relativ ab benutzer/appdata/bilder )

""

Ja, wenn Nachricht vom Typ Teaser ist

validFrom

number

Timestamp, ab dem die Nachricht angezeigt werden soll

0

Ja

validUntil

number

Timestamp, bis zu dem die Nachricht angezeigt werden soll

0

Ja

active

bool

Schalter, damit die Nachricht aktiv an Geräte verteilt wird. Der Versand von Push-Nachrichten muss zusätzlich über einen separaten Endpunkt angestoßen werden.

false

Ja

400

Fehlerhafter Content. Genauerer Fehlergrund innerhalb vom Response-Body

404

Der Eintrag mit der angegebenen ID existiert nicht.

404

Der Eintrag mit der angegebenen ID existiert nicht.

406

Der angegebene Eintrag ist nicht vom Typ 'Push-Nachricht', ist noch nicht aktiv oder wurde bereits verschickt.

name

string

Interne Bezeichnung der Push-Nachricht zur Identifikation in der Versandliste

""

Ja

message

object

Objekt mit allen Informationen der Nachrichten

{}

Ja

message.title

string

Überschrift* (max. 64 Zeichen)

""

Ja

message.text

string

Nachrichtentext, der im "News"-Reiter angezeigt werden soll* (max. 160 Zeichen)

""

Ja

message.urlType

string

Art der angegebenen URL
"internal-login" = Die angegebene URL wird innerhalb der App aufgerufen. Durch den mitgeschickten Authentifizierungstoken ist der User (wenn in der App angemeldet) direkt im Shop angemeldet
"internal" = Die angegebene URL wird innerhalb der App aufgerufen. In Gegensatz zu "internal-login" ist der User nicht automatisch im Shop angemeldet.
"external" = Die angegebene URL wird in einem separaten Browser aufgerufen (vorzugsweise für externe URLs geeignet).

""

Nein

message.url

string

URL, die bei Klick geöffnet werden soll (max. 128 Zeichen)
Wenn ein personalisierter Gutschein mitgeschickt werden soll, kann dieser über das Tag ~VOUCHER-Number~ an die URL angehängt werden.

""

Ja, wenn urlType angegeben wurde

message.voucher

string

Chargen-ID einer im Gutscheingenerator hinterlegten Gutschein-Charge

""

Nein

message.validUntil

number

Anzahl Tage, die die Nachricht auf den Geräten im News-Bereich angezeigt werden soll. (zw. 1 und 31)

1

Ja

filter

object

Filterkriterien für die Auswahl der Empfänger

{}

Nein

filter.connected

bool

Filterkriterium, ob eine Push-Nachricht nur an verbundene Geräte (true), nur an nicht verbundene Geräte (false) oder an alle Geräte (Filter nicht gesetzt) verschickt werden soll.

not set

Nein

filter.os_type

string

Filterung auf ein spezifisches Betriebssystem.
"ios" = iOS-Geräte
"android" = Android-Geräte

not set

Nein

filter.email

array<string>

Liste von E-Mail-Adressen, die als Empfänger berücksichtigt werden sollen.
Der Filter kann nur gewählt werden, wenn nur an verbundene Geräte geschickt werden soll.

not set

Nein

filter.zip

array<string>

Filterung auf Postleitzahl. Die Empfänger müssen eine der im Array angegebenen Postleitzahlen in ihrer Rechnungsadresse stehen haben.
Der Filter kann nur gewählt werden, wenn nur an verbundene Geräte geschickt werden soll.

not set

Nein

filter.zip_area

aray<object>

Liste von Postleitzahlenbereichen, in der ein Empfänger steht. Dies ist nur bei Empfängern möglich, die eine rein numerische Postleitzahl in
der Rechnungsadresse besitzen.
Der Filter kann nur gewählt werden, wenn nur an verbundene Geräte geschickt werden soll.

not set

Nein

filter.zip_area[n].from

number

Beginn des zu filternden Postleitzahlenbereichs

not set

Nein

filter.zip_area[n].to

number

Ende des zu filternden Postleitzahlenbereichs

not set

Nein

~A-FirstName~

Vorname

~A-LastName~

Nachname

~A-Street1~

Straße

~A-Street2~

Straßenzusatz

~A-Title~

Titel

~A-Salutation~

Anrede

~A-City~

Stadt

~A-Zip~

Postleitzahl

~A-CompleteSalutation~

Begrüßung (durch Shop generiert)

~VOUCHER-Number~

Personalisierte Gutscheinnummer (sofern eine Chargen-ID angegeben wurde)

400

Der übergebene Content ist fehlerhaft.

id

ID der Push-Nachricht

status

Status des Versands

Mögliche Werte:
0 = Beginn
1 = Initialisierung des Versands
2 = Aktiver Versand
3 = Beendet
4 = Manuell abgebrochen
5 = Abgebrochen durch Fehler

subshop

Subshop, für den die Nachricht erstellt wurde

type

Typ der Push-Nachricht:
0 = Push-Nachricht über OSB-Dienst
1 = Push-Nachricht über REST-API
2 = Versandbestätigungsnachricht
3 = Erinnerung bei stehengelassenen Warenkörben
4 = Geburtstagsgrüße

name

Interne Bezeichnung der Push-Nachricht zur Identifikation in der Versandliste

createTime

Zeitstempel, wann die Push-Nachricht erstellt wurde

updateTime

Zeitstempel, wann der Eintrag zuletzt aktualisiert wurde

validUntil

Anzahl Tage, die die Nachricht auf den Geräten im News-Bereich angezeigt werden soll

title

Nachrichtentitel

text

Nachrichtentext

urlType

Art der angegebenen URL

url

URL, die bei Klick geöffnet werden soll.

voucher

Angegebene Chargen-ID des zu personalisierten Gutscheins

countReceiver

Gesamtzahl der Empfänger, die die Push-Nachricht empfangen sollen

countSent

Anzahl der bereits verschickten Push-Nachrichten

countError

Anzahl der fehlerhafte Zustellversuche

error

Fehlertext (wenn Versand durch Fehler abgebrochen wurde)

400

Der übergebene Content ist fehlerhaft

404

Kein Eintrag mit der angegebenen ID gefunden