EDI Management API (1.0.9)

Download OpenAPI specification:Download

EDI validation, translation, and management system.

Authentication

APIKeyScheme

API Key from channel configuration

Security Scheme Type API Key
Header parameter name: X-FT-API-Key

OAuth2Scheme

Token-based auth using OAuth2

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: /token
Scopes:
    authorizationCode OAuth Flow
    Authorization URL: /authorize
    Token URL: /token
    Scopes:

      Transactions

      Perform EDI validation and translation to XML, or translation from XML to EDI

      Submit an EDI interchange for validation and conversion (Persistent)

      Submit an EDI interchange for validation and conversion to a back-end application. This operation accepts a well-formed EDI interchange and (when successfully translated) responds with an EDI format corresponding to the input (e.g. an X12 997). The transformed interchange is written to local server storage (other other queuing system) to be retrieved by or forwarded to a back-end application for further processing.

      Authorizations:
      Request Body schema:

      EDI payload in either X12 or EDIFACT format

      object

      Properly formatted EDI interchange

      Responses

      Submit an XML format interchange for conversion to EDI (Persistent)

      Submit an XML interchange for validation and conversion to EDI. This operation accepts a well-formed XML interchange and (when successfully translated) responds with an EDI format corresponding to the input. Information about the interchange (transaction control numbers, types of transactions, etc.) is persisted to the Fresno database for tracking and to support acknowledgement confirmation.

      Authorizations:
      Request Body schema: application/xml

      XML payload to be converted to EDI

      object

      Properly formatted XML interchange

      Responses

      Translate an EDI interchange (Persistent)

      Translate an EDI interchange and persist meta information and validation status in history. This operation accepts a well-formed EDI interchange and (when successfully translated) responds with an XML representation of the interchange. The Link header includes a URI that may be used for retrieval of validation/status information pertaining to the interchange.

      Authorizations:
      Request Body schema:

      EDI payload in either X12 or EDIFACT format

      object

      Properly formatted EDI interchange

      Responses

      Response samples

      Content type
      { }

      Validate an EDI interchange (Persistent)

      Validate an EDI interchange and persist meta information and validation status in history. This operation accepts a well-formed EDI interchange and responds with either an EDI format corresponding to the input or a JSON format describing the result of validation.

      Authorizations:
      Request Body schema:

      EDI payload in either X12 or EDIFACT format

      object

      Properly formatted EDI interchange

      Responses

      Response samples

      Content type
      No sample

      History

      Channel transaction history

      Retrieve a list of functional groups for a particular interchange

      Authorizations:
      query Parameters
      interchangeId
      required
      string

      Interchange identifier

      Responses

      Response samples

      Content type
      application/json
      [
      • {
        }
      ]

      Retrieve a functional group by identifier

      Authorizations:
      path Parameters
      id
      required
      string

      Record identifier

      Responses

      Response samples

      Content type
      application/json
      {
      • "ackCode": "string",
      • "agencyCode": "string",
      • "channel": {
        },
      • "controlCount": "string",
      • "controlReference": "string",
      • "createdAt": "2019-08-24T14:15:22Z",
      • "industryCode": "string",
      • "release": "string",
      • "updatedAt": "2019-08-24T14:15:22Z",
      • "uuid": "string",
      • "version": "string",
      • "createTimestamp": "2019-08-24T14:15:22Z",
      • "errors": [