POST /partnerships/:partnershipId/transactions/:transactionSettingId

This endpoint generates and delivers fully-formed EDI files containing a single transaction. It is the simplest way to generate EDI with Stedi.

post/partnerships/{partnershipId}/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.

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. If you are generating a transaction with fragments, the associated guide must be configured to use fragments.

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

Request body

characterSet'Basic' | 'Extended' | 'ExtendedHipaa'

When generating EDI, the character set determines the set of characters allowed in the EDI message. Characters outside of the specified set (after applying any repairs specified in RepairOptions) will result in an error.

{"stackTrail":"components:schemas:CreatePartnershipOutboundTransactionRequestContent: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."}

filenamestring

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 the same ID generated for the fileExecutionId.

fragmentGroupIdsstring[]

Specify the fragment groups to include when creating this transaction. You can only generate EDI with a fragment group once. After you include a fragment group in generation call, Stedi locks the fragment to prevent accidentally generating transactions with duplicate data.

mappingIdstring

Specify a mapping ID to transform the transaction data to Guide JSON format. You can find the mapping ID on the Mappings page in the Stedi portal.

Response

CreatePartnershipOutboundTransaction 200 response

transactionIdstring

This property is currently not supported. It is reserved for future use.

fileExecutionIdstring

An ID for the process Stedi uses to generate the EDI file. This ID appears on the details page for the generated file in the Stedi portal, and you can use it to trace the file's status and delivery.

Changes

Changed in 9 of the 51 revisions of this API.212

Jul 6, 2026368ef472b3fa1See the full diff
- ○
  added the new optional request property
  new-optional-request-property
Apr 28, 20267d72a13129043See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the non-success response with the status
  response-non-success-status-added
Apr 16, 2026e8b8d62c2e1511See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 13, 2025057d587553be2See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 9, 2025f53f6e7675332See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
Jan 6, 20258eb8e4b497a41See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
Dec 18, 20246e04e598f8261See the full diff
- ●
  changed the pattern of the path request parameter partnershipId from ^([a-zA-Z0-9_-]+)$ to ^([a-zA-Z0-9._-]+)$
  request-parameter-pattern-changed
Dec 3, 2024e651ba0208a91See the full diff
- ○
  the request property's maxLength was increased from 200 to 300
  request-property-max-length-increased
Nov 8, 20245bc993d99ff71See the full diff
- ○
  added the new optional request property
  new-optional-request-property

Full history