APIs for EDI/B2B management
Updated
Boomi's EDI offering (B2B/EDI Management) is supported by several APIs in the Boomi Enterprise Platform API set. This page lists the APIs and objects that work with EDI trading partners, EDI connector records, and EDI document processing.
Before you start
Use the Platform REST API for most EDI tasks. Use the Platform SOAP API only for objects that the REST API does not cover. Authentication for the Platform and Partner APIs uses Basic Auth, API tokens, 2FA, or JWT tokens. See Platform API and Partner API authentication.
Trading partner management
| Object | Purpose | Reference |
|---|---|---|
| Trading Partner Component | Query, create, update, and delete trading partner components. Supports EDIFACT, X12, EDI, HL7, RosettaNet, and TRADACOMS structures. | REST · SOAP |
| Trading Partner Processing Group | Manage processing groups that organize trading partners. | REST · SOAP: Trading Partner Processing Group object |
EDI document tracking and reporting
These objects return the processing records that appear on the Process Reporting page.
| Object | Standard | Purpose | Reference |
|---|---|---|---|
| X12 Connector Record | X12 | Read X12 document and trading partner processing records. | REST · SOAP: X12 Connector Record object |
| EDIFACT Connector Record | EDIFACT | Read EDIFACT document, interchange, and acknowledgment records. | REST · SOAP: EDIFACT Connector Record object |
| Generic Connector Record | Any connector type | Retrieve document metadata for a single process run, including tracked fields, status, and whether the document can be rerun. Query it within one run. You can't query across runs. Use it with Execution Record and Execution Connector to drill from a run to its documents. | REST · SOAP: Generic Connector Record object |
| EDI Custom Connector Record | Custom EDI | Read records for custom EDI standards. | REST · SOAP: EDI Custom Connector Record object |
| HL7 Connector Record | HL7 | Read HL7 processing records. | REST · SOAP: HL7 Connector Record object |
| TRADACOMS Connector Record | TRADACOMS | Read TRADACOMS processing records. | REST · SOAP: TRADACOMS Connector Record object |
| ODETTE Connector Record | ODETTE | Read ODETTE processing records. | REST · SOAP: ODETTE Connector Record object |
| OFTP2 Connector Record | OFTP2 | Read OFTP2 processing records. | REST · SOAP: OFTP2 Connector Record object |
| RosettaNet Connector Record | RosettaNet | Read RosettaNet processing records. | REST · SOAP: RosettaNet Connector Record object |
| AS2 Connector Record | AS2 | Read AS2 Client (send) and AS2 Shared Server (listen) processing records. | REST · SOAP: AS2 Connector Record object |
| AS2 Artifacts | AS2 | Download AS2 artifact logs. | REST · SOAP operation: Download AS2 Artifacts Log |
Document recovery and monitoring
| Object | Purpose | Reference |
|---|---|---|
| Connector Document | Retrieve documents processed by a connector. | REST · SOAP: Connector Document operation |
| Rerun Document | Reprocess failed documents. | REST · SOAP: Rerun Document operation |
| Document Count (Account, Account Group) | Get document counts by account or account group. | REST account, REST account group |
For a workflow that uses these objects to find and rerun failed documents, see Investigating and rerunning failed documents.
Errors and API conventions
- Platform REST API errors: HTTP status codes, SOAP fault codes, and retry guidance.
- OpenAPI 3.0: Use the OpenAPI spec and Postman collection to test endpoints.
- Account security for CORS: Configure cross-origin rules.
