Skip to content
Independent EDI conversion and validation software. Retailer names identify interoperability targets; no retailer endorsement is implied.
Shipment Sentry
Start routing

Operational EDI reference

EDI Validation API with Idempotent Gate Decisions

Put a tenant-scoped validation API between document generation and the existing transport.

Use the free validator See batch and API plans

Direct answer

Direct answer

An EDI validation API should accept the complete business document, detect or receive the format, apply a versioned rule pack, and return a structured cleared or blocked decision. Every request needs a client-generated idempotency key so a timeout retry returns the original result without consuming quota or creating a second decision. API keys must be hashed, scoped by ability, revocable and isolated to one workspace.

Why a parser is not enough

The useful unit is not a file that parses; it is a business document with a known decision, an owner, a source trail and a matched downstream response. This page connects the technical structure to that operating workflow.

What the control should check

  1. 01Require an 8–128 character idempotency key.
  2. 02Hash request content and reject key reuse with different input.
  3. 03Reserve quota atomically.
  4. 04Return stable finding codes and exact locations.
  5. 05Never store plaintext API keys or raw payloads by default.

Working example

POST /api/v1/gate + Idempotency-Key dispatch-1042 → 201, then retry → 200 replayed

The excerpt is intentionally compact. Use the working validator or authenticated gateway with the complete interchange to obtain a decision.

Failure modes worth catching

  • A transport receipt is mistaken for business acceptance.
  • Control identifiers are regenerated between validation and submission.
  • A warning has no owner and becomes a recurring manual investigation.
  • The document is checked alone even though the truth exists in a purchase order, label or acknowledgement.

Put it into the dispatch workflow

  1. 1Validate the source document before transport.
  2. 2Block deterministic failures and assign every review item.
  3. 3Release with a recorded owner and timestamp.
  4. 4Match functional and application acknowledgements.
  5. 5Reconcile confirmed outcomes back into fixtures and rules.
Use batch validation and acknowledgement tracking

Questions

Implementation answers

Does Shipment Sentry replace my EDI provider?

No. It sits before the existing transport as a validation and evidence sidecar.

What does cleared mean?

The document has no blocking finding in the current rule pack. It is not a guarantee of trading-partner or receiving acceptance.

How are repeat requests kept safe?

The API requires an idempotency key, stores only a token hash, scopes every record to one workspace and rejects reuse with different content.

Sources and limits

Reviewed 2026-07-18. Public references cannot establish every partner-specific rule. Current implementation guides and agreements remain controlling.

Keep investigating

Related EDI controls

View the library
Add an EDI API gate without rebuilding partner operations Connect Business Central records to controlled EDI delivery Send EDI over AS2 without mistaking HTTP success for delivery proof Connect validated invoices to a certified Peppol access point Turn EDI partner testing into a versioned release gate Give EDI users reports that lead back to transaction evidence