Stedi Transactions API

openapi: 3.2.0
info:
  title: Core Transactions API
  version: '2023-08-01'
  contact:
    email: core@stedi.com
  license:
    name: Proprietary
    url: https://stedi.com
servers:
- url: https://core.us.stedi.com/2023-08-01
  description: Production
security:
- httpApiKeyAuth: []
tags:
- name: Transactions
paths:
  /transactions:
    get:
      description: Fetch a list of transactions, sorted by the date they were created from newest to oldest.
      operationId: ListTransactions
      parameters:
      - name: pageSize
        in: query
        description: The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.
        schema:
          type: number
          maximum: 500
          minimum: 1
          description: The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.
        examples:
          ListTransactions_example1:
            summary: List transactions
            description: ''
            value: 200
      - name: pageToken
        in: query
        description: A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results.
        schema:
          type: string
          maxLength: 1024
          minLength: 1
          description: A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results.
      - name: businessIdentifier
        in: query
        description: List only transactions containing a business identifier with the given value.
        schema:
          type: string
          description: List only transactions containing a business identifier with the given value.
      - name: transactionSetId
        in: query
        description: 'List only a given type of transaction. Accepts any valid 3-digit X12 Transaction Set Identifier Code, as defined in the X12 standard. See: <https://www.stedi.com/edi/x12/element/143>.'
        schema:
          $ref: '#/components/schemas/X12TransactionSetIdentifierCode'
      - name: sender
        in: query
        description: List only transactions sent by the given profile. This is the profile ID of the sender.
        schema:
          type: string
          description: List only transactions sent by the given profile. This is the profile ID of the sender.
      - name: receiver
        in: query
        description: List only transactions sent to the given profile. This is the profile ID of the receiver.
        schema:
          type: string
          description: List only transactions sent to the given profile. This is the profile ID of the receiver.
      - name: direction
        in: query
        description: The direction of the transaction. Inbound transactions are those you receive from a payer, provider, or other trading partner. Outbound transactions are those you send to a payer, provider, or other trading partner.
        schema:
          $ref: '#/components/schemas/Direction'
      - name: mode
        in: query
        description: 'Indicates whether the transaction contains test or production data. Stedi determines this from the value in [`ISA15` Usage Indicator Code](https://www.stedi.com/edi/x12/segment/ISA#ISA-15). '
        schema:
          $ref: '#/components/schemas/Mode'
      - name: status
        in: query
        description: A status indicating whether Stedi was able to successfully process the transaction.
        schema:
          $ref: '#/components/schemas/TransactionStatus'
      - name: from
        in: query
        description: The start of the time range to filter transactions. The results will include transactions created at or after this timestamp.
        schema:
          type: string
          description: The start of the time range to filter transactions. The results will include transactions created at or after this timestamp.
          format: date-time
      - name: to
        in: query
        description: The end of the time range to filter transactions. The results will include transactions up to and including this timestamp.
        schema:
          type: string
          description: The end of the time range to filter transactions. The results will include transactions up to and including this timestamp.
          format: date-time
      - name: elementId
        in: query
        description: List only transactions containing a business identifier with the given element ID. This is the X12 element ID, such as "127" for Reference Identification. May only be supplied if `businessIdentifier` is also supplied. See Stedi's EDI references pages to find element IDs.
        schema:
          type: string
          description: List only transactions containing a business identifier with the given element ID. This is the X12 element ID, such as "127" for Reference Identification. May only be supplied if `businessIdentifier` is also supplied. See Stedi's EDI references pages to find element IDs.
      - name: partnershipId
        in: query
        description: List only transactions that were sent or received on the given partnership. This is the partnership ID, such as "local_clearinghouse-test".
        schema:
          type: string
          description: List only transactions that were sent or received on the given partnership. This is the partnership ID, such as "local_clearinghouse-test".
      responses:
        '200':
          description: ListTransactions 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransactionsResponseContent'
              examples:
                ListTransactions_example1:
                  summary: List transactions
                  description: ''
                  value:
                    items:
                    - direction: INBOUND
                      mode: test
                      status: succeeded
                      fileExecutionId: 95236a56-a020-4522-8fef-bcffcec0ec1d
                      transactionId: c8dd3a67-b8ca-4b0e-aa73-e0de82414b8f
                      processedAt: '2025-04-02T21:30:15.801Z'
                      artifacts:
                      - artifactType: application/edi-x12
                        sizeBytes: 8374
                        model: transaction
                        usage: input
                        url: https://core.us.stedi.com/2023-08-01/transactions/112233344-b8ca-4h1e-aa73-123482414b8f/input
                      - artifactType: application/json
                        sizeBytes: 76898
                        model: transaction
                        usage: output
                        url: https://core.us.stedi.com/2023-08-01/transactions/1115555-b8ca-1234-aa73-e0je82414hb8f/output
                      partnership:
                        partnershipId: stedi_test-sender
                        partnershipType: x12
                        sender:
                          profileId: test-sender
                        receiver:
                          profileId: stedi
                      businessIdentifiers:
                      - elementId: '127'
                        element: BHT-03
                        name: Reference Identification
                        value: XXXXXX
                      x12:
                        metadata:
                          interchange:
                            acknowledgmentRequestedCode: '0'
                            controlNumber: 1
                          functionalGroup:
                            controlNumber: 1
                            release: 005010X222A1
                            date: '2025-04-02'
                            time: '21:29:57'
                            functionalIdentifierCode: HC
                          transaction:
                            controlNumber: '0001'
                            transactionSetIdentifier: '837'
                          receiver:
                            applicationCode: STEDI-TEST
                            isa:
                              qualifier: ZZ
                              id: STEDI-TEST
                          sender:
                            applicationCode: TestSender
                            isa:
                              qualifier: ZZ
                              id: TestSender
                        transactionSetting:
                          guideId: 01JQW6E5RSBSTKS3ZQ1SPR4019
                          transactionSettingId: 01JQW6E72Q3HDXM40YYAQCBZDY
                    nextPageToken: be08e5ba4bf36da9da27dcb651e64a6e5502685499994f354
        '400':
          description: BadRequestException 400 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestExceptionResponseContent'
        '401':
          description: UnauthorizedException 401 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
        '403':
          description: AccessDeniedException 403 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
        '404':
          description: ResourceNotFoundException 404 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
        '409':
          description: ResourceUnderChangeException 409 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
        '422':
          description: UnprocessableEntityException 422 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
        '429':
          description: ThrottlingException 429 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingExceptionResponseContent'
        '500':
          description: ServiceException 500 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceExceptionResponseContent'
        '503':
          description: ServiceUnavailableException 503 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
        '504':
          description: GatewayTimeoutException 504 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
      tags:
      - Transactions
  /transactions/{transactionId}:
    get:
      description: Fetch details for a specific transaction.
      operationId: GetTransaction
      parameters:
      - name: transactionId
        in: path
        description: A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal.
        schema:
          type: string
          description: A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal.
        required: true
        examples:
          GetTransaction_example1:
            summary: List transactions
            description: ''
            value: a15b68ca-fae0-42de-b8a3-f436668b8604
      responses:
        '200':
          description: GetTransaction 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTransactionResponseContent'
              examples:
                GetTransaction_example1:
                  summary: List transactions
                  description: ''
                  value:
                    direction: INBOUND
                    mode: test
                    status: succeeded
                    fileExecutionId: 95236a56-a020-4522-8fef-bcffcec0ec1d
                    transactionId: c8dd3a67-b8ca-4b0e-aa73-e0de82414b8f
                    processedAt: '2025-04-02T21:30:15.801Z'
                    artifacts:
                    - artifactType: application/edi-x12
                      sizeBytes: 8374
                      model: transaction
                      usage: input
                      url: https://core.us.stedi.com/2023-08-01/transactions/c8dd1111-b8ca-4330e-aa73-e0de33314b8f/input
                    - artifactType: application/json
                      sizeBytes: 76898
                      model: transaction
                      usage: output
                      url: https://core.us.stedi.com/2023-08-01/transactions/c8dd3a67-b8ca-4b0e-kk73-55667882414b8f/output
                    partnership:
                      partnershipId: stedi_test-sender
                      partnershipType: x12
                      sender:
                        profileId: test-sender
                      receiver:
                        profileId: stedi
                    businessIdentifiers:
                    - elementId: '127'
                      element: BHT-03
                      name: Reference Identification
                      value: XXXXXX
                    x12:
                      metadata:
                        interchange:
                          acknowledgmentRequestedCode: '0'
                          controlNumber: 1
                        functionalGroup:
                          controlNumber: 1
                          release: 005010X222A1
                          date: '2025-04-02'
                          time: '21:29:57'
                          functionalIdentifierCode: HC
                        transaction:
                          controlNumber: '0001'
                          transactionSetIdentifier: '837'
                        receiver:
                          applicationCode: STEDI-TEST
                          isa:
                            qualifier: ZZ
                            id: STEDI-TEST
                        sender:
                          applicationCode: TestSender
                          isa:
                            qualifier: ZZ
                            id: TestSender
                      transactionSetting:
                        guideId: 01JQW6E5RSBSTKS3ZQ1SPR4019
                        transactionSettingId: 01JQW6E72Q3HDXM40YYAQCBZDY
        '400':
          description: BadRequestException 400 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestExceptionResponseContent'
        '401':
          description: UnauthorizedException 401 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
        '403':
          description: AccessDeniedException 403 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
        '404':
          description: ResourceNotFoundException 404 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
        '409':
          description: ResourceUnderChangeException 409 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
        '422':
          description: UnprocessableEntityException 422 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
        '429':
          description: ThrottlingException 429 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingExceptionResponseContent'
        '500':
          description: ServiceException 500 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceExceptionResponseContent'
        '503':
          description: ServiceUnavailableException 503 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
        '504':
          description: GatewayTimeoutException 504 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
      tags:
      - Transactions
  /transactions/{transactionId}/attachment/{artifactId}:
    get:
      description: Retrieve a transaction's output document.
      operationId: GetTransactionAttachmentDocument
      parameters:
      - name: transactionId
        in: path
        description: A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event, or you can retrieve it manually from the transaction's details page within the Stedi portal.
        schema:
          type: string
          description: A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event, or you can retrieve it manually from the transaction's details page within the Stedi portal.
        required: true
        examples:
          GetTransactionAttachmentDocument_example1:
            summary: Get transaction attachment document
            description: ''
            value: c8dd3a67-b8ca-4b0e-aa73-e0de82414b8f
      - name: artifactId
        in: path
        description: A unique identifier for the artifact within Stedi. This ID is included in the transaction processed event, or you can retrieve it manually from the transaction's details page within the Stedi portal.
        schema:
          type: string
          description: A unique identifier for the artifact within Stedi. This ID is included in the transaction processed event, or you can retrieve it manually from the transaction's details page within the Stedi portal.
        required: true
        examples:
          GetTransactionAttachmentDocument_example1:
            summary: Get transaction attachment document
            description: ''
            value: e0de82414b8f-b8ca-4b0e-aa73-c8dd3a67
      responses:
        '302':
          description: GetTransactionAttachmentDocument 302 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTransactionAttachmentDocumentResponseContent'
              examples:
                GetTransactionAttachmentDocument_example1:
                  summary: Get transaction attachment document
                  description: ''
                  value:
                    documentDownloadUrl: https://stedi-default-core-artifacts.s3.us-east-1.amazonaws.com/55907f88-999e-4912-9e9...
        '400':
          description: BadRequestException 400 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestExceptionResponseContent'
        '401':
          description: UnauthorizedException 401 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
        '403':
          description: AccessDeniedException 403 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
        '404':
          description: ResourceNotFoundException 404 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
        '409':
          description: ResourceUnderChangeException 409 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
        '422':
          description: UnprocessableEntityException 422 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
        '429':
          description: ThrottlingException 429 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingExceptionResponseContent'
        '500':
          description: ServiceException 500 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceExceptionResponseContent'
        '503':
          description: ServiceUnavailableException 503 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
        '504':
          description: GatewayTimeoutException 504 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
      tags:
      - Transactions
  /transactions/{transactionId}/attachment/{artifactId}/url:
    get:
      description: 'This endpoint is used to retrieve a transaction''s attachment document url.


        This endpoint returns the document download URL, it must be then fetched for the actual document content. There are no size restrictions on documents when fetching from this endpoint.

        '
      operationId: GetTransactionAttachmentDocumentUrl
      parameters:
      - name: transactionId
        in: path
        description: A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal.
        schema:
          type: string
          description: A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal.
        required: true
        examples:
          GetTransactionAttachmentDocumentUrl_example1:
            summary: Get transaction output document url
            description: ''
            value: 06bdccdc-4aaa-4aaa-4aaa-abaa11110000
      - name: artifactId
        in: path
        schema:
          type: string
        required: true
        examples:
          GetTransactionAttachmentDocumentUrl_example1:
            summary: Get transaction output document url
            description: ''
            value: abaa11110000-4aaa-4aaa-4aaa-06bdccdc
      responses:
        '200':
          description: GetTransactionAttachmentDocumentUrl 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTransactionAttachmentDocumentUrlResponseContent'
              examples:
                GetTransactionAttachmentDocumentUrl_example1:
                  summary: Get transaction output document url
                  description: ''
                  value:
                    documentDownloadUrl: https://stedi-default-core-artifacts.s3.us-east-1.amazonaws.com/...
        '400':
          description: BadRequestException 400 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestExceptionResponseContent'
        '401':
          description: UnauthorizedException 401 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
        '403':
          description: AccessDeniedException 403 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
        '404':
          description: ResourceNotFoundException 404 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
        '409':
          description: ResourceUnderChangeException 409 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
        '422':
          description: UnprocessableEntityException 422 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
        '429':
          description: ThrottlingException 429 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingExceptionResponseContent'
        '500':
          description: ServiceException 500 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceExceptionResponseContent'
        '503':
          description: ServiceUnavailableException 503 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableExceptionResponseContent'
        '504':
          description: GatewayTimeoutException 504 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutExceptionResponseContent'
      tags:
      - Transactions
  /transactions/{transactionId}/fragments/{fragmentIndex}:
    get:
      description: Retrieve metadata for a fragment.
      operationId: GetTransactionFragment
      parameters:
      - name: transactionId
        in: path
        description: A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal.
        schema:
          type: string
          description: A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal.
        required: true
        examples:
          GetTransactionFragment_example1:
            summary: Get fragment
            description: ''
            value: a15b68ca-fae0-42de-b8a3-f436668b8604
      - name: fragmentIndex
        in: path
        description: The identifier for a specific fragment within a processed transaction. This ID is included in the fragment processed event, or you can retrieve it manually from the transaction's details page within the Stedi portal.
        schema:
          type: number
          description: The identifier for a specific fragment within a processed transaction. This ID is included in the fragment processed event, or you can retrieve it manually from the transaction's details page within the Stedi portal.
        required: true
        examples:
          GetTransactionFragment_example1:
            summary: Get fragment
            description: ''
            value: 1
      responses:
        '200':
          description: GetTransactionFragment 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTransactionFragmentResponseContent'
              examples:
                GetTransactionFragment_example1:
                  summary: Get fragment
                  description: ''
                  value:
                    direction: INBOUND
                    mode: production
                    fileExecutionId: 29d6b95d-c611-bce6-b893-0e64821cd238
                    transactionId: 7d0c6f84-4cec-4f4a-a681-e7a36eb48d25
                    processedAt: '2023-10-12T15:34:01.435Z'
                    partnership:
                      partnershipId: me_another-merch
                      partnershipType: x12
                      sender:
                        profileId: merch
                      receiver:
                        profileId: me
                    x12:
                      metadata:
                        interchange:
                          acknowledgmentRequestedCode: '0'
                          controlNumber: 103
                        functionalGroup:
                          controlNumber: 103
                          release: 005010X220A1
                          date: '2004-12-27'
                          time: '13:24'
                          functionalIdentifierCode: BE
                        transaction:
                          controlNumber: '13331'
                          transactionSetIdentifier: '846'
                        receiver:
                          applicationCode: THISISME
                          isa:
                            qualifier: '02'
                            id: THISISME
                        sender:
                          applicationCode: ANOTHERMERCH
                          isa:
                            qualifier: '02'
                            id: ANOTHERMERCH
                      transactionSetting:
                        guideId: 01HAPYY1YPFWGVJH1HD75SP0A2
                        transactionSettingId: 01HCAHP7PY84DBZG0FM5JB4MCE
                    fragments:
                      batchSize: 800
                      keyName: item_identification_LIN_loop
                      fragmentCount: 1065
                    fragmentIndex: 0
                    artifacts:
                    - artifactType: application/json
                      sizeBytes: 389388
                      model: fragment
                      usage: output
                      url: https://core.us.stedi.com/2023-08-01/transactions/7d0c6f84-4cec-4f4a-a681-e7a36eb48d25/fragments/0/output
                    transactionUrl: https://core.us.stedi.com/2023-08-01/transactions/7d0c6f84-4cec-4f4a-a681-e7a36eb48d25
        '400':
          description: BadRequestException 400 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestExceptionResponseContent'
        '401':
          description: UnauthorizedException 401 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedExceptionResponseContent'
        '403':
          description: AccessDeniedException 403 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedExceptionResponseContent'
        '404':
          description: ResourceNotFoundException 404 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundExceptionResponseContent'
        '409':
          description: ResourceUnderChangeException 409 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnderChangeExceptionResponseContent'
        '422':
          description: UnprocessableEntityException 422 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityExceptionResponseContent'
        '429':
          description: ThrottlingException 429 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingExceptionResponseContent'
        '500':
          description: ServiceException 500 response
          content:
            application/json:
              schema:
                $ref: '#/components/s

# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stedi/refs/heads/main/openapi/stedi-transactions-api-openapi.yml