HeddleGridDocs
API Changelog Get started
Getting started

EDI, without the busywork.

HeddleGrid connects you to your retail trading partners over EDI and turns every incoming document into clean, structured data — and sends acknowledgments, ship notices and invoices back out automatically. No portals. No re-keying. No multi-week onboarding.

If you sell into major retailers, EDI is mandatory: your partners send you purchase orders and expect acknowledgments, advance ship notices and invoices in return, in exacting formats, on tight timelines. Traditionally that means a brittle integration, a per-partner setup project, and an inbox full of documents someone retypes by hand.

HeddleGrid replaces all of that. You connect a partner once, we map their format with AI in hours, and from then on orders arrive as clean data you can pull from an API, receive by webhook, or work in the dashboard — and everything you owe them flows back out on time.

Who HeddleGrid is for

  • Apparel and consumer-goods vendors shipping to major and mass-market retailers.
  • Operations teams drowning in manual order entry and chargeback surprises.
  • Developers who want EDI to behave like a modern API, not a 1985 file format.
Getting started

Core concepts

Five objects make up everything in HeddleGrid. Once these click, the rest of the product is obvious.

ConceptWhat it is
Trading partnerA retailer (or any counterparty) you exchange EDI with. Each partner has its own identifiers, document formats, and compliance rules.
ConnectionHow documents physically move to and from a partner — AS2, SFTP, or our API. One partner can have one connection per direction.
DocumentA single EDI message in or out — a purchase order, an acknowledgment, a ship notice, an invoice. Every document is stored with both its raw form and its parsed form.
MappingThe rules that translate a partner's specific format to and from HeddleGrid's canonical model. Generated by AI from the partner's spec, then approved by you. Versioned.
Canonical modelHeddleGrid's single, partner-agnostic shape for each business object — an Order, a ShipNotice, an Invoice. You build against this once and it works for every partner.
The big idea

You integrate with the canonical model once. HeddleGrid absorbs every partner's quirks behind it — so adding your tenth retailer doesn't mean a tenth integration.

Getting started

Quickstart

From zero to receiving live orders in four steps. Most partners are live within a few days — the gating factor is your partner's certification window, not HeddleGrid.

STEP 1

Add a trading partner

Create the partner and upload their EDI implementation guide plus a few sample files.

STEP 2

Review the mapping

HeddleGrid's AI drafts the full mapping and validation rules. You review the diff and approve.

STEP 3

Connect transport

Add AS2 or SFTP credentials (or just use the API). Run a test cycle with your partner.

STEP 4

Go live

Orders arrive as Order objects via webhook and API. Acks, ship notices and invoices flow back out.

Receive your first order by webhook

# A purchase order arrived and was mapped to a canonical Order.
# HeddleGrid POSTs this to your endpoint:
{
  "event": "order.created",
  "created": "2026-06-03T11:42:09Z",
  "data": {
    "id": "ord_8Q2vXk",
    "partner": "prt_northstar",
    "poNumber": "0521-447832",
    "purpose": "original",
    "poDate": "2026-06-03",
    "lineCount": 2
  }
}
Tip

No webhook endpoint yet? Skip step 3's API path and work orders directly in the dashboard. You can add programmatic access any time.

Connections

Trading partners

A trading partner represents one counterparty you exchange EDI with. Each carries the details that make its documents unique:

  • Interchange identifiers — the sender/receiver IDs and qualifiers that route documents to and from the partner.
  • Document profile — which document types this partner sends and expects (orders, acknowledgments, ship notices, invoices, inventory).
  • Mappings — one approved mapping per document type, versioned over time as the partner updates their spec.
  • Compliance rules — partner-specific requirements (timing windows, labeling, required fields) that HeddleGrid validates against before anything goes out.

Partners move through three states: draft (being configured), testing (running certification cycles), and live (in production). HeddleGrid keeps test and production traffic strictly separate so a certification run can never touch live orders.

Connections

Transport: AS2, SFTP & API

Transport is how documents physically move. HeddleGrid supports the three that matter, and you can mix them across partners.

MethodBest forWhat you provide
AS2Most large retailers — real-time, signed, encrypted, with delivery receipts (MDNs).Partner's AS2 URL + certificate. HeddleGrid hosts your AS2 endpoint and manages keys.
SFTPPartners or networks that exchange files on a schedule.SFTP host + credentials, or use a HeddleGrid-hosted inbox.
VANThe long tail of partners that require a value-added network.Nothing — HeddleGrid interconnects to the network on your behalf.
APIYour own systems. Push outbound documents and pull inbound data directly.An API key. See REST API.
You don't manage certificates

For AS2, HeddleGrid generates and rotates keys, hosts the endpoint, and handles MDNs and retries. You exchange a certificate with your partner once and we take it from there.

Connections

Onboarding a partner

This is where HeddleGrid is different. Traditional EDI onboarding is a multi-week professional-services project to hand-build a map for one partner's format. HeddleGrid does it with AI, with you in control.

  1. Upload the spec. Drop in the partner's EDI implementation guide (PDF) and any sample files. HeddleGrid reads every segment, qualifier, code list and loop.
  2. AI drafts the mapping. HeddleGrid generates a complete mapping to the canonical model, plus validation rules, with fixtures derived from your real samples.
  3. You review. Walk the proposed mapping field by field in a side-by-side view. Adjust anything; your corrections are remembered.
  4. Approve & version. Approving locks a version. When the partner changes their spec later, you upload the new guide and review only the diff.
  5. Test, then go live. Run certification cycles in testing; promote to live when your partner signs off.
Why it's fast

Mappings are reusable. Once a common retailer format is mapped, onboarding the next vendor on that same format is near-instant. The more partners on HeddleGrid, the faster everyone goes live.

Documents

Supported documents

HeddleGrid speaks the X12 documents that drive retail trade. Inbound documents become canonical objects; outbound objects become compliant EDI.

DocX12DirectionCanonical object
Purchase Order850inboundOrder
PO Change860inboundOrder (revision)
PO Acknowledgment855outboundAcknowledgment
Advance Ship Notice856outboundShipNotice
Invoice810outboundInvoice
Inventory Advice846outboundInventoryAdvice
Functional Ack997in / outhandled automatically

EDIFACT support (for partners outside North America) is on the roadmap; talk to us if you need it today.

Documents

Document lifecycle

Every document — in or out — moves through a predictable set of states you can watch in the dashboard or subscribe to via webhooks.

Inbound (e.g. a purchase order)

received ──▶ parsed ──▶ mapped ──▶ validated ──▶ delivered
                                  │
                                  └─▶ exception  # needs attention

Outbound (e.g. an invoice)

created ──▶ generated ──▶ sent ──▶ acknowledged
                              │
                              └─▶ rejected  # partner returned an error

A document is only acknowledged once the partner's functional acknowledgment (997) confirms acceptance. HeddleGrid tracks that round-trip for you and surfaces anything that doesn't come back.

Documents

Acknowledgments

EDI has two kinds of "ack," and HeddleGrid handles both so you never think about them:

  • Functional acknowledgment (997) — the technical receipt confirming a document was received and structurally valid. HeddleGrid sends these automatically for inbound documents and reconciles the ones you receive for outbound documents.
  • Business acknowledgment (855) — your commitment back to the partner on a purchase order: accepting, rejecting, or proposing changes to lines, quantities, prices and dates. You issue these from the dashboard or the API.
Control numbers, handled

Interchange and group control numbers, duplicate detection, and resends are managed by HeddleGrid. A document is never silently dropped or double-sent.

Documents

Validation & exceptions

Most retail penalties come from documents that are late or non-compliant, not missing. HeddleGrid validates every document against the partner's rules before it goes out, and flags inbound documents that don't fit the agreed format.

Validation runs at two levels:

  • Structural — envelope integrity, control-number balance, required segments and qualifiers.
  • Compliance — partner-specific business rules: required fields, value ranges, timing windows, and labeling expectations.

Anything that fails lands in the exception queue — a single worklist with a plain-language explanation of what's wrong and a guided fix. Resolve it there and the document continues on its way. Your ops team runs the daily EDI desk from this one screen, no engineer required.

Developers

Authentication

The HeddleGrid API uses bearer tokens. Create API keys in Settings → API keys. Keep secret keys server-side; never ship them in client code.

curl https://api.heddlegrid.com/v1/orders \
  -H "Authorization: Bearer sk_live_••••••••"

Keys are scoped to an environment. sk_test_… keys see only testing partners and traffic; sk_live_… keys see production. The base URL is the same for both — the key decides the environment.

Developers

REST API

A small, predictable REST API over the canonical model. JSON in, JSON out; cursor pagination; idempotency keys on every write.

Documents & orders

GET/v1/documentsList raw EDI documents, filterable by partner, type, status
GET/v1/documents/:idFetch one document — raw + parsed
GET/v1/ordersList canonical orders
GET/v1/orders/:idFetch one canonical order

Sending documents back

POST/v1/acknowledgmentsAcknowledge an order (accept / reject / change)
POST/v1/ship-noticesSend an advance ship notice
POST/v1/invoicesSend an invoice
POST/v1/inventory-advicesPublish inventory availability

Example — send a ship notice

curl -X POST https://api.heddlegrid.com/v1/ship-notices \
  -H "Authorization: Bearer sk_live_••••••••" \
  -H "Idempotency-Key: ship_0521-447832_a1" \
  -d '{
    "orderId": "ord_8Q2vXk",
    "shipDate": "2026-07-08",
    "carrier": "your-carrier",
    "trackingNumber": "1Z...",
    "cartons": [
      { "sscc": "000123456000000001",
        "lines": [{ "lineNumber": 1, "quantityShipped": 144 }] }
    ]
  }'

HeddleGrid generates the compliant 856, assigns control numbers, sends it over the partner's connection, and tracks the acknowledgment — you just describe what shipped.

Developers

Webhooks

Subscribe to events to drive your own systems in real time. HeddleGrid signs every delivery; verify the signature with your endpoint's signing secret.

EventFires when
order.createdA purchase order arrived and mapped cleanly to an Order.
order.changedA change document revised an existing order.
document.acknowledgedA partner's 997 confirmed acceptance of something you sent.
document.rejectedA partner rejected an outbound document.
document.exceptionA document failed validation and needs attention.

Deliveries retry with exponential backoff for 24 hours. Replay any event from the dashboard.

Developers

The Order object

One shape for a purchase order, identical across every partner. This is what you build against.

{
  "id": "ord_8Q2vXk",
  "partner": "prt_northstar",
  "poNumber": "0521-447832",
  "poType": "standard",
  "purpose": "original",          // original | change | cancel
  "poDate": "2026-06-03",
  "estimatedShipDate": "2026-07-08",
  "estimatedDeliveryDate": "2026-07-10",
  "shipTo": {
    "code": "3801", "name": "Regional DC",
    "city": "Springfield", "state": "TX",
    "postalCode": "75063", "country": "US"
  },
  "lines": [
    {
      "lineNumber": 1,
      "buyerItemNumber": "249-04-1180",
      "upc": "492403118007",
      "productDescription": "Crew Sock 3pk — Black",
      "quantityOrdered": 144,
      "measurementUnit": "EA",
      "unitPrice": "9.40"
    }
  ],
  "raw": { "documentId": "doc_b7..." }  // link to source EDI
}

The raw reference always lets you drop down to the exact source EDI — useful for audits and partner disputes. The same canonical pattern applies to Acknowledgment, ShipNotice, Invoice and InventoryAdvice.

Platform

Security & compliance

  • Encryption everywhere. TLS in transit; AES-256 at rest. AS2 payloads are signed and encrypted end to end.
  • Isolation. Every account's data is tenant-isolated at the data layer. Your documents are never visible to another customer.
  • Key management. AS2 private keys and partner credentials are stored in a managed secrets vault and rotated automatically.
  • Audit trail. Every document, mapping change and configuration edit is recorded immutably — who, what, when.
  • Compliance. SOC 2 Type II program in progress; reach out for our current report and security questionnaire.
Platform

Reliability & SLA

EDI is order and financial data — HeddleGrid treats it that way. Inbound documents are durably stored the moment they arrive, processed with at-least-once guarantees, and de-duplicated by control number. Outbound documents retry automatically and surface to you if a partner is unreachable.

  • 99.9% uptime on production plans, with a public status page.
  • No silent loss. Anything that can't be delivered lands in the exception queue, never the void.
  • Full replay. Re-deliver any document or webhook event on demand.
Platform

FAQ & support

How long does it take to add a new partner?

HeddleGrid produces the mapping in hours. The real timeline is set by your partner's certification process — usually days to a couple of weeks. We run the test cycles with you.

Do I need to understand X12 to use HeddleGrid?

No. You work with clean objects — orders, ship notices, invoices. The X12 lives underneath, available when you need to audit it.

Can I keep my current setup during a switch?

Yes. HeddleGrid can run in parallel with an existing EDI provider so you validate every document side by side before cutting over. Nothing flips until you're confident.

What if a partner uses a value-added network?

HeddleGrid interconnects to value-added networks on your behalf — you don't need your own. Direct AS2 is used wherever a partner supports it.

How do I get help?

Email support@heddlegrid.com or reach your dedicated onboarding contact. Enterprise plans include a shared channel and an SLA.