priceAPI

Mit dem priceAPI Add-Onopen in new window von Synesty haben Sie die Möglichkeit, Artikel aus jedem beliebigen System an priceAPI zu übertragen. PriceAPI sammelt die Angebote der Artikel von der ausgewählten Datenquelle, wie z. B. Google Shopping DE. Die zurück gelieferten Preisinformationen können unter anderem zum Erstellen eines eigenen Repricing Szenarios oder zur Mitbewerberbeobachtung genutzt werden.

API Zugriff einrichten

Um priceAPI über Synesty nutzen zu können, muss im priceAPI Dashboard der API Key kopiert werden.

Verbindungsdaten im Synesty Studio hinterlegen

Im Synesty Studio hinterlegen Sie den API Key in der Account Konfiguration. Diese erreichen Sie in der linken Sidebar unter: Meine Verbindungen -> priceAPI. Der Accountname ist frei wählbar und wird dann zur Auswahl im jeweiligen priceAPI Step angezeigt.

PriceAPI Steps

priceAPIrequestProductAndOffersAmazon

Der Step priceAPIrequestProductAndOffersAmazonopen in new window startet, mit den angegebenen Artikel Keys (GTIN oder ASIN), einen neuen Job bei priceAPI, um Angebote bei Amazon zu sammeln. Die maximale Anzahl an Artikel Keys pro Job ist auf 1000 begrenzt. Wenn Sie mehr als 1000 Keys abfragen, werden mehrere Jobs generiert (Anzahl der Jobs entspricht der Anzahl der Schlüssel dividiert durch 1000).

Der Status des Jobs kann mit dem Step priceAPIgetJobStatus geprüft werden.

Nach Abschluss des Jobs können die Ergebnisse mit dem Step priceAPIdownloadJobResults heruntergeladen werden.

Step Konfiguration

Account

Hier muss der erstellte Account gewählt werden.

input

Hier muss ein Spreadsheet mit den Artikel Keys verknüpft werden.

mappingdefinition

Hier muss die Quellspalte mit den Artikel Keys in der Spalte "key" gemappt werden.

source

Hier muss der Amazon Marktplatz gewählt werden, von welchem die Angebote abgerufen werden sollen:

  • amazon.de (Standardwert)
  • amazon.gb
  • amazon.fr
  • amazon.es
  • amazon.it
  • amazon.us
  • amazon.ca
  • amazon.mx
  • amazon.au
  • amazon.in
key:

Hier muss gewählt werden, welcher Artikel Key verwendet wird:

  • ASIN (Standardwert)
  • GTIN
max_age:

Hier wird ausgewählt, wie aktuell die abzurufenden Angebote sein sollen.

  • default (Standardwert) -> 20 Stunden
  • realtime-credits are doubled
limit

Hier können die zu verarbeitenden Zeilen des Input Spreadsheets limitiert werden.

priceAPIrequestProductAndOffersByGTIN

Dieser Step ist veraltet und wurde durch den priceAPIrequestProductAndOffersByKey ersetzt.

priceAPIrequestProductAndOffersByKey

Der Step priceAPIrequestProductAndOffersByKeyopen in new window startet, mit den angegebenen Artikel Keys (ID, TERM oder GTIN), einen neuen Job bei priceAPI, um Angebote bei Idealo oder Google Shopping zu sammeln. Die maximale Anzahl an Artikel Keys pro Job ist auf 1000 begrenzt. Wenn Sie mehr als 1000 Keys abfragen, werden mehrere Jobs generiert (Anzahl der Jobs entspricht der Anzahl der Schlüssel dividiert durch 1000).

Der Status des Jobs kann mit dem Step priceAPIgetJobStatus geprüft werden. Nach Abschluss des Jobs können die Ergebnisse mit dem Step priceAPIdownloadJobResults heruntergeladen werden.

Step Konfiguration

Account:

Hier muss der erstellte Account gewählt werden.

input:

Hier muss ein Spreadsheet mit den Artikel Keys verknüpft werden.

mappingdefinition:

Hier muss die Quellspalte mit den Artikel Keys in der Spalte "key" gemappt werden.

key:

Hier muss gewählt werden, welcher Artikel Key verwendet wird:

  • GTIN
  • ID (Standardwert)
  • Term

Welche ID oder welcher Term verwendet werden muss, ist abhängig vom jeweiligen System.

Bei Google Shopping handelt es sich um die ID, welche auch in der URL zu finden ist:

Der Term ist bei Google Shopping der Name des Produktes:

Siehe PriceAPI Dokumentation: https://readme.priceapi.com/reference/sourcesopen in new window

limit

Hier können die zu verarbeitenden Zeilen des Input Spreadsheets limitiert werden.

source:

Hier muss das System gewählt werden, von welchem die Angebote abgerufen werden sollen:

  • idealo.de
  • idealo.at
  • idealo.gb
  • idealo.fr
  • idealo.it
  • idealo.es
  • GoogleShopping.de
  • GoogleShopping.at
  • GoogleShopping.gb
  • GoogleShopping.fr
  • GoogleShopping.nl
  • GoogleShopping.ch
  • GoogleShopping.it
  • GoogleShopping.pl
  • GoogleShopping.ru
  • GoogleShopping.es
  • GoogleShopping.se
  • GoogleShopping.au
  • GoogleShopping.ca
  • GoogleShopping.us
  • GoogleShopping.cz
  • GoogleShopping.dk
  • priceAPI Testsystem (Standardwert)
max_age:

Hier wird ausgewählt, wie aktuell die abzurufenden Angebote sein sollen.

  • default (Standardwert) -> 20 Stunden
  • realtime-credits are doubled
webhook_url

In dem Feld webhook_url kann eine URL an PriceAPI mitgegeben werden. Nach dem Beenden des PriceAPI Jobs wird eine Response im JSON-Format als Post-Request an diese URL gesendet:

{
  "payload": {
    "product": "priceapi",
    "topic": "job",
    "event": "finished",
    "user_id": "abcdef12345678eabc",
    "job_id": "bca32114a25cde",
    "version": "v2",
    "job_download_url": "https://example.com/results/12345.json"
  },
  "meta": {
    "system": "priceapi-api",
    "sent_at": 1697108049
  }
}

Das ermöglicht es, nach Beendigung eines PriceAPI Jobs einen Synesty Flow via URL zu triggern. Dabei kann der Inhalt der JSON-Response (z. B. die job_id) als Variable an den Flow übergeben und eingelesen werden, um mit dem Step priceAPIdownloadJobResults die Ergebnisse des Jobs herunterzuladen.

Dafür muss zunächst die Variable priceAPIResponse erstellt werden.

Nun wird der URL-Trigger konfiguriert:

  • Response-Mode: JSON
  • Request Mapping:
  • Variable wählen: priceAPIResponse
  • Parameter Typ: body

Damit wird der von PriceAPI übertragene JSON-Body in die Variable "priceAPIResponse" eingelesen.

Die Variable kann dann als input für den Step StringToFile verwendet werden, um den übermittelten JSON String in eine JSON-Datei umzuwandeln.

Mit dem JSONReader oder dem JSONReaderVisual Step wird die job_id aus der JSON geparst.

Der Step priceAPIdownloadJobResults nutzt dann die geparste job_id, um die Ergebnisse der Preisabfrage herunterzuladen. Ggf. muss das Mapping des Steps angepasst werden.

priceAPIgetJobStatus

Mit dem Step priceAPIgetJobStatusopen in new window kann der Status des PriceAPI Jobs abgerufen werden. Beispielsweise kann damit vor dem Download des Job Ergebnisses geprüft werden, ob der Job schon beendet ist. Falls nicht könnte der Flow an dieser Stelle mit einem StopFlowIf abgebrochen werden.

priceAPIdownloadJobResults

Der Step priceAPIdownloadJobResultsopen in new window lädt das Ergebnis eines fertig gestellten PriceAPI Jobs herunter.