Transaction

Poll transactions

This endpoint is used to regularly poll for new transactions that have been processed in Core.

You must define one of startDateTime or pageToken when making a request.

You may optionally define a pageSize. The minimum pageSize is 1, and the maximum pageSize is 1000. The default is 100.

startDateTime takes a string in ISO 8601 format. (ex: 2023-08-10T18:00:00Z). startDateTime must be set to at least 1 minute in the past.

The results will contain transactions that occurred after this startDateTime. Starting from the oldest to newest transactions ordered by the processedAt field. Note, this is exclusive of the startDateTime, a transaction occuring at exactly 2023-08-10T18:00:00Z for instance, would not be included. In addition, there is a 15 second window where newly created transactions will not be included to account for any network latency or clock drifts within the systems to ensure you do not miss any transactions.

Each request will always return a nextPageToken, regardless of whether there are new transactions or not.

We DO NOT recommend trying to roll your own polling strategy leveraging startDateTime only. There are edge cases around two transactions occuring at the exact same time and being on the edge of a pagination which could cause you to miss one due to the exclusive nature of startDateTime. We recommend using pageToken’s instead.

When making subsequent polling requests (not initiating with startDateTime), the pageToken can be used to continue iterating through pages of transactions. Usage of the pageToken guaruntees you will not miss any transactions on the stream. If at any point there are no more new transactions in the item array, you will still receive a nextPageToken. Continue to use this token to poll for new transactions. Once there are new transactions, they will be returned in the item array.

pageToken’s you have retrieved can serve as checkpoints. They do not expire, and you can always start from that point in the transaction stream again if you need to catch a system up or recover from a failure. Storing pageToken’s as part of your polling process is encouraged.

pageToken’s are unique per request, opaque, and should not be parsed or modified in any way. They are not guaranteed to be in any particular format, and may change in the future.

GET

polling

transactions

  curl --request GET -L \
    --url https://core.us.stedi.com/2023-08-01/polling/transactions?startDateTime=2023-08-28T00:00:00Z \
    --header "Authorization: ${STEDI_API_KEY}" 

{
  "items": [
    {
      "direction": "OUTBOUND",
      "mode": "production",
      "fileExecutionId": "f75168e4-e682-4410-bfec-b5b1541c7f21",
      "transactionId": "a15b68ca-fae0-42de-b8a3-f436668b8604",
      "processedAt": "2023-08-28T09:00:28.354Z",
      "artifacts": [
        {
          "artifactType": "application/json",
          "sizeBytes": 490,
          "usage": "input",
          "url": "https://core.us.stedi.com/2023-08-01/transactions/a15b68ca-fae0-42de-b8a3-f436668b8604/input"
        },
        {
          "artifactType": "application/edi-x12",
          "sizeBytes": 51,
          "usage": "output",
          "url": "https://core.us.stedi.com/2023-08-01/transactions/a15b68ca-fae0-42de-b8a3-f436668b8604/output"
        }
      ],
      "partnership": {
        "partnershipId": "i-am-another-merch_this-is-me",
        "partnershipType": "x12",
        "sender": {
          "profileId": "i-am-another-merch"
        },
        "receiver": {
          "profileId": "this-is-me"
        }
      },
      "businessIdentifiers": [
       {
         "element": "PRF-01",
         "name": "Purchase Order Number",
         "value": "T000HNb4d"
       }
      ],
      "x12": {
        "metadata": {
          "interchange": {
            "acknowledgmentRequestedCode": "1",
            "controlNumber": 2
          },
          "functionalGroup": {
            "controlNumber": 2,
            "release": "008010",
            "date": "2023-08-28",
            "time": "09:00:20",
            "functionalIdentifierCode": "PO"
          },
          "transaction": {
            "controlNumber": "1",
            "transactionSetIdentifier": "850"
          },
          "receiver": {
            "applicationCode": "THISISME",
            "isa": {
              "qualifier": "ZZ",
              "id": "THISISME"
            }
          },
          "sender": {
            "applicationCode": "ANOTHERMERCH",
            "isa": {
              "qualifier": "14",
              "id": "ANOTHERMERCH"
            }
          }
        },
        "transactionSetting": {
          "guideId": "01H8PSWG4ZD6QPKC9VSD42PQX3",
          "transactionSettingId": "005010-850"
        }
      }
    }
  ],
  "nextPageToken": "945ff6de213d3ef481d028065d4c12fb996a166a3a90ef98564318decfae50ce4b36d74b7e9d9bafa6e1d169"
}

  curl --request GET -L \
    --url https://core.us.stedi.com/2023-08-01/polling/transactions?startDateTime=2023-08-28T00:00:00Z \
    --header "Authorization: ${STEDI_API_KEY}" 

{
  "items": [
    {
      "direction": "OUTBOUND",
      "mode": "production",
      "fileExecutionId": "f75168e4-e682-4410-bfec-b5b1541c7f21",
      "transactionId": "a15b68ca-fae0-42de-b8a3-f436668b8604",
      "processedAt": "2023-08-28T09:00:28.354Z",
      "artifacts": [
        {
          "artifactType": "application/json",
          "sizeBytes": 490,
          "usage": "input",
          "url": "https://core.us.stedi.com/2023-08-01/transactions/a15b68ca-fae0-42de-b8a3-f436668b8604/input"
        },
        {
          "artifactType": "application/edi-x12",
          "sizeBytes": 51,
          "usage": "output",
          "url": "https://core.us.stedi.com/2023-08-01/transactions/a15b68ca-fae0-42de-b8a3-f436668b8604/output"
        }
      ],
      "partnership": {
        "partnershipId": "i-am-another-merch_this-is-me",
        "partnershipType": "x12",
        "sender": {
          "profileId": "i-am-another-merch"
        },
        "receiver": {
          "profileId": "this-is-me"
        }
      },
      "businessIdentifiers": [
       {
         "element": "PRF-01",
         "name": "Purchase Order Number",
         "value": "T000HNb4d"
       }
      ],
      "x12": {
        "metadata": {
          "interchange": {
            "acknowledgmentRequestedCode": "1",
            "controlNumber": 2
          },
          "functionalGroup": {
            "controlNumber": 2,
            "release": "008010",
            "date": "2023-08-28",
            "time": "09:00:20",
            "functionalIdentifierCode": "PO"
          },
          "transaction": {
            "controlNumber": "1",
            "transactionSetIdentifier": "850"
          },
          "receiver": {
            "applicationCode": "THISISME",
            "isa": {
              "qualifier": "ZZ",
              "id": "THISISME"
            }
          },
          "sender": {
            "applicationCode": "ANOTHERMERCH",
            "isa": {
              "qualifier": "14",
              "id": "ANOTHERMERCH"
            }
          }
        },
        "transactionSetting": {
          "guideId": "01H8PSWG4ZD6QPKC9VSD42PQX3",
          "transactionSettingId": "005010-850"
        }
      }
    }
  ],
  "nextPageToken": "945ff6de213d3ef481d028065d4c12fb996a166a3a90ef98564318decfae50ce4b36d74b7e9d9bafa6e1d169"
}

Authorizations

Authorization

string

header

required

A Stedi API Key for authentication.

Query Parameters

pageSize

number

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.

Required range: x >= 1

pageToken

string

A token returned by a previous call to this operation in the nextPageToken. If not specified, Stedi returns the first page of results.

Required string length: 1 - 1024

startDateTime

string

An ISO 8601 formatted string. For example 2023-08-28T00:00:00Z. Stedi returns transactions processed after this time.

Response

200

application/json

ListPollingTransactions 200 response

items

object[]

required

items.transactionId

string

required

A unique identifier for the processed transaction within Stedi. This ID is included in the transaction.processed.v2 event, or you can retrieve it manually from the transaction's details page within the Stedi app.

items.fileExecutionId

string

required

items.status

enum<string>

required

Available options:

failed,

succeeded

items.direction

enum<string>

required

Available options:

INBOUND,

OUTBOUND,

UNKNOWN

items.mode

enum<string>

required

Available options:

test,

production,

other

items.processedAt

string

required

items.artifacts

object[]

required

items.partnership

object

required

items.x12

object

items.fragments

object

items.translationErrors

object[]

items.businessIdentifiers

object[]

items.operation

string

nextPageToken

string

The token used for pagination

Required string length: 1 - 1024

Was this page helpful?

List transactions Transaction

  curl --request GET -L \
    --url https://core.us.stedi.com/2023-08-01/polling/transactions?startDateTime=2023-08-28T00:00:00Z \
    --header "Authorization: ${STEDI_API_KEY}" 

{
  "items": [
    {
      "direction": "OUTBOUND",
      "mode": "production",
      "fileExecutionId": "f75168e4-e682-4410-bfec-b5b1541c7f21",
      "transactionId": "a15b68ca-fae0-42de-b8a3-f436668b8604",
      "processedAt": "2023-08-28T09:00:28.354Z",
      "artifacts": [
        {
          "artifactType": "application/json",
          "sizeBytes": 490,
          "usage": "input",
          "url": "https://core.us.stedi.com/2023-08-01/transactions/a15b68ca-fae0-42de-b8a3-f436668b8604/input"
        },
        {
          "artifactType": "application/edi-x12",
          "sizeBytes": 51,
          "usage": "output",
          "url": "https://core.us.stedi.com/2023-08-01/transactions/a15b68ca-fae0-42de-b8a3-f436668b8604/output"
        }
      ],
      "partnership": {
        "partnershipId": "i-am-another-merch_this-is-me",
        "partnershipType": "x12",
        "sender": {
          "profileId": "i-am-another-merch"
        },
        "receiver": {
          "profileId": "this-is-me"
        }
      },
      "businessIdentifiers": [
       {
         "element": "PRF-01",
         "name": "Purchase Order Number",
         "value": "T000HNb4d"
       }
      ],
      "x12": {
        "metadata": {
          "interchange": {
            "acknowledgmentRequestedCode": "1",
            "controlNumber": 2
          },
          "functionalGroup": {
            "controlNumber": 2,
            "release": "008010",
            "date": "2023-08-28",
            "time": "09:00:20",
            "functionalIdentifierCode": "PO"
          },
          "transaction": {
            "controlNumber": "1",
            "transactionSetIdentifier": "850"
          },
          "receiver": {
            "applicationCode": "THISISME",
            "isa": {
              "qualifier": "ZZ",
              "id": "THISISME"
            }
          },
          "sender": {
            "applicationCode": "ANOTHERMERCH",
            "isa": {
              "qualifier": "14",
              "id": "ANOTHERMERCH"
            }
          }
        },
        "transactionSetting": {
          "guideId": "01H8PSWG4ZD6QPKC9VSD42PQX3",
          "transactionSettingId": "005010-850"
        }
      }
    }
  ],
  "nextPageToken": "945ff6de213d3ef481d028065d4c12fb996a166a3a90ef98564318decfae50ce4b36d74b7e9d9bafa6e1d169"
}

Healthcare

EDI platform

Poll transactions

Authorizations

Query Parameters

Response