Deliver Transaction Group
This endpoint generates and delivers a fully-formed EDI file containing the staged transactions in the specified transaction group.
When you call this endpoint, Stedi:
- Generates a single EDI file containing all transactions in the specified transaction group (
transactionGroupId). This includes adding required envelope information (ISAandGSheaders) and autogenerated control numbers. - Delivers the EDI file to your trading partner through the connection specified in the transaction settings.
You can only call this endpoint with a given transactionGroupId once. Afterward, that transaction group is locked, and you must create a new transaction group to generate another file.
Stage transactions
You can use the Stage Transactions API to store one or more transactions in a transaction group on Stedi. When you’re ready to send all of the transactions in the group, you can call this endpoint to generate and deliver an EDI file to your trading partner.
Delivery attempts
Stedi attempts to deliver a file to all configured connections every 6 minutes for up to 3 total attempts. If it cannot deliver the file after the third attempt, it marks the file execution as FAILED and emits the file.failed.v2 event. Stedi displays each delivery attempt and the failure details on the Files page.
Customize generated files
You can change the timezone, time format, character set (which characters are allowed), and filename for generated files. Learn more.
Inbound processing
There is no equivalent endpoint for parsing EDI files into JSON. To parse inbound files, you or your partner can send EDI files to an SFTP/FTPS or AS2 connection, and Stedi sends the JSON payload to the configured Destination webhook.
This endpoint generates and delivers a fully-formed EDI file for a given transaction group. Transactions are staged in a group using the CreateTransactionGroup endpoint. Once a file has been generated for a given transaction group, the group can no longer be used.
Authorizations
A Stedi API Key for authentication.
Headers
A unique string to identify this request to the server. The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents sending duplicate data to your trading partners in case of network errors or other intermittent failures. Learn more.
Path Parameters
A unique ID for this partnership within Stedi. You can find this ID on the Trading partners page under Partnership identifier.
A unique ID for a transaction group stored on Stedi. You can only call this endpoint with a given transactionGroupId once. Afterward, the transaction group is locked.
Body
Set a custom name for the generated EDI file. Stedi overwrites files with the same name, so we recommend making the filename unique by including a timestamp or other identifier. If you do not specify a filename, Stedi autogenerates a unique name using an ID.
Set values for ISA header elements (ISA-01 to ISA-04).
Response
An ID for the generated EDI file.
A ID for the process Stedi uses to generate the EDI file. This ID appears on the details page for this file execution in the Stedi app. Internally, Stedi uses this ID to place the file in Stedi's outbound queue.
Was this page helpful?