Verkäufe im JSONLead-Format: Spezifikation

JSONLead-Spezifikation für Verkäufe: Felder, drei Zustellmethoden und vollständige Referenztabelle.

Dieses Format ist weiterhin für bestehende Integrationen in Gebrauch. Für neue Integrationen ist das empfohlene Format das versionierte Schema ph.order/1.2.

Den Verkaufsablauf zu automatisieren und mit Ihrem Warenwirtschaftssystem oder ERP zu verbinden war noch nie so einfach. Mit unserem System wird jeder Verkauf, der im Portal getätigt 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 Verkäufe zu empfangen. In jedem Fall ist der Inhalt des Verkaufs im JSON-Format derselbe.

Webhook: Die schnellste und direkteste Option. Die Verkäufe 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 Verkauf erstellt.
E-Mail: Wenn Sie es vorziehen, können wir Ihnen die Verkäufe im JSONLead-Format als Text in E-Mails senden.

Beispiel für einen gesendeten JSONLead

{
  "client": {
      "foreign_id": "1df807f0ba96f8be5529308f6667a144",
      "first_name": "John",
      "province": "Haute-Normandie",
      "postal_code": "76119",
      "phone": "600000000",
      "email": "user@mail.com",
      "custom": {
          "address": "4534 route de la mar",
          "city": "76119 - STE MARGUERITE SUR MER",
          "country": "FR"
      }
  },
  "sales_lead": {
      "origin": {
          "source": "portal_hero",
          "medium": "Ebay"
      },
      "related_urls": [
          "https://portal.com/item/1234"
      ],
      "status": "confirmed",
      "custom": {
          "account": "some_email@mail.com",
          "external_id": "1243948",
          "title": "Some pretty product",
          "created_at": "2025-01-17 10:25:22.145432",
          "update_at": "2025-01-17 18:21:11.145432",
          "amount": 1400.0,
          "shipping_amount": 0.0,
          "payment_method": "EBAY",
          "shipping": {
              "delivery_purchase_confirmed": true,
              "delivery_purchase_confirmed_ts": "2025-01-17 10:25:22.145432",
              "shipping_label_url": "https://portal-xxxx.com/tracking.pdf",
              "tracking_code": "XXXXXXXX"
          }
      },
      "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"
}

* Bei Portalen, die mehrere Artikel in derselben Bestellung zulassen, sind die JSON-Elemente "sales_lead.custom.external_id", "sales_lead.custom.amount" und "sales_lead.custom.title" eine Liste anstelle eines einzelnen Elements. Die Reihenfolge der Listen wird untereinander eingehalten.

Details der JSONLead-Felder

Name	Typ	Erforderlich	Beschreibung
`client.foreign_id`	string	Ja	Eindeutige Kennung des Kunden.
`client.first_name`	string	Ja	Name des Kunden. Je nach Portal kann es ein Benutzername sein.
`client.province`	string	Nein	Provinz der Adresse des Kunden.
`client.postal_code`	string	Nein	Postleitzahl der Adresse des Kunden.
`client.phone`	string	Nein	Telefonnummer des Kunden.
`client.email`	string	Nein	E-Mail des Kunden.
`client.custom.address`	string	Nein	Postanschrift des Kunden.
`client.custom.city`	string	Nein	Stadt der Adresse des Kunden.
`client.custom.country`	string	Nein	Land (ISO-Ländercode) der Adresse des Kunden.
`sales_lead.origin.source`	string	Ja	Herkunft des Verkaufs. Ist immer "portal_hero".
`sales_lead.origin.medium`	string	Nein	Name des Portals, von dem der Verkauf stammt.
`sales_lead.related_urls`	array	Nein	Relevante URL(s). Normalerweise die URL des Artikels im Portal.
`sales_lead.status`	string	Ja	Status des Verkaufs. Derzeit kann er "confirmed" oder "cancelled" sein.
`sales_lead.custom.account`	string	Nein	E-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_id`	string/arraystring*	Ja	Eindeutige Kennung des Artikels. Dieselbe, die Sie uns beim Hochladen der Artikel senden.
`sales_lead.custom.title`	string/arraystring*	Ja	Titel des verkauften Produkts.
`sales_lead.custom.created_at`	datetime	Ja	Datum und Uhrzeit der Erstellung des Verkaufs.
`sales_lead.custom.update_at`	datetime	Nein	Datum und Uhrzeit der letzten Aktualisierung des Verkaufs.
`sales_lead.custom.amount`	float/arrayfloat*	Ja	Gesamtbetrag des Verkaufs.
`sales_lead.custom.shipping_amount`	float	Nein	Betrag der Versandkosten.
`sales_lead.custom.payment_method`	string	Nein	Zahlungsmethode.
`sales_lead.custom.shipping.delivery_purchase_confirmed`	boolean	Ja	Boolescher Wert, der angibt, ob der Verkauf getätigt wurde. Kommt in diesem Fall immer als true.
`sales_lead.custom.shipping.delivery_purchase_confirmed_ts`	datetime	Nein	Veraltet: Zeitpunkt der Erstellung des Verkaufs. Derselbe Wert wie "sales_lead.custom.created_at"
`sales_lead.custom.shipping.shipping_label_url`	string	Nein	URL des Versandetiketts. Kann je nach Transportunternehmen ein PDF oder ein Bild sein
`sales_lead.custom.shipping.tracking_code`	string	Nein	Sendungsverfolgungsnummer der Bestellung beim Transportunternehmen.
`sales_lead.foreign_id`	string	Ja	Eindeutige Kennung des Verkaufs.
`sales_lead.inquiry`	array	Nein	Mit dem Nutzer im Portal geführte Konversation.
`version`	string	Ja	Version des JSONLead-Schemas. Derzeit Version 1.0.0.

Vorteile dieser Integration

Vollständige Automatisierung: Verarbeitet die Verkäufe 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 Verkäufe mit Geschwindigkeit, Präzision und Leichtigkeit. Wenn Sie weitere Details oder technischen Support benötigen, kontaktieren Sie uns! 🚀