PlentyGetConversations - PlentyONE
Version: REST 1.0
Ruft eine Liste der Konversationen (Nachrichten) aus PlentyONE Shop ab.
Inputs
Das sind die Optionen, mit denen man den Step konfigurieren kann.
| Name | Datentyp | Beschreibung | Pflichtfeld | Werte |
|---|---|---|---|---|
| account | ACCOUNT | Ihr Konto | Ja | |
| limit | STRING | Begrenzen Sie die Anzahl der abgerufenen Konversationen. | Nein | |
| enableMessages | BOOLEAN | Wenn diese Option aktiviert ist, werden die Konversationsnachrichten einbezogen. | Nein |
|
| fromDate | DATETIME | Ergebnisse nach Erstellungsdatum der Konversation filtern. Die Konversation muss nach diesem Datum erstellt worden sein. | Nein | |
| toDate | DATETIME | Ergebnisse nach Erstellungsdatum der Konversation filtern. Die Konversation muss vor diesem Datum erstellt worden sein. | Nein | |
| updateFromDate | STRING | Ergebnisse nach Aktualisierungsdatum der Konversation filtern. Die Konversation muss nach diesem Datum aktualisiert worden sein. | Nein | |
| updateToDate | STRING | Ergebnisse nach Aktualisierungsdatum der Konversation filtern. Die Konversation muss vor diesem Datum aktualisiert worden sein. | Nein | |
| tagIds | STRING | Ergebnisse nach Konversations-Tags filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. | Nein | |
| shortId | STRING | Ergebnisse nach "Kurze ID" der Konversation filtern. | Nein | |
| orderIds | STRING | Ergebnisse nach Reihenfolge der Konversationsbeziehung filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. | Nein | |
| contactIds | STRING | Filtert die Ergebnisse nach dem Konversationstyp "Kontakt". Es können mehrere Werte durch Kommas getrennt angegeben werden. | Nein | |
| emails | STRING | Ergebnisse nach E-Mail-Typ der Konversation filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. | Nein | |
| paymentIds | STRING | Ergebnisse nach Konversationsbeziehungstyp "Zahlung" filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. | Nein | |
| subscribersUsers | STRING | Ergebnisse nach Konversationsabonnenten filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. | Nein | |
| isDone | STRING | Ergebnisse nach Konversationsstatus filtern. | Nein |
|
| hasAttachments | STRING | Ergebnisse nach Konversationen filtern, die mindestens eine Nachricht mit einem Anhang enthalten. | Nein |
|
| hasBilledMsg | STRING | Ergebnisse nach Konversationen filtern, die mindestens eine in Rechnung gestellte Nachricht enthalten. | Nein |
|
| isArchived | STRING | Ergebnisse aus dem Hauptindex oder aus dem Archiv filtern. | Nein |
|
| referrer | STRING | Ergebnisse nach Konversations-Herkunft filtern (Herkunft der ersten Nachricht der Konversation). | Nein |
|
| fromValue | STRING | Ergebnisse nach Absender der Konversation filtern (Absender der ersten Nachricht). Der gesuchte Wert kann eine Benutzer-ID oder eine E-Mail-Adresse sein. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. Dieser Filter funktioniert nur, wenn auch der Filter "fromType" angegeben ist. | Nein | |
| fromType | STRING | Ergebnisse nach Absendertyp der Konversation filtern (Absendertyp der ersten Nachricht der Konversation). | Nein |
|
| priorityId | STRING | Ergebnisse nach Konversationspriorität filtern. | Nein |
|
| inboxId | STRING | Ergebnisse nach Posteingangs-ID filtern. | Nein | |
| deadline | STRING | Filtert die Ergebnisse nach dem Deadline der Konversation. | Nein |
|
| statusId | STRING | Ergebnisse nach Konversationsstatus-ID filtern. | Nein | |
| typeId | STRING | Ergebnisse nach Konversationstyp-ID filtern. | Nein | |
| isDeleted | STRING | Ergebnisse nach dem Flag "Konversation gelöscht" filtern. | Nein |
|
| deletedAtBefore | STRING | Ergebnisse nach dem Löschdatum der Konversation filtern. Die Konversation muss vor diesem Datum gelöscht worden sein. | Nein | |
| isRead | STRING | Ergebnisse nach Status "Konversation gelesen" filtern. Dieser Filter wirkt nur in Kombination mit dem Filter "readById". | Nein |
|
| readById | STRING | Filtern Sie die Ergebnisse nach dem Lesestatus der Konversation für die angegebene Benutzer-ID. Dieser Filter wirkt nur in Kombination mit dem Filter "isRead". | Nein | |
| uuids | STRING | Ergebnisse nach Konversations-IDs filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. | Nein | |
| folderId | STRING | Ergebnisse nach Ordner-ID filtern. | Nein | |
| owners | STRING | Ergebnisse nach Konversationsinhabern filtern. Es können mehrere Werte angegeben werden, die durch Kommas getrennt sind. | Nein | |
| title | STRING | Ergebnisse nach Konversationstitel filtern (die gesuchte Zeichenfolge muss im Titel enthalten sein). | Nein | |
| message | STRING | Ergebnisse nach Nachrichtentext filtern (die gesuchte Zeichenfolge muss in einer der Konversationsnachrichten enthalten sein). | Nein | |
| sortBy | STRING | Die Sortierspalte. | Nein |
|
| sortOrder | STRING | Die Sortierrichtung. | Nein |
|
Outputs
Das sind die Ergebnisse des Steps, die von nachfolgenden Steps, nach der Ausführung verwendet werden können.
| Name | Datentyp | Beschreibung | Werte | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| result | SPREADSHEET | Das Ergebnis - SPREADSHEET, das die Konversationsdaten enthält. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Folgende Felder sind im Output enthalten:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||