Home /  API Reference / 

EDI Translate

The EDI Translate product is responsible for translating data between JSON and EDI formats. It uses a Stedi guide, which validates the data being translated, and is the resource which enables the API to determine how the EDI output is structured and formatted.

Download OpenAPI

TranslateX12ToJson

POST/x12/to-json

Converts an X12 EDI string into a JSON document, using the provided guideId.

Request body

application/json

Requiredstring

The ID to the guide that describes the relationship between the fields found in the input X12 EDI document and the output JSON.

Requiredstring

The incoming X12 EDI string to be converted into a JSON object. Must be a UTF-8 encoded string.

Example

POST
https://edi-translate.us.stedi.com/2022-01-01/x12/to-json

TranslateJsonToX12

POST/x12/from-json

Converts a JSON document into X12 EDI, using the provided guideId.

Request body

application/json

Requiredstring

The ID to the guide that describes the relationship between the fields found in the input JSON document and the output X12 EDI.

RequiredAny

The JSON document to be converted into X12 EDI. This document must conform to the specified guide.

OptionalAny

A JSON document specifying the envelope data to be included in the X12 EDI translation.

Optionalobject
Options that tell EDI Translate how to format the output.
TranslateJsonToX12OutputOptions object.

Example

POST
https://edi-translate.us.stedi.com/2022-01-01/x12/from-json