EdiNation API

openapi: 3.1.0
info:
  title: EdiNation API
  version: '2026-10-20'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-20: 21 operation(s) read from 14 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; EdiNation has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 18
    pages-with-code: 7
    pages-read: 14
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-20'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.edifabric.com/docs/edifabric-cloud/hl7-resources.html
  - https://www.edifabric.com/docs/edifabric-cloud/vda-resources.html
  - https://www.edifabric.com/docs/edifabric-cloud/x12-resources.html
  - https://www.edifabric.com/docs/edifabric-cloud/core-resources.html
  - https://www.edifabric.com/docs/edifabric-cloud/ncpdp-resources.html
  - https://www.edifabric.com/docs/edifabric-cloud/edifact-resources.html
  - https://www.edifabric.com/docs/getting-started/introduction.html
  - https://www.edifabric.com/edifabric-cloud.html
  - https://www.edifabric.com/edination/edi-json.html
  - https://www.edifabric.com/docs/edifabric-cloud/introduction.html
  - https://www.edifabric.com/edi-standards.html
  - https://www.edifabric.com/docs/transactions/x12-850.html
  - https://www.edifabric.com/docs/transactions/x12-810.html
  - https://www.edifabric.com/docs/transactions/x12-855.html
servers:
- url: https://api.edination.com
paths:
  /edifact/ack:
    post:
      operationId: post_edifact_ack
      tags:
      - Edifact
      summary: EDIFACT resources in the ediFabric Cloud API
      x-source: https://www.edifabric.com/docs/edifabric-cloud/edifact-resources.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostEdifactAckRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostEdifactAckResponse'
      x-evidence:
        kind: documentation
  /edifact/read:
    post:
      operationId: post_edifact_read
      tags:
      - Edifact
      summary: In Response
      x-source: https://www.edifabric.com/docs/edifabric-cloud/core-resources.html
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostEdifactReadResponse'
      x-evidence:
        kind: documentation
  /edifact/validate:
    post:
      operationId: post_edifact_validate
      tags:
      - Edifact
      summary: Response
      x-source: https://www.edifabric.com/docs/edifabric-cloud/core-resources.html
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostEdifactValidateResponse'
      x-evidence:
        kind: documentation
  /edifact/write:
    post:
      operationId: post_edifact_write
      tags:
      - Edifact
      summary: EDIFACT resources in the ediFabric Cloud API
      x-source: https://www.edifabric.com/docs/edifabric-cloud/edifact-resources.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostEdifactWriteRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /hl7/read:
    post:
      operationId: post_hl7_read
      tags:
      - Hl7
      summary: EDI API defines HL7 resources for all HL7 core items, such as control segments, interchange, group, transaction, and the validation/operation
        result, that are represented by JSON.
      x-source: https://www.edifabric.com/docs/edifabric-cloud/hl7-resources.html
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostHl7ReadResponse'
      x-evidence:
        kind: documentation
  /hl7/validate:
    post:
      operationId: post_hl7_validate
      tags:
      - Hl7
      summary: EDI API defines HL7 resources for all HL7 core items, such as control segments, interchange, group, transaction, and the validation/operation
        result, that are represented by JSON.
      x-source: https://www.edifabric.com/docs/edifabric-cloud/hl7-resources.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostHl7ValidateRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /hl7/write:
    post:
      operationId: post_hl7_write
      tags:
      - Hl7
      summary: EDI API defines HL7 resources for all HL7 core items, such as control segments, interchange, group, transaction, and the validation/operation
        result, that are represented by JSON.
      x-source: https://www.edifabric.com/docs/edifabric-cloud/hl7-resources.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostHl7WriteRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /ncpdp/read:
    post:
      operationId: post_ncpdp_read
      tags:
      - Ncpdp
      summary: Read operation returns an array of NCPDP transmissions represented as JSON.
      x-source: https://www.edifabric.com/docs/edifabric-cloud/ncpdp-resources.html
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostNcpdpReadResponse'
      x-evidence:
        kind: documentation
  /ncpdp/validate:
    post:
      operationId: post_ncpdp_validate
      tags:
      - Ncpdp
      summary: Validate operation checks that a NcpdpTransmission is compliant with NCPDP standards.
      x-source: https://www.edifabric.com/docs/edifabric-cloud/ncpdp-resources.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostNcpdpValidateRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /ncpdp/write:
    post:
      operationId: post_ncpdp_write
      tags:
      - Ncpdp
      summary: Write operation translates a NcpdpTransmission object into a NCPDP file.
      x-source: https://www.edifabric.com/docs/edifabric-cloud/ncpdp-resources.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostNcpdpWriteRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v2/x12/read:
    get:
      operationId: get_v2_x12_read
      tags:
      - X12
      summary: X12 file to JSON
      x-source: https://www.edifabric.com/docs/edifabric-cloud/introduction.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_v2_x12_read
      tags:
      - X12
      summary: POST /v2/x12/read
      x-source: https://www.edifabric.com/docs/getting-started/introduction.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://api.edination.com/v2/x12/read\"  -H \"Ocp-Apim-Subscription-Key: YOUR_SERIAL_KEY\"  -H \"Content-Type:\
          \ application/octet-stream\"  --data-binary @purchase-order.edi \n Use /write to turn JSON back into EDI, /validate to check it, and\
          \ /ack for X12 997, 999, TA1, or EDIFACT CONTRL. Treat the serial like a password and do not ship it in browser code. \n More: Introduction\
          \ to ediFabric "
  /v2/x12/validate:
    post:
      operationId: post_v2_x12_validate
      tags:
      - X12
      summary: POST /v2/x12/validate
      x-source: https://www.edifabric.com/edifabric-cloud.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -L -X POST 'https://api.edination.com/v2/x12/validate'  -H 'Ocp-Apim-Subscription-Key: YOUR_KEY'  -H 'Content-Type: application/json'\
          \  --data-binary '@/C:/purchase-order.json' \n API reference \n X12 \n EDIFACT \n HL7 \n API operations by standard \n Each standard\
          \ has the same read, write, validate and acknowledge operations. Open the reference for the one you are on. \n X12 \n View operations\
          \ \n EDIF"
  /v2/x12/write:
    post:
      operationId: post_v2_x12_write
      tags:
      - X12
      summary: POST /v2/x12/write
      x-source: https://www.edifabric.com/edifabric-cloud.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -L -X POST 'https://api.edination.com/v2/x12/write'  -H 'Ocp-Apim-Subscription-Key: YOUR_KEY'  -H 'Content-Type: application/json'\
          \  --data-binary '@/C:/purchase-order.json' \n API reference \n X12 \n EDIFACT \n HL7 "
  /vda/read:
    post:
      operationId: post_vda_read
      tags:
      - Vda
      summary: EDI API defines VDA resources for all VDA messages, batches, and the validation/operation result, that are represented by JSON.
      x-source: https://www.edifabric.com/docs/edifabric-cloud/vda-resources.html
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostVdaReadResponse'
      x-evidence:
        kind: documentation
  /vda/validate:
    post:
      operationId: post_vda_validate
      tags:
      - Vda
      summary: EDI API defines VDA resources for all VDA messages, batches, and the validation/operation result, that are represented by JSON.
      x-source: https://www.edifabric.com/docs/edifabric-cloud/vda-resources.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostVdaValidateRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /vda/write:
    post:
      operationId: post_vda_write
      tags:
      - Vda
      summary: EDI API defines VDA resources for all VDA messages, batches, and the validation/operation result, that are represented by JSON.
      x-source: https://www.edifabric.com/docs/edifabric-cloud/vda-resources.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostVdaWriteRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /x12/ack:
    post:
      operationId: post_x12_ack
      tags:
      - X12
      summary: X12 Resources
      x-source: https://www.edifabric.com/docs/edifabric-cloud/x12-resources.html
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostX12AckRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostX12AckResponse'
      x-evidence:
        kind: documentation
  /x12/read:
    post:
      operationId: post_x12_read
      tags:
      - X12
      summary: X12 Resources
      x-source: https://www.edifabric.com/docs/edifabric-cloud/x12-resources.html
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostX12ReadResponse'
      x-evidence:
        kind: documentation
  /x12/validate:
    post:
      operationId: post_x12_validate
      tags:
      - X12
      summary: X12 Resources
      x-source: https://www.edifabric.com/docs/edifabric-cloud/x12-resources.html
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostX12ValidateRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /x12/write:
    post:
      operationId: post_x12_write
      tags:
      - X12
      summary: X12 Resources
      x-source: https://www.edifabric.com/docs/edifabric-cloud/x12-resources.html
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostX12WriteRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostEdifactAckRequest:
      type: object
      properties:
        EdifactInterchange:
          type: object
          description: EdifactInterchange object used with the Ack operation to generate technical and/or functional CONTRL acknowledgment.
      required:
      - EdifactInterchange
    PostEdifactAckResponse:
      type: object
      properties:
        EdifactInterchange:
          type: object
          description: EdifactInterchange object returned with acknowledgment details.
    PostEdifactReadResponse:
      type: object
      properties:
        LastIndex:
          type: integer
          description: The index of the last segment in the interchange, starting from the ISA. When multiple interchanges are present, the index
            starts from the first ISA of the first interchange. It is 1 based.
        Status:
          type: string
          description: 'The status of the Read or Validation operation. Values: success, warning, error.'
        Details:
          type: array
          description: The list of validation or translation errors and warnings if any.
    PostEdifactValidateResponse:
      type: object
      properties:
        LastIndex:
          type: integer
          description: The index of the last segment in the interchange, starting from the ISA. When multiple interchanges are present, the index
            starts from the first ISA of the first interchange. It is 1 based.
        Status:
          type: string
          description: 'The status of the Read or Validation operation. Values: success, warning, error.'
        Details:
          type: array
          description: The list of validation or translation errors and warnings if any.
    PostEdifactWriteRequest:
      type: object
      properties:
        EdifactInterchange:
          type: object
          description: EdifactInterchange object used with the Write operation to translate it into an EDIFACT file.
      required:
      - EdifactInterchange
    PostHl7ReadResponse:
      type: object
      properties:
        Hl7Interchange[]:
          type: string
          description: Array of HL7 interchange objects returned by the Read operation.
    PostHl7ValidateRequest:
      type: object
      properties:
        Hl7Interchange:
          type: string
          description: HL7 interchange object to be validated for compliance.
      required:
      - Hl7Interchange
    PostHl7WriteRequest:
      type: object
      properties:
        Hl7Interchange:
          type: string
          description: HL7 interchange object to be translated into an HL7 file.
      required:
      - Hl7Interchange
    PostNcpdpReadResponse:
      type: object
      properties:
        NcpdpTransmission[]:
          type: array
          description: Array of NcpdpTransmission objects representing the read NCPDP file.
    PostNcpdpValidateRequest:
      type: object
      properties:
        TransmissionHeader:
          type: object
          description: Header segment for batch transmissions.
        Transactions:
          type: array
          description: List of transaction objects, each starting with a G1 segment.
        TransmissionTrailer:
          type: object
          description: Trailer segment for batch transmissions.
        Model:
          type: string
          description: Model identifier, e.g., "EdiNation.NCPDP.TELCO.D0".
      required:
      - Transactions
    PostNcpdpWriteRequest:
      type: object
      properties:
        TransmissionHeader:
          type: object
          description: Header segment for batch transmissions.
        Transactions:
          type: array
          description: List of transaction objects, each starting with a G1 segment.
        TransmissionTrailer:
          type: object
          description: Trailer segment for batch transmissions.
        Model:
          type: string
          description: Model identifier, e.g., "EdiNation.NCPDP.TELCO.D0".
      required:
      - Transactions
    PostVdaReadResponse:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the header segment
        Value:
          type: object
          description: Transaction object – any type that represents a transaction which is also recognized as a model by EdiNation.
        Result:
          type: object
          description: OperationResult object
    PostVdaValidateRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the header segment
        Value:
          type: object
          description: Transaction object – any type that represents a transaction which is also recognized as a model by EdiNation.
        Result:
          type: object
          description: OperationResult object
      required:
      - Id
      - Value
      - Result
    PostVdaWriteRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the header segment
        Value:
          type: object
          description: Transaction object – any type that represents a transaction which is also recognized as a model by EdiNation.
        Result:
          type: object
          description: OperationResult object
      required:
      - Id
      - Value
      - Result
    PostX12AckRequest:
      type: object
      properties:
        SegmentDelimiter:
          type: string
          description: The value of ISA16.
        DataElementDelimiter:
          type: string
          description: The value at position 4 in the ISA segment.
        ISA:
          type: object
          description: The ISA segment.
        Groups:
          type: array
          description: The list of functional groups.
        IEATrailers:
          type: array
          description: The list of interchange trailers.
    PostX12AckResponse:
      type: object
      properties:
        SegmentDelimiter:
          type: string
          description: The value of ISA16.
        DataElementDelimiter:
          type: string
          description: The value at position 4 in the ISA segment.
        ISA:
          type: object
          description: The ISA segment.
        TA1:
          type: object
          description: The TA1 segment. Included only when the X12Interchange is the result of an acknowledgment (997 or 999) operation.
        Groups:
          type: array
          description: The list of functional groups.
        IEATrailers:
          type: array
          description: The list of interchange trailers.
        Result:
          type: object
          description: The operation result.
    PostX12ReadResponse:
      type: object
      properties:
        SegmentDelimiter:
          type: string
          description: The value of ISA16.
        DataElementDelimiter:
          type: string
          description: The value at position 4 in the ISA segment.
        ISA:
          type: object
          description: The ISA segment.
        TA1:
          type: object
          description: The TA1 segment. Included only when the X12Interchange is the result of an acknowledgment (997 or 999) operation.
        Groups:
          type: array
          description: The list of functional groups.
        IEATrailers:
          type: array
          description: The list of interchange trailers. Always contains one item for valid interchanges.
        Result:
          type: object
          description: The operation result.
    PostX12ValidateRequest:
      type: object
      properties:
        SegmentDelimiter:
          type: string
          description: The value of ISA16.
        DataElementDelimiter:
          type: string
          description: The value at position 4 in the ISA segment.
        ISA:
          type: object
          description: The ISA segment.
        Groups:
          type: array
          description: The list of functional groups.
        IEATrailers:
          type: array
          description: The list of interchange trailers.
    PostX12WriteRequest:
      type: object
      properties:
        SegmentDelimiter:
          type: string
          description: The value of ISA16.
        DataElementDelimiter:
          type: string
          description: The value at position 4 in the ISA segment.
        ISA:
          type: object
          description: The ISA segment.
        Groups:
          type: array
          description: The list of functional groups.
        IEATrailers:
          type: array
          description: The list of interchange trailers.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Ocp-Apim-Subscription-Key
security:
- apiKey: []
tags:
- name: Edifact
- name: Hl7
- name: Ncpdp
- name: Vda
- name: X12