Risorse · API e ordini

Vendite in formato JSONLead: specifica

Specifica JSONLead delle vendite: campi, tre metodi di consegna e tabella di riferimento completa.

Questo formato resta in uso per le integrazioni esistenti. Per le nuove integrazioni, il formato consigliato è lo schema versionato ph.order/1.2.

Automatizzare il flusso di vendite e collegarlo con il tuo sistema di gestione o ERP non è mai stato così facile. Con il nostro sistema, ogni vendita che si realizza sul portale viene inviata in modo strutturato affinché tu possa elaborarla automaticamente senza complicazioni. Qui ti spieghiamo come funziona e come puoi implementare questa integrazione.

Formato di invio: JSONLead come standard di mercato

Per garantire compatibilità e facilità di integrazione, utilizziamo il formato JSONLead. Questo formato è ampiamente riconosciuto sul mercato e facilita l'elaborazione automatica delle vendite nei sistemi di terze parti.

Metodi di invio disponibili

Hai tre opzioni per ricevere le vendite. In ogni caso il contenuto della vendita in formato json sarà lo stesso.

  • Webhook: L'opzione più rapida e diretta. Le vendite vengono inviate immediatamente all'URL del tuo sistema configurato per riceverle (richiesta POST). Se per motivi di sicurezza hai bisogno di qualsiasi tipo di header personalizzato, possiamo aggiungerlo senza problemi.
  • SFTP/FTP: Puoi utilizzare il nostro server SFTP o uno tuo (SFTP/FTP) per ricevere i dati. Verrà creato un file json per ogni vendita.
  • Email: Se preferisci, possiamo inviarti le vendite in formato JSONLead come corpo delle email.

Esempio di JSONLead inviato

{
  "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"
}

* Nel caso di portali che consentono più articoli nello stesso ordine, gli elementi del JSON: "sales_lead.custom.external_id", "sales_lead.custom.amount" e "sales_lead.custom.title" saranno una lista invece di un solo elemento. L'ordine delle liste verrà rispettato tra di esse.

Dettagli dei campi del JSONLead

NomeTipoObbligatorioDescrizione
client.foreign_idstringSìIdentificatore univoco del cliente.
client.first_namestringSìNome del cliente. A seconda del portale può essere un nome utente.
client.provincestringNoProvincia dell'indirizzo del cliente.
client.postal_codestringNoCodice postale dell'indirizzo del cliente.
client.phonestringNoNumero di telefono del cliente.
client.emailstringNoEmail del cliente.
client.custom.addressstringNoIndirizzo postale del cliente.
client.custom.citystringNoCittà dell'indirizzo del cliente.
client.custom.countrystringNoPaese (codice ISO del paese) dell'indirizzo del cliente.
sales_lead.origin.sourcestringSìOrigine della vendita. Sarà sempre "portal_hero".
sales_lead.origin.mediumstringNoNome del portale da cui proviene la vendita.
sales_lead.related_urlsarrayNoUrl rilevante/i. Normalmente l'url dell'articolo sul portale.
sales_lead.statusstringSìStato della vendita. Attualmente può essere "confirmed" o "cancelled".
sales_lead.custom.accountstringNoEmail o identificatore dell'account sul portale. Utile quando si gestiscono più account sullo stesso portale per poter identificare l'account di origine della vendita.
sales_lead.custom.external_idstring/arraystring*SìIdentificatore univoco dell'articolo. Lo stesso che ci inviate nel caricamento degli articoli.
sales_lead.custom.titlestring/arraystring*SìTitolo del prodotto venduto.
sales_lead.custom.created_atdatetimeSìData e ora della creazione della vendita.
sales_lead.custom.update_atdatetimeNoData e ora dell'ultimo aggiornamento della vendita.
sales_lead.custom.amountfloat/arrayfloat*SìImporto totale della vendita.
sales_lead.custom.shipping_amountfloatNoImporto dei costi di spedizione.
sales_lead.custom.payment_methodstringNoMetodo di pagamento.
sales_lead.custom.shipping.delivery_purchase_confirmedbooleanSìBooleano che indica se la vendita è stata effettuata. In questo caso arriverà sempre a true.
sales_lead.custom.shipping.delivery_purchase_confirmed_tsdatetimeNoObsoleto: Momento di creazione della vendita. Stesso valore di "sales_lead.custom.created_at"
sales_lead.custom.shipping.shipping_label_urlstringNoUrl dell'etichetta di spedizione. Potrà essere un pdf o un'immagine a seconda del corriere
sales_lead.custom.shipping.tracking_codestringNoNumero di tracciamento dell'ordine presso il corriere.
sales_lead.foreign_idstringSìIdentificatore univoco della vendita.
sales_lead.inquiryarrayNoConversazione avuta con l'utente sul portale.
versionstringSìVersione dello schema di jsonLead. Versione 1.0.0 per il momento.

* Nel caso di portali che consentono più articoli nello stesso ordine, gli elementi del JSON: "sales_lead.custom.external_id", "sales_lead.custom.amount" e "sales_lead.custom.title" saranno una lista invece di un solo elemento. L'ordine delle liste verrà rispettato tra di esse.

Vantaggi di questa integrazione

  • Automazione completa: Elabora automaticamente le vendite nel tuo sistema di gestione.
  • Standardizzazione: Il formato JSONLead assicura compatibilità con la maggior parte dei sistemi del mercato.
  • Flessibilità: Scegli tra webhook, SFTP o email a seconda di ciò che meglio si adatta alle tue esigenze.

Integra questa soluzione nel tuo flusso di lavoro e ottimizza la gestione delle tue vendite con rapidità, precisione e facilità. Se hai bisogno di maggiori dettagli o supporto tecnico, contattaci! 🚀