Ressourcen · API und Bestellungen

Leads im JSONLead-Format: Spezifikation

JSONLead-Spezifikation für Leads: Felder und Zustellmethoden per E-Mail, Webhook oder SFTP.

Den Verkaufsablauf zu automatisieren und mit Ihrem Warenwirtschaftssystem oder ERP zu verbinden war noch nie so einfach. Mit unserem System wird jeder Lead, der im Portal generiert wird, strukturiert gesendet, sodass Sie ihn ohne Komplikationen automatisch verarbeiten können. Hier erklären wir Ihnen, wie das funktioniert und wie Sie diese Integration umsetzen können.

Sendeformat: JSONLead als Marktstandard

Um Kompatibilität und einfache Integration zu gewährleisten, verwenden wir das JSONLead-Format. Dieses Format ist auf dem Markt weithin anerkannt und erleichtert die automatische Verarbeitung der Verkäufe in Drittsystemen.

Verfügbare Sendemethoden

Sie haben drei Möglichkeiten, die Leads zu empfangen. In jedem Fall ist der Inhalt des Leads im JSON-Format derselbe.

  • Webhook: Die schnellste und direkteste Option. Die Leads werden sofort an die zum Empfang konfigurierte URL Ihres Systems gesendet (POST-Anfrage). Wenn Sie aus Sicherheitsgründen einen benutzerdefinierten Header benötigen, können wir ihn problemlos hinzufügen.
  • SFTP/FTP: Sie können unseren SFTP-Server oder einen eigenen (SFTP/FTP) nutzen, um die Daten zu empfangen. Es wird eine JSON-Datei pro Lead erstellt.
  • E-Mail: Wenn Sie es vorziehen, können wir Ihnen die Leads im JSONLead-Format als Text in E-Mails senden.

Beispiel für einen gesendeten JSONLead

{
  "client": {
      "foreign_id": "1df807f0ba96f8be5529308f6667a144",
      "first_name": "John",
      "postal_code": "76119",
      "phone": "600000000",
      "email": "user@mail.com"
  },
  "sales_lead": {
      "origin": {
          "source": "portal_hero",
          "medium": "Ebay"
      },
      "related_urls": [
          "https://portal.com/item/1234"
      ],
      "custom": {
          "account": "some_email@mail.com",
          "external_id": "1243948",
          "title": "Some pretty product",
          "created_at": "2025-01-17 10:25:22.145432"
      },
      "foreign_id": "17-12583-30383",
      "inquiry": "[{\"created_at\": \"2022-10-31T20:03:21.360000\",\"text\": \"Te dejo mi numero de telefono 6XXXXXXXXX\"}, {\"created_at\":\"2022-10-31T19:50:55.194000\", \"text\": \"Hola!\"}]"
  },
  "version": "1.0.0"
}

Details der JSONLead-Felder

NameTypErforderlichBeschreibung
client.foreign_idstringJaEindeutige Kennung des Kunden.
client.first_namestringJaName des Kunden. Je nach Portal kann es ein Benutzername sein.
client.postal_codestringNeinPostleitzahl der Adresse des Kunden.
client.phonestringNeinTelefonnummer des Kunden.
client.emailstringNeinE-Mail des Kunden.
sales_lead.origin.sourcestringJaHerkunft des Verkaufs. Ist immer "portal_hero".
sales_lead.origin.mediumstringNeinName des Portals, von dem der Verkauf stammt.
sales_lead.related_urlsarrayNeinRelevante URL(s). Normalerweise die URL des Artikels im Portal.
sales_lead.custom.accountstringNeinE-Mail oder Kennung des Kontos im Portal. Nützlich, wenn mehrere Konten im selben Portal verwaltet werden, um das Herkunftskonto des Verkaufs zu identifizieren.
sales_lead.custom.external_idstring/arraystring*JaEindeutige Kennung des Artikels. Dieselbe, die Sie uns beim Hochladen der Artikel senden.
sales_lead.custom.titlestring/arraystring*JaTitel des verkauften Produkts.
sales_lead.custom.created_atdatetimeJaDatum und Uhrzeit der Erstellung des Verkaufs.
sales_lead.foreign_idstringJaEindeutige Kennung des Verkaufs.
sales_lead.inquiryarrayNeinMit dem Nutzer im Portal geführte Konversation.
versionstringJaVersion des JSONLead-Schemas. Derzeit Version 1.0.0.

Vorteile dieser Integration

  • Vollständige Automatisierung: Verarbeitet die Leads automatisch in Ihrem Warenwirtschaftssystem.
  • Standardisierung: Das JSONLead-Format gewährleistet Kompatibilität mit den meisten Systemen auf dem Markt.
  • Flexibilität: Wählen Sie zwischen Webhook, SFTP oder E-Mail, je nachdem, was Ihren Bedürfnissen am besten entspricht.

Integrieren Sie diese Lösung in Ihren Arbeitsablauf und optimieren Sie die Verwaltung Ihrer Leads mit Geschwindigkeit, Präzision und Leichtigkeit. Wenn Sie weitere Details oder technischen Support benötigen, kontaktieren Sie uns! 🚀