Map Transaction Output
Retrieve a mapped transaction’s output document
This functionality is available in a Stedi module. Contact us for details.
This endpoint returns the mapped output of a processed inbound transaction. You can use it to retrieve processed transaction data asynchronously.
Response
The endpoint applies the specified mapping to the processed transaction and returns the fully mapped output.
This endpoint returns a 202 Accepted upon receiving the initial request and while the transaction’s output is being mapped in the background. Once the mapping process completes, the endpoint returns a 302 Temporary redirect to the document download URL. Many HTTP clients will automatically follow this redirect, or have a simple follow redirects configuration to set. For instance in curl using the -L or --location flag will automatically follow the redirect.
In the event you cannot, or chose not to automatically follow the redirect, the body of the 302 response contains a JSON object with a key documentDownloadUrl which contains a temporary URL to download the document. This URL is good for 60 minutes.
Size limits
The recommended maximum size of the transaction output document mapped with this endpoint is 150 MB in Guide JSON format (equivalent of approximately 15 MB in raw EDI).
Authorizations
API key authentication via the 'Authorization' header
Path Parameters
A unique identifier for the mapping defined within Stedi. This ID can be found in your account's mappings list, or on the mapping details page.
A unique identifier for the processed transaction within Stedi. This ID is included in the transaction.processed.v2 event, or you can retrieve it manually from the transaction's details page within the Stedi app.
Query Parameters
When not specified, Stedi does not validate the input or the output of the mapping. When set to 'strict', Stedi applies JSON Schema validation to the input JSON and the output JSON using source and target JSON Schema.
strict If set to true, the endpoint will retry the mapping operation even if it has already been completed. This is useful if the mapping operation failed, but the root cause of the issue has been resolved.
Response
Status of the specified mapping operation.
PENDING, ERROR, SUCCESS A URL to download the document. This URL is available for 60 minutes.
Was this page helpful?