Map Transaction Output

Retrieve a mapped transaction's output document

GET /mappings/{id}/map-transaction-output/{transactionId}

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

Authorization · string · required · header

API key authentication via the 'Authorization' header

Path Parameters

id · string

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.

• Pattern: ^([A-Z0-9]+)$
• Required string length: 26

transactionId · string

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.

• Pattern: ^([A-Z0-9]+)$
• Required string length: 26

Query Parameters

validation_mode · string

Validation mode, when not provided - no validation of input and output is applied, for the 'strict' option JSON Schema validation is applied to the input JSON and the output JSON using source and target JSON Schema.

Possible values

strict

retry · string

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

application/json

MapTransactionOutput 202 response

status · string · required

Status of the specified mapping operation.

Possible values

PENDING

ERROR

SUCCESS

documentDownloadUrl · string

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

cURL

curl --request GET \
  --url "https://mappings.us.stedi.com/2021-06-01/mappings/{id}/map-transaction-output/{transactionId}" \
  --header "Authorization: <api_key>"

JavaScript

fetch("https://mappings.us.stedi.com/2021-06-01/mappings/{id}/map-transaction-output/{transactionId}", {
  headers: {
    "Authorization": "<api_key>"
  }
})

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://mappings.us.stedi.com/2021-06-01/mappings/{id}/map-transaction-output/{transactionId}"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("Authorization", "<api_key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

Python

import requests

url = "https://mappings.us.stedi.com/2021-06-01/mappings/{id}/map-transaction-output/{transactionId}"

response = requests.request("GET", url, headers = {
  "Authorization": "<api_key>"
})

print(response.text)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://mappings.us.stedi.com/2021-06-01/mappings/{id}/map-transaction-output/{transactionId}"))
  .header("Authorization", "<api_key>")
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}

202

{
  "status": "PENDING",
  "documentDownloadUrl": "string"
}

400

{
  "code": "mapping_failed",
  "message": "string",
  "validation_errors": {
    "source": {
      "errors": [
        {
          "code": "string",
          "message": "string",
          "json_pointer": "string",
          "json_schema_pointer": "string"
        }
      ],
      "mapping_input": null
    },
    "target": {
      "errors": [
        {
          "code": "string",
          "message": "string",
          "json_pointer": "string",
          "json_schema_pointer": "string"
        }
      ],
      "mapping_output": null
    }
  }
}

401

{
  "message": "string",
  "code": "unauthorized"
}

403

{
  "message": "string",
  "code": "access_denied"
}

404

{
  "message": "string",
  "code": "not_found"
}

429

{
  "message": "string",
  "code": "too_many_requests"
}