STstedi

GET /transactions/{transactionId}/fragments/{fragmentIndex}/output-url

Changed on

This endpoint is used to retrieve a transaction fragment's output document URL after it has been translated via Core.

This endpoint returns the document download URL, it must be then fetched for the actual document content. There are no size restrictions on documents when fetching from this endpoint, however they are generally smaller and consumable by nature of being a fragment.

Request

  • Base URL
    https://core.us.stedi.com/2023-08-01
  • URL
    https://core.us.stedi.com/2023-08-01/transactions/{transactionId}/fragments/{fragmentIndex}/output-url
  • Auth
    API key in header Authorization

Path parameters

transactionIdstring required

A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal.

fragmentIndexnumber required

Response

GetTransactionFragmentOutputDocumentUrl 200 response

documentDownloadUrlstring

A URL to download the document. This URL is available for 60 minutes.

Changes

  • 7d72a1312904Revision changes
    • 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