STstedi

POST /partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/generate-edi

Changed on

This endpoint generates and delivers a fully-formed EDI file containing the staged transactions in the specified transaction group.

Request

  • Base URL
    https://core.us.stedi.com/2023-08-01
  • URL
    https://core.us.stedi.com/2023-08-01/partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/generate-edi
  • Auth
    API key in header Authorization

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.

transactionGroupIdstring required

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.

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.

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

transactionOrdering'CONTROL_NUMBER'

Specify the order of the transactions in the generated X12 EDI file. By default, Stedi doesn't guarantee any particular order.

Set to CONTROL_NUMBER to order transactions within a functional group by their control number, from lowest to highest. In X12 EDI, this is ST02 (Transaction Set Control Number).

Response

GenerateTransactionGroupEdi 200 response

artifactIdstring required

An ID for the generated EDI file.

fileExecutionIdstring required

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 portal. Internally, Stedi uses this ID to place the file in Stedi's outbound queue.

Changes

  • 7d72a1312904Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the non-success response with the status

  • e8b8d62c2e15Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status