Page Comparison

newsType

numberNachrichtentyp

(Pflichtfeld zum Anlegen eines Eintrags, kann nachträglich nicht geändert werdenMessage type (mandatory field for creating an entry, cannot be changed later)

0 = Push -Nachrichtmessage

1 = News

2 = Teaser

0

JaYes

title

string

Überschrift Headline (max. 64 Zeichencharacters)

""

Ja Yes (außer Teaserexcept teaser)

text

string

Nachrichtentext, der im Message text to be displayed in the "News" -Reiter angezeigt werden solltab. (max. 160 Zeichencharacters)

""

Ja Yes (außer Teaserexcept teaser)

urlType

string

Art der angegebenen Type of URL specified

"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 angemeldetThe specified URL is called within the app. Due to the authentication token sent along, the user (if logged into the app) is directly logged into the store

"internal" =  Die angegebene URL wird innerhalb der App aufgerufen. In Gegensatz zu The specified URL is called within the app. In contrast to "internal-login" ist der User nicht automatisch im Shop angemeldet, the user is not automatically logged into the store.

"external" = Die angegebene URL wird in einem separaten Browser aufgerufen (vorzugsweise für externe URLs geeignetThe specified URL is called up in a separate browser (preferably suitable for external URLs).

""

NeinNo

url

string

URL , die bei Klick geöffnet werden soll to be opened on click (max. 160 Zeichencharacters)

""Ja

Yes, wenn if "urlType" angegeben wurdeis specified

image_url

string

relativer Pfad zum Teaserbild (relativ ab benutzerrelative path to teaser image (relative from user/appdata/bilderimages )

""Ja

, wenn Nachricht vom Typ Teaser istYes, if message is of type teaser

validFrom

number

Timestamp , ab dem die Nachricht angezeigt werden sollfrom which message should be displayed

0

JaYes

validUntil

number

Timestamp , bis zu dem die Nachricht angezeigt werden sollup to which the message should be displayed

0

JaYes

active

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

Switch so that the message is actively distributed to devices. Sending push messages must also be triggered by a separate endpoint.

false

Ja

Yes

400

Faulty content. Exact reason for the error within the response body

title

string

ÜberschriftHeadline

""

Ja Yes (außer Teaserexcept teaser)

text

string

Nachrichtentext, der im News text to be displayed in the "News" -Reiter angezeigt werden solltab

""

Ja Yes (außer Teaserexcept teaser)

urlType

string

Art der angegebenen Type of the specified 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 angemeldetThe specified URL is called within the app. The authentication token sent with the URL means that the user (if logged in to the app) is logged in directly to the store

"internal" =  Die angegebene URL wird innerhalb der App aufgerufen. In Gegensatz zu The specified URL is called up within the app. In contrast to "internal-login" ist der User nicht automatisch im Shop angemeldet, the user is not automatically logged into the store.

"external" = Die angegebene URL wird in einem separaten Browser aufgerufen (vorzugsweise für externe URLs geeignetThe specified URL is called up in a separate browser (preferably suitable for external URLs).

""

NeinNo

url

string

URL , die bei Klick geöffnet werden sollto be opened on click

""

JaYes, wenn if urlType angegeben wurdeis specified

image_url

string

relativer Pfad zum Teaserbild (relativ ab benutzerrelative path to teaser image (relative from user/appdata/bilderimages )

""Ja

, wenn Nachricht vom Typ Teaser istYes, if message is of type teaser

validFrom

number

Timestamp , ab dem die Nachricht angezeigt werden sollfrom which message should be displayed

0

JaYes

validUntil

number

Timestamp , bis zu dem die Nachricht angezeigt werden sollup to which the message should be displayed

0

JaYes

active

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

Switch so that the message is actively distributed to devices. Sending push messages must also be triggered by a separate endpoint.

false

Ja

Yes

400

Faulty content. Exact reason for the error within the response body

404

The entry with the specified ID does not exist.

404

The entry with the given ID does not exist.

406

The specified entry is not of type 'Push message', is not yet active or has already been sent.

name

stringInterne Bezeichnung der Push-Nachricht zur Identifikation in der Versandliste

Internal name of the push message for identification in the dispatch list

""

JaYes

message

objectObjekt mit allen Informationen der Nachrichten

Object with all message information

{}

JaYes

message.title

string

ÜberschriftTitle* (max. 64 Zeichencharacters)

""

JaYes

message.text

string

Nachrichtentext, der im Message text to be displayed in the "News" -Reiter angezeigt werden solltab* (max. 160 Zeichencharacters)

""

JaYes

message.urlType

string

Art der angegebenen Type of URL specified

"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 angemeldetThe specified URL is accessed within the app. The authentication token sent with the message means that the user (if logged into the app) is logged into the store directly

"internal" =  Die angegebene URL wird innerhalb der App aufgerufen. In Gegensatz zu The specified URL is called up within the app. In contrast to "internal-login" ist der User nicht automatisch im Shop angemeldet, the user is not automatically logged into the store.

"external" = Die angegebene URL wird in einem separaten Browser aufgerufen (vorzugsweise für externe URLs geeignetThe specified URL is called up in a separate browser (preferably suitable for external URLs).

""

NeinNo

message.url

string

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

If a personalized voucher is to be included, it can be appended to the URL using the ~VOUCHER-Number~ tag.

""

JaYes, wenn if urlType angegeben wurdeis specified

message.voucher

stringChargen-ID einer im Gutscheingenerator hinterlegten Gutschein-Charge

Batch ID of a voucher batch stored in the voucher generator

""

NeinNo

message.validUntil

numberAnzahl

Tage, die die Nachricht auf den Geräten im News-Bereich angezeigt werden soll. (zw. 1 und Number of days the message should be displayed on the devices in the news section. (between 1 and 31)

1

JaYes

filter

objectFilterkriterien für die Auswahl der Empfänger

Filter criteria for selecting recipients

{}

NeinNo

filter.connected

bool

Filterkriterium, ob eine Push-Nachricht nur an verbundene Geräte Filter criterion whether to send a push message only to connected devices (true), nur an nicht verbundene Geräte only to unconnected devices (false) oder an alle Geräte (Filter nicht gesetzt) verschickt werden soll, or to all devices (filter not set).

not set

NeinNo

filter.os_type

string

Filterung auf ein spezifisches BetriebssystemFilter on a specific operating system.

"ios" = iOS -Gerätedevices

"android" = Android -Gerätedevices

not set

NeinNo

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

List of email addresses to be considered as recipients.

The filter can be selected only if you want to send only to connected devices.

not set

NeinNo

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

Filter on postal code. Recipients must have one of the zip codes specified in the array in their billing address.

The filter can only be selected when sending to connected devices only.

not set

NeinNo

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

List of zip code areas where a recipient is located. This is only possible for recipients that have a purely numeric zip code in

of the billing address.

The filter can only be selected when sending only to connected devices.

not set

NeinNo

filter.zip_area[n].from

numberBeginn des zu filternden Postleitzahlenbereichs

Start of the zip code area to be filtered

not set

NeinNo

filter.zip_area[n].to

numberEnde des zu filternden Postleitzahlenbereichs

End of the zip code area to filter

not set

Nein

No

~A-FirstName~

VornameFirst name

~A-LastName~

NachnameLastName

~A-Street1~

StraßeStreet

~A-Street2~

StraßenzusatzStreet suffix

~A-Title~

TitelTitle

~A-Salutation~

AnredeSalutation

~A-City~City

StadtCity

~A-Zip~

PostleitzahlPostal code

~A-CompleteSalutation~

Begrüßung (durch Shop generiertSalutation (generated by store)

~VOUCHER-Number~

Personalisierte Gutscheinnummer (sofern eine Chargen-ID angegeben wurde)

Personalized voucher number (if a batch ID was specified)

400

The passed content is faulty.

id

ID of the push message

status

Status of the dispatch

Possible values:

0 = Start

1 = Initialization of dispatch

2 = Active dispatch

3 = Finished

4 = Canceled manually

5 = Canceled by error

subshop

Subshop for which the message was created

type

Type of push message:

0 = Push message via OSB service

1 = Push message via REST API

2 = Shipping confirmation message

3 = Reminder for abandoned carts

4 = Birthday greetings

name

Internal name of the push message for identification in the shipping list

createTime

Timestamp when the push message was created

updateTime

Timestamp when the entry was last updated

validUntil

Number of days the message should be displayed on the devices in the news section

title

Message title

text

Message text

urlType

Type of the specified URL

url

URL to be opened on click

voucher

Specified batch ID of the voucher to be personalized

countReceiver

Total number of recipients who should receive the push message

countSent

Number of push messages already sent

countError

Number of failed delivery attempts

error

Error text (if sending was aborted by error)

400

The passed content is faulty

404

No entry found with the specified ID