Stage transactions
This endpoint stages a transaction for outbound delivery.
Stedi stores the transaction in the transaction group specified by the transactionGroupId
. If a group with that ID does not exist, Stedi creates one.
When you’re ready to send all of the transactions in the group, call the Deliver Transaction Group endpoint with the transactionGroupId
to generate and deliver a fully-formed EDI file to your trading partner.
Transaction data
You provide transaction data in Guide JSON format. The transaction data must be < 5MB.
All of the transactions you stage in a transaction group must use the same transaction settings. If you attempt to stage a transaction with different settings, Stedi returns an error.
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. Required if providing async: true
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.
1 - 81
A unique ID for the outbound transaction setting Stedi should use to determine the correct guide for validation and generation. It must be attached to the partnership associated with the partnershipId
. To find the transactionSettingsId
, go to the partnership and use the Transaction Setting ID field for the outbound transaction setting.
A unique ID for a group of transactions on Stedi. Stedi creates a new transaction group if one does not exist with the specified ID.
Body
Response
The response is of type object
.