Recursos · API i comandes

Vendes en format JSONLead: especificació

Especificació JSONLead de vendes: camps, tres mètodes d'entrega i taula de referència completa.

Aquest format segueix en ús per a les integracions existents. Per a integracions noves, el format recomanat és l'esquema versionat ph.order/1.2.

Automatitzar el flux de vendes i connectar-lo amb el teu sistema de gestió o ERP mai no ha estat tan fàcil. Amb el nostre sistema, cada venda que es fa al portal s'envia de manera estructurada perquè la puguis processar automàticament sense complicacions. Aquí t'expliquem com funciona i com pots implementar aquesta integració.

Format d'enviament: JSONLead com a estàndard de mercat

Per garantir compatibilitat i facilitat d'integració, fem servir el format JSONLead. Aquest format és àmpliament reconegut al mercat i facilita el processament automàtic de les vendes en sistemes de tercers.

Mètodes d'enviament disponibles

Tens tres opcions per rebre les vendes. En qualsevol cas el contingut de la venda en format json serà el mateix.

  • Webhook: L'opció més ràpida i directa. Les vendes s'envien immediatament a la URL del teu sistema configurada per rebre-les (petició POST). Si per qüestions de seguretat necessites qualsevol tipus de capçalera personalitzada la podem afegir sense problema.
  • SFTP/FTP: Pots utilitzar el nostre servidor SFTP o un de propi (SFTP/FTP) per rebre les dades. Es crearà un arxiu json per cada venda.
  • Email: Si ho prefereixes, podem enviar-te les vendes en format JSONLead com a cos en correus electrònics.

Exemple de JSONLead enviat

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

* En el cas de portals que permeten múltiples articles a la mateixa comanda els elements del JSON: "sales_lead.custom.external_id", "sales_lead.custom.amount" and "sales_lead.custom.title" serà una llista en comptes d'un sol element. L'ordre de les llistes es respectarà entre elles.

Detalls dels camps del JSONLead

NomTipusObligatoriDescripció
client.foreign_idstringSíIdentificador únic del client.
client.first_namestringSíNom del client. En funció del portal pot ser un nom d'usuari.
client.provincestringNoProvíncia de l'adreça del client.
client.postal_codestringNoCodi postal de l'adreça del client.
client.phonestringNoNúmero de telèfon del client.
client.emailstringNoEmail del client.
client.custom.addressstringNoAdreça postal del client.
client.custom.citystringNoCiutat de l'adreça del client.
client.custom.countrystringNoPaís (codi ISO del país) de l'adreça del client.
sales_lead.origin.sourcestringSíOrigen de la venda. Sempre serà "portal_hero".
sales_lead.origin.mediumstringNoNom del portal d'on prové la venda.
sales_lead.related_urlsarrayNoUrl/s rellevants. Normalment la url de l'article al portal.
sales_lead.statusstringSíEstat de la venda. Actualment pot ser "confirmed" o "cancelled".
sales_lead.custom.accountstringNoEmail o identificador del compte al portal. Útil quan es gestionen múltiples comptes al mateix portal per poder identificar el compte d'origen de la venda.
sales_lead.custom.external_idstring/arraystring*SíIdentificador únic de l'article. El mateix que ens envieu en la pujada d'articles.
sales_lead.custom.titlestring/arraystring*SíTítol del producte venut.
sales_lead.custom.created_atdatetimeSíData i hora de la creació de la venda.
sales_lead.custom.update_atdatetimeNoData i hora de l'última actualització de la venda.
sales_lead.custom.amountfloat/arrayfloat*SíImport total de la venda.
sales_lead.custom.shipping_amountfloatNoImport dels costos d'enviament.
sales_lead.custom.payment_methodstringNoMètode de pagament.
sales_lead.custom.shipping.delivery_purchase_confirmedbooleanSíBooleà que indica si s'ha fet la venda. Sempre vindrà a true en aquest cas.
sales_lead.custom.shipping.delivery_purchase_confirmed_tsdatetimeNoObsolet: Moment de creació de la venda. Mateix valor que "sales_lead.custom.created_at"
sales_lead.custom.shipping.shipping_label_urlstringNoUrl de l'etiqueta d'enviament. Podrà ser un pdf o una imatge en funció de l'empresa de transport
sales_lead.custom.shipping.tracking_codestringNoNúmero de seguiment de la comanda a l'empresa de transport.
sales_lead.foreign_idstringSíIdentificador únic de la venda.
sales_lead.inquiryarrayNoConversa mantinguda amb l'usuari al portal.
versionstringSíVersió del schema de jsonLead. Versió 1.0.0 de moment.

* En el cas de portals que permeten múltiples articles a la mateixa comanda els elements del JSON: "sales_lead.custom.external_id", "sales_lead.custom.amount" and "sales_lead.custom.title" serà una llista en comptes d'un sol element. L'ordre de les llistes es respectarà entre elles.

Beneficis d'aquesta integració

  • Automatització Completa: Processa automàticament les vendes al teu sistema de gestió.
  • Estandardització: El format JSONLead assegura compatibilitat amb la majoria de sistemes del mercat.
  • Flexibilitat: Tria entre webhook, SFTP o email segons el que millor s'adapti a les teves necessitats.

Integra aquesta solució al teu flux de treball i optimitza la gestió de les teves vendes amb rapidesa, precisió i facilitat. Si necessites més detalls o suport tècnic, contacta amb nosaltres! 🚀