Developer API / self-serve integration
Add an EDI API gate without rebuilding partner operations
Validate one document or route a mixed partner batch while keeping mappings, holds, delivery and acknowledgements in one tenant ledger.
Direct answer
Direct answer
An EDI API integration needs scoped authentication, stable request identity, explicit byte and batch limits, per-document decisions, actionable error contracts and a retention boundary. Shipment Sentry provides bearer keys with endpoint abilities, idempotent single-document gates and 1–1,000 document partner batches, shipment evidence intake, tenant-owned mapping resolution and X12 or EDIFACT acknowledgement ingestion. The public OpenAPI 3.1 document is the machine-readable contract.
Why a parser is not enough
A parser endpoint returns syntax. A production EDI integration must also answer which partner route applied, whether a source mapping was confirmed, what exact output was cleared, whether it was held, how it was delivered and which acknowledgement matched later.
What the control should check
- 01Issue a separate expiring key per workload and least-privilege ability.
- 02Use an 8–128 character idempotency key for gate and partner-batch writes.
- 03Treat the payload string as exact business bytes.
- 04Handle 401, 409, 422 and 429 outcomes explicitly.
- 05Persist returned request, run, batch and hold identifiers.
- 06Use the OpenAPI contract in CI to catch client drift.
Working example
POST /api/v1/partner-batches
Authorization: Bearer ss_live_...
Idempotency-Key: warehouse-close-184
1,000 inputs → per-file cleared | blocked | quarantinedThe API contract names structural limits. Current partner guides still define account-specific business acceptance.
Failure modes worth catching
- One all-powerful API key is shared across environments.
- A retry uses a new key and creates a second dispatch candidate.
- Client middleware trims the EDI payload before sending.
- A 422 response is retried without reading mapping or validation detail.
Put it into the dispatch workflow
- 1Create a scoped workspace API key.
- 2Send a representative document with a stable idempotency key.
- 3Handle cleared, blocked and quarantined decisions.
- 4Confirm required mappings and rerun the identical business action.
- 5Enable route delivery after accepted and rejected fixtures pass.
- 6Ingest acknowledgements and monitor the correlated transaction.
Questions
Implementation answers
Is there an OpenAPI file?
Yes. The public OpenAPI 3.1 JSON documents the v1 base URL, bearer authentication, idempotency and request schemas.
Can one batch contain multiple partners?
Yes. Each document declares a partner code and receives its own decision.
Are API payloads retained?
The single gate defaults retention off. Partner conversion and mapping holds retain only what the authenticated workflow requires, encrypted and retention-controlled.
Sources and limits
Reviewed 2026-07-20. Public references cannot establish every partner-specific rule. Current implementation guides and agreements remain controlling.
Keep investigating