Guide JSON format

Stedi’s native format for EDI transactions is called Guide JSON. It closely reflects the structure of an EDI transaction, but uses JSON instead of EDI syntax.

• When you Generate EDI, Stedi accepts Guide JSON as input, and delivers a fully-validated EDI file to your partner.
• When you configure a Destination webhook for inbound transactions, the webhook includes the EDI transaction in Guide JSON format.

​

Example

The following example shows an Amazon 850 Purchase Order in both X12 EDI and Guide JSON formats. The EDI format is in the first tab, and the Guide JSON is in the second tab.

ST*850*0001~
BEG*00*DS*T7Fd9Zn54**20220428~
CUR*BT*USD~
REF*OQ*111-3973054-1555434~
REF*ST*1~
DTM*010*20220503*2030*GM~
DTM*002*20220507*0659*GM~
N9*ZZ*01~
MSG*This shipment completes your order.~
N9*ZZ*06~
MSG*For detailed information about your orders, please visit Your Account. You can also print invoices, change your e-mail address and payment settings, alter your communication preferences, and much more-24 hours a day-at http://www.amazon.com/your-account.~
N9*ZZ*07~
MSG*Visit http://www.amazon.com/returns to return any item-including gifts-in unopened or original condition within 30 days for a full refund(other restrictions apply). Please have your order ID ready. Thanks for shopping at Amazon.com, and please come again!~
N1*BT*Amazon.com.kydc,Inc.*92*KYDC~
N1*SF*WHSE*92*WHSE~
N1*ST*Charlie Smith~
N2*Darla Smith~
N3*11254 Main St*Suite 112~
N4*Seattle*WA*98104*US*CC*United States~
TD5**92*UPS_GR_RES****ZZ*RES~
N1*LW*Amber Smith~
N3*123 Anderson Avenue~
N4*Seattle*WA*98103*US~
PER*ZZ****TE*2065551212~
PO1*1*3*EA*18.04*NT*SK*1617*****BL*1*ZZ*Amazon.com~
CTP**PUR*19.99~
MSG*Wide Tracker Activity Walker~
PO1*2*2*EA*54.42*NT*SK*4927*****BL*1*ZZ*Amazon.com~
CTP**PUR*59.99~
MSG*Deluxe Cozy Convertible~
PO1*3*1*EA*18*NT*SK*9876*****BL*1*ZZ*Amazon.com~
CTP**PUR*34.99~
MSG*Red Rattle~
CTT*3*6~
SE*35*0001~

​

What is Guide JSON?

Guides are Stedi’s machine-readable representation of the EDI specifications that your trading partners provide to you (typically in the form of PDF, Excel, or Word files), or that you provide to your trading partners. You can view and import guides from popular trading partners in the Stedi Network.

Each guide is backed by a JSON Schema that defines the structure of the EDI transaction. Guide JSON is JSON data that conforms to the guide’s schema.

​

How Stedi uses Guide JSON

• Inbound files: Stedi uses the inbound transaction settings within the partnership to determine which Stedi guide to use for validation and translation. If validation is successful, Stedi parses the file into one or more transactions, and outputs them in Guide JSON.
• Outbound files: You must supply Stedi’s Generate EDI API with transaction data in the Guide JSON format. Stedi uses that data to generate an EDI file and deliver it to your trading partner.

​

Find a guide’s JSON Schema

To find the JSON Schema for a guide:

1. Navigate to the Guides page in your Stedi account.
2. Click the guide you want to view.
3. Open the Actions menu and select View schema.

​

How Guide JSON formats vary

Guide JSON formats vary in three ways. You must account for these differences when you receive Guide JSON webhooks for inbound transactions, and when you call the Generate EDI API to send outbound transactions.

​

Transaction type

Since a guide can represent any of the 300+ EDI transaction types, the Guide JSON (and corresponding JSON Schema) will differ depending on the transaction type. For example, the Guide JSON for an 850 Purchase Order will be different than the Guide JSON for an 810 Invoice. This means that the payloads that you receive from Stedi via webhook will vary depending on the transaction type, and the payloads that you send to the Generate EDI API will also vary depending on the transaction type.

​

Release

X12 has 30+ releases, or versions. There are often breaking changes between X12 releases, which makes it impossible to reliably canonicalize transactions across releases. Since different trading partners use different releases, the Guide JSON you have to accept from and provide to Stedi differ depending on the release. For example, the Guide JSON for an 850 Purchase Order in X12 release 004010 will be different than the Guide JSON for an 850 Purchase Order in X12 release 005010.

​

Trading partner

Since different trading partners use different EDI specifications, the Guide JSON may differ depending on the trading partner. For example, the Amazon Retail 855 PO Acknowledgment allows you to optionally specify pricing information in the CTP segment, but the Walmart 855 does not.