Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

edi-214 Transactions API

X12 transaction set management

edi-214 Transactions API is one of 5 APIs that edi-214 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.stedi.com/2024-01-01, https://edi-gateway.logistics-platform.example.com/api.

2 operations 2 paths 9 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://edi-gateway.logistics-platform.example.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

edi-214 Transactions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • apiKey — API key in format "Key {yourapikey}" for Stedi platform access

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Transactions 2

X12 transaction set management

GET
/transactions
List EDI 214 transactions
listTransactions 4 params → 200
GET
/transactions/{transactionId}
Get EDI 214 transaction details
getTransaction 1 param → 200404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are At7Segment (7 properties), Ms1Segment (7 properties), Edi214Document (7 properties), LxLoop (5 properties). Each schema is shown below with its type and property counts.

Ms1Segment
object
MS1 - Equipment, Shipment, or Real Property Location
7 properties
TransactionList
object
2 properties
B10Segment
object
B10 - Beginning Segment for Transportation Carrier Shipment Status Message
4 properties
Edi214Document
object
Parsed representation of an X12 EDI 214 transaction set
7 properties
Ms2Segment
object
MS2 - Equipment or Container Owner and Type
3 properties
Q2Segment
object
Q2 - Status Details (Weight, quantity, lading details)
4 properties
LxLoop
object
LX detail loop containing status events for a shipment segment
5 properties
At7Segment
object
AT7 - Shipment Status Details segment
7 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edi-214-transactions-api-openapi.yml Raw ↑

Other APIs edi-214 publishes across the network.

Stedi EDI API (X12 214 Support)
Flexport EDI API (214 Air Shipment Status)
edi-214 EDI Processing API
edi-214 Shipment Status API