ModernEDI Integration API (1.8.0)

Returns the tenant's configured trading partners in workspace order. Use partnerId from this response as the partnerId query parameter on /v1/as2/send, /v1/as2/reply, or /v1/as2/carbonCopy when your integration needs exact partner selection instead of partner-name matching. The returned name is the configured partner name accepted as customer or copyToCustomer; the same id can be sent as copyToPartnerId for the carbon-copy recipient. Partners can appear before their AS2 profile is complete so teams can publish and test maps during onboarding; as2ConnectionConfigured tells you whether live AS2 delivery can use that partner yet.

Sends a standalone outbound document to the configured trading partner. Send the source XML, JSON, or text input as the HTTP request body. ModernEDI looks up the matching outgoing map by partner, X12 version, functional group, transaction set, and request Content-Type, applies that map to generate X12, syntax-checks the generated X12, then sends it through the configured AS2 connection. JSON source maps can use XSLT with Saxon json-to-xml($json) or JSLT. For JSLT, ModernEDI sets the current input . to a wrapper object, so the source document is read through .input paths. Send either customer or partnerId to select the partner; use GET /v1/partners when your integration client needs to discover stable partner ids. If the outgoing map needs extra runtime parameters such as a bill-of-lading number, pallet list, or generated control number, send the JSON envelope shape with input, contentType, and params. The envelope can also include businessKey when your system knows a stable purchase order, shipment, BOL, or other business identifier that should appear on the outbound transaction record. XSLT maps receive those params as top-level stylesheet parameters; JSLT maps receive them under .params. Mapper-editor params files are test fixtures only; live API calls must provide required params in this request envelope.

Sends a follow-up document such as an ASN or invoice in response to a previously received inbound message. Send the source XML, JSON, or text input as the HTTP request body. ModernEDI looks up the original message by originalMessageId, and uses unambiguous metadata from that inbound transaction to recover an omitted partner selector and x12Version. ModernEDI uses the persisted partnerId, so the reply still selects the same partner after its configured name changes. Transactions without a persisted partner id do not supply inferred partner metadata. An explicit partnerId or customer always overrides inferred partner metadata. If persisted partner ids conflict, ModernEDI does not infer either partner selector. After the partner selector, X12 version, and request Content-Type are known, ModernEDI can also fill omitted functionalGroupType and transactionGroupType when those selectors match exactly one outgoing reply map. ModernEDI then selects the matching outgoing map by partner, X12 version, functional group, transaction set, and request Content-Type, generates and validates X12, then sends the reply through the configured AS2 connection. Send x12Version explicitly when a partner requires reply documents on a different X12 version than the one they send; explicit query parameters override inferred metadata. If multiple reply maps could match, send functionalGroupType and transactionGroupType explicitly. The original inbound document type is not reused as the reply type; these fields identify the generated reply document, such as IN/810 for an invoice. JSON source maps can use XSLT with Saxon json-to-xml($json) or JSLT. For JSLT, ModernEDI sets the current input . to a wrapper object, so the source document is read through .input paths. If the outgoing map needs extra runtime parameters, send the JSON envelope shape with input, contentType, and params; XSLT maps receive those values as top-level stylesheet parameters, JSLT maps read them from .params, and mapper-editor params files are not used as live defaults. Use the envelope's optional businessKey field when the reply has a stable identifier, such as an invoice number, that should be stored on the outbound transaction record.

Sends a generated X12 document to a second partner while preserving context from a previously received inbound message. Send the source XML, JSON, or text input as the HTTP request body. The customer or partnerId query parameter identifies the source/original partner whose outgoing map should generate the X12, and copyToCustomer or copyToPartnerId identifies the destination partner for the copied AS2 envelope. ModernEDI selects the matching outgoing map for that original/source partner, generates and validates X12, then forwards the carbon copy through the configured AS2 connection. Example: to generate an 856 ASN for Retailer One and copy it to Broker One, send customer=Retailer%20One and copyToPartnerId=2; ModernEDI uses Retailer One's outgoing 856 map. copyToCustomer does not select the outgoing map, and neither does copyToPartnerId. JSON source maps can use XSLT with Saxon json-to-xml($json) or JSLT. For JSLT, ModernEDI sets the current input . to a wrapper object, so the source document is read through .input paths. If the outgoing map needs extra runtime parameters, send the JSON envelope shape with input, contentType, and params; the map is still selected by customer/partnerId, not by copyToCustomer or copyToPartnerId. XSLT maps receive params as top-level stylesheet parameters, JSLT maps read them from .params, and mapper-editor params files are test fixtures only and are not read by live carbon-copy calls. The envelope's optional businessKey is recorded on the copied outbound transaction, but it does not affect map selection.

Returns mapped inbound documents for this tenant and temporarily marks them in progress. If a returned message is not acknowledged before the visibility timeout expires, ModernEDI may return it again on a later poll. Push delivery uses the same queue state: a successful 2xx webhook response acknowledges the message, while a failed push leaves it available through this endpoint. Each request performs a bounded scan. When hasMore is true, send nextCursor as the next request's cursor so polling advances past unavailable or output-free transactions instead of rescanning them. This endpoint runs on the shared ModernEDI API host, not on the tenant AS2 hostname.

Confirms that your system has accepted a previously returned mapped output message. Call this after the mapped output has been stored, processed, or queued in your system. The receipt handle must match the latest poll response for this mapped output id.

Returns a pageable transaction history for custom transaction viewers, dashboards, and reconciliation workflows. Outbound replies include replyToMessageId so they can be shown underneath the inbound document they answer.

Returns the transaction summary, downloadable document payloads, mapped inbound outputs, timeline events, and linked outbound reply transactions.

Returns raw X12, mapped inbound outputs, MDN reports, acknowledgements, and HTTP response bodies recorded for the transaction.

Returns a normalized timeline for the transaction, including receipt or send events, mapping events, MDNs, acknowledgements, and linked replies.

Returns outbound reply transactions linked to an inbound transaction by replyToMessageId. Use this to render replies underneath the inbound document in a custom viewer.