JSON EDI

Modern approaches to electronic data interchange using JSON, REST APIs, and web-native technologies

Overview

JSON EDI represents the latest evolution in electronic data interchange, leveraging JavaScript Object Notation (JSON) and modern web technologies to exchange business documents between organizations. Rather than a single standard, JSON EDI encompasses a variety of approaches: JSON representations of traditional EDI standards, purpose-built JSON APIs for B2B commerce, and emerging specifications that seek to standardize JSON-based business document exchange.

The shift toward JSON EDI is driven by the broader adoption of RESTful APIs, the prevalence of JSON in modern software development, and the desire for simpler, more developer-friendly integration methods. While traditional EDI standards like EDIFACT and X12 remain dominant in terms of transaction volume, JSON-based approaches are gaining ground, particularly among technology companies, e-commerce platforms, and organizations that want to reduce the complexity and cost of B2B integration.

History

JSON was first specified by Douglas Crockford in the early 2000s and became an ECMA standard (ECMA-404) in 2013 and an IETF standard (RFC 8259) in 2017. Its rise in B2B data interchange parallels the broader API economy that emerged in the 2010s, as companies like Stripe, Twilio, and Shopify demonstrated that complex business processes could be managed through well-designed REST APIs with JSON payloads.

Early JSON EDI efforts focused on creating JSON representations of existing X12 and EDIFACT documents, allowing organizations to work with familiar EDI semantics in a more accessible format. Companies like Stedi, Orderful, and other modern EDI platforms began offering JSON-native EDI services that abstract away the complexity of traditional EDI translation. The healthcare sector saw HL7 FHIR adopt JSON as a first-class representation alongside XML, demonstrating that even regulated industries could embrace JSON for data exchange.

Approaches to JSON EDI

JSON Representations of Traditional EDI

Many modern EDI platforms convert traditional X12 or EDIFACT documents into JSON format, making them easier to work with in modern programming environments. The structure mirrors the original EDI document but uses JSON objects, arrays, and key-value pairs instead of positional delimiters. 

{
  "transactionSet": "850",
  "version": "004010",
  "heading": {
    "BEG": {
      "purpose": "00",
      "type": "NE",
      "purchaseOrderNumber": "PO-2023-00451",
      "date": "2023-06-15"
    },
    "N1": [
      {
        "entityCode": "BY",
        "name": "Buyer Company",
        "idQualifier": "92",
        "id": "BUYER001"
      }
    ]
  },
  "detail": {
    "PO1": [
      {
        "lineNumber": "1",
        "quantity": 500,
        "unit": "EA",
        "unitPrice": 25.00,
        "productId": "WIDGET-A",
        "ean": "4000862141404"
      }
    ]
  }
}

API-first EDI

API-first EDI platforms provide RESTful endpoints where trading partners submit and retrieve business documents as JSON payloads. Instead of exchanging files through VANs (Value Added Networks) or AS2 connections, partners interact through standard HTTPS APIs with JSON request and response bodies. This approach dramatically simplifies integration for organizations that already have modern API infrastructure.

Webhook-based EDI

In the webhook model, trading partners register callback URLs to receive real-time notifications when new documents are available. When a purchase order is created, the buyer's system sends a JSON payload via HTTP POST to the supplier's webhook endpoint. This push-based model reduces latency compared to traditional EDI polling mechanisms and enables event-driven architectures.

GraphQL for B2B

Some organizations are exploring GraphQL as an alternative to REST for B2B data exchange. GraphQL's query language allows trading partners to request exactly the data they need, reducing over-fetching and enabling more flexible integrations. While not yet mainstream for EDI, GraphQL is gaining traction in supply chain visibility and catalog management scenarios.

Emerging Specifications

  • JSON Schema for EDI: JSON Schema provides structural validation for JSON documents, analogous to XML Schema (XSD) for XML-based EDI. Trading partners can publish JSON schemas defining the expected structure and data types of each business document.
  • OpenAPI for B2B: The OpenAPI Specification (formerly Swagger) can define B2B API contracts, including request/response schemas, authentication, and error handling.
  • AsyncAPI: For event-driven architectures, AsyncAPI defines message-driven APIs, which is relevant for webhook-based and message-queue-based EDI.
  • Peppol BIS with JSON: The Peppol network, which predominantly uses UBL XML, is exploring JSON representations to lower the barrier to entry for smaller businesses.

Use Cases

  • E-commerce integrations: Marketplaces like Amazon, Shopify, and eBay provide JSON APIs for order management, inventory updates, and fulfillment notifications
  • Dropshipping: JSON APIs connect retailers with dropship suppliers for real-time inventory checks, automated ordering, and shipment tracking
  • Fintech and payments: Modern payment platforms use JSON for invoice delivery, payment initiation, and reconciliation
  • Logistics and shipping: Carrier APIs (FedEx, UPS, DHL) use JSON for rate shopping, label generation, and shipment tracking
  • Healthcare (FHIR): HL7 FHIR uses JSON for clinical data exchange, representing a regulated industry's embrace of JSON EDI
  • Supply chain visibility: Real-time supply chain tracking platforms use JSON webhooks to propagate status updates across partner networks

Advantages

  • Developer-friendly: JSON is native to web development, requiring no specialized EDI knowledge or translation software
  • Lightweight: JSON documents are typically smaller than equivalent XML documents, reducing bandwidth and parsing overhead
  • Real-time capable: API and webhook approaches enable near-instantaneous document exchange, unlike batch-oriented traditional EDI
  • Low barrier to entry: Any organization with basic web development capabilities can implement JSON-based integrations
  • Flexible: JSON's dynamic structure makes it easier to extend documents with additional fields without breaking existing parsers
  • Rich ecosystem: JSON validators, schema generators, API testing tools, and integration platforms are widely available

Related Standards

JSON EDI does not replace traditional standards but increasingly complements them. Many organizations use modern EDI platforms that accept JSON inputs and translate them to X12 or EDIFACT for partners that require traditional formats. XML-based EDI standards like UBL serve as an intermediate step between traditional EDI and JSON approaches, and many XML EDI documents can be straightforwardly converted to JSON. In specialized domains, RosettaNet PIPs are being re-implemented as JSON APIs, and SWIFT is adopting JSON alongside ISO 20022 XML for financial messaging.