This quickstart uses Postman to consume the EDI API, get Postman here.
In this tutorial we'll show how to translate an X12 file containing one or more transactions (ST/SE blocks) without interchange or functional group.
Set the Params
Version 1 of the API is limited to files with size up to 3 MB, hence read_mode can only be set to read_small. Version 2 will cater for files of any size.
If you'd prefer to translate and validate the file as part of the same operation, set validate to True.
Set the Headers
If you'd like to receive XML-encoded responses, set Accept to application/xml.
Set the API key to the key that you generated in the developer portal (the one above is for evaluation purposes only).
Set the Body
Select the form-data option and add parameter with key transaction_only and value True. If the transaction delimiters are different than the default (X12 default separators) then add parameters for each delimiter that is different.
Lastly, add a key with file value and select an EDI file that contains a list of transactions only:
The ST segment must also include the version number at position 3 for this to work:
Sample X12 file without envelopes:
ST*850*0001*004010~ BEG*00*SA*XX-1234**20170301**NA~ PER*BD*ED SMITH*TE*8001234567~ TAX*53247765*SP*CA*********9~ N1*BY*ABC AEROSPACE*9*1234567890101~ N2*AIRCRAFT DIVISION~ N3*2000 JET BLVD~ N4*FIGHTER TOWN*CA*98898~ PO1*1*25*EA*36*PE*MG*XYZ-1234~ MEA*WT*WT*10*OZ~ IT8*******B0~ SCH*25*EA***106*20170615~ CTT*1~ AMT*TT*900~ SE*15*0001~
Hit the Send button
Use the following URL:
Inspect the response
The response is a single X12Interchange (Translate X12 API Reference) object where the translated transactions can be found under the first functional group.