---
title: "Generate an outbound UN/EDIFACT document from JSON - the..."
method: POST
path: "/api/edi/edifact-generate"
tags: ["edi"]
---

# Generate an outbound UN/EDIFACT document from JSON - the...

`POST /api/edi/edifact-generate`

## Request

- Base URL: `https://2s.io`
- URL: `https://2s.io/api/edi/edifact-generate`
- Auth: API key in header `PAYMENT-SIGNATURE`

Generate an outbound UN/EDIFACT document from JSON — the international counterpart to edi.generate (X12). POST type ('ORDERS' = purchase order or 'INVOIC' = invoice) + senderId, recipientId (with optional qualifiers), documentNumber, optional date (CCYYMMDD), parties (NAD role+name, e.g. BY buyer / SU supplier / IV invoicee), items (quantity, productId, price), and for INVOIC an optional total. Returns the full EDIFACT interchange in meta.edi — a correct UNA/UNB/UNH…UNT/UNZ envelope with BGM, DTM, NAD, LIN/QTY/PRI, MOA/CNT — with proper delimiters and release-character escaping. Deterministic, no external calls. Round-trips through edi.edifact.

## Query parameters

- `trial` 1

## Request body

- object
  - `type` 'ORDERS' | 'INVOIC', required: Filter results by type.
  - `senderId` string, required: Sender ID.
  - `recipientId` string, required: Recipient ID.
  - `senderQualifier` string: Sender qualifier.
  - `recipientQualifier` string: Recipient qualifier.
  - `documentNumber` string, required: Document number.
  - `date` string: Date in YYYY-MM-DD format.
  - `parties` object[]: Parties.
    - `role` string, required: Role.
    - `name` string, required: Name to search for.
  - `items` object[], required: Items.
    - `quantity` union, required: Quantity.
      - number
      - string
    - `productId` string: Product ID.
    - `price` union: Price.
      - number
      - string
    - `idType` string: ID type.
  - `total` number: Total.
  - `controlRef` string: Control ref.

## Other responses

- `200` (unresolved $ref)
- `400`: Invalid request — not charged. error.code: BAD_REQUEST or INVALID_PARAM (parameter validation; error.details.issues lists each problem), MALFORMED_JSON, or a request-specific code. Other client errors: 405 METHOD_NOT_ALLOWED (wrong verb; see the Allow header), 413 PAYLOAD_TOO_LARGE.
- `402`: Payment required. Body is the x402 PaymentRequirements envelope with a multi-network accepts array; the per-call price is in accepts[].amount (and on the operation as x-2s-price). Sign for whichever rail you hold USDC on (EIP-3009 for Base, partial SPL transfer for Solana) and retry with the PAYMENT-SIGNATURE header (X-PAYMENT also accepted for v1 clients). Also PAYMENT_SETTLE_FAILED (error envelope) when a verified payment failed to settle: error.details.chargeStatus is "not_charged" (retry with a fresh payment) or "unknown" (the authorization may still settle before its deadline — check it before retrying).
- `429`: Too many requests — RATE_LIMITED: our per-IP / per-payer limiter. Not charged; retry after Retry-After.
- `5XX`: Server-side failure. 500 INTERNAL: unexpected error; quote error.errorId (also the X-2s-Error-Id header). 502 UPSTREAM_UNAVAILABLE (or another UPSTREAM_* code): the data provider failed — composite endpoints refuse unbilled when every source fails. 503 SERVICE_PAUSED: endpoint paused by the operator kill switch, retry after Retry-After; 503 SPEND_CAP: daily upstream budget exhausted. 504 UPSTREAM_TIMEOUT. Not charged.

---

[API](https://skmtc.dev/2s-io/apis/2s-the-most-everything-api.md) · [All operations](https://skmtc.dev/2s-io/apis/2s-the-most-everything-api/llms.txt) · [OpenAPI document](https://skmtc.dev/2s-io/apis/2s-the-most-everything-api/revisions/da4c5caf686e?raw)