Sign in

v50

latestOpenAPI 3.0.2Proprietaryraw.githubusercontent.com2026-07-2730103305.1 KB

This endpoint stages a transaction for outbound delivery.

post/partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/transactions/{transactionSettingId}

Path parameters

partnershipIdstring required

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 this partnership within Stedi. You can find this ID on the Trading partners page under Partnership identifier.

transactionSettingIdstring required

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 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.

transactionGroupIdstring required

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.

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.

Headers

Idempotency-Keystring

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.

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.

Request body

{"stackTrail":"components:schemas:CreateTransactionGroupRequestContent:properties:transaction","oasType":"schema","type":"unknown","description":"The data for an EDI transaction. If you are not using a mapping, this transaction data must be < 5MB and the shape should match the [Guide JSON](https://www.stedi.com/docs/edi-platform/operate/transform-json/guide-json) format for the specified outbound transaction setting. If you are using a mapping, this transaction data must be < 4MB and the shape must match the source schema for the specified mapping. Either `transaction` or `async: true` is required."}
mappingIdstring

Specify a mapping id to transform the transaction to Stedi's Guide JSON format. Can not be used with async: true.

asyncboolean

Determines if the transaction should be uploaded asynchronously through a presigned url. Either transaction or async: true is required. Idempotency-Key header is required when using async: true.

Response

CreateTransactionGroup 201 response

transactionGroupIdstring required

The transaction group ID where you created and added the transaction.

createdAtstring date-time required

The time Stedi staged the transaction.

transactionIdstring required

A unique ID for the staged transaction Stedi created within the group.

uploadUrlstring

A pre-signed URL to upload the file using a PUT request.