GET
/
polling
/
transactions
curl --request GET \
  --url https://core.us.stedi.com/2023-08-01/polling/transactions \
  --header 'Authorization: <api-key>'
{
  "nextPageToken": "<string>",
  "items": [
    {
      "transactionId": "<string>",
      "fileExecutionId": "<string>",
      "status": "failed",
      "direction": "INBOUND",
      "mode": "test",
      "processedAt": "2023-11-07T05:31:56Z",
      "artifacts": [
        {
          "artifactType": "text/csv",
          "usage": "attachment",
          "sizeBytes": 123,
          "url": "<string>",
          "model": "execution"
        }
      ],
      "partnership": {
        "partnershipId": "<string>",
        "partnershipType": "x12",
        "sender": {
          "profileId": "<string>"
        },
        "receiver": {
          "profileId": "<string>"
        }
      },
      "x12": {
        "metadata": {
          "interchange": {
            "acknowledgmentRequestedCode": "<string>",
            "controlNumber": 499999999.5
          },
          "functionalGroup": {
            "controlNumber": 499999999.5,
            "date": "<string>",
            "functionalIdentifierCode": "<string>",
            "time": "<string>",
            "release": "<string>"
          },
          "transaction": {
            "controlNumber": "<string>",
            "transactionSetIdentifier": "<string>"
          },
          "sender": {
            "applicationCode": "<string>",
            "isa": {
              "qualifier": "<string>",
              "id": "<string>"
            }
          },
          "receiver": {
            "applicationCode": "<string>",
            "isa": {
              "qualifier": "<string>",
              "id": "<string>"
            }
          }
        },
        "transactionSetting": {
          "guideId": "<string>",
          "transactionSettingId": "<string>"
        }
      },
      "fragments": {
        "keyName": "<string>",
        "fragmentCount": 123,
        "batchSize": 123
      },
      "translationErrors": [
        {
          "context": {
            "code": "<string>",
            "schemaPath": "<string>"
          },
          "mark": {
            "start": {
              "line": 123,
              "column": 123
            },
            "end": {
              "line": 123,
              "column": 123
            }
          },
          "message": "<string>"
        }
      ],
      "businessIdentifiers": [
        {
          "elementId": "<string>",
          "element": "<string>",
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "operation": "<string>"
    }
  ]
}

This endpoint returns details about transactions that Stedi processed after the specified startDateTime.

Transactions are ordered from oldest to newest according to the processedAt property. This is exclusive of the startDateTime. For example, if the provided startDateTime is 2023-08-10T18:00:00Z, a transaction processed at exactly that time would not be included in the results. There is also a fifteen-second window where newly created transactions are excluded, meaning Stedi returns results up to fifteen seconds before the time of your request. This functionality accounts for any network latency or clock drift within the systems to ensure you don’t miss any transactions.

​
Polling with page tokens

We don’t recommend polling using startDateTime only. Due to the exclusive nature of startDateTime, you could potentially miss a transaction if two transactions occur at the exact same time and are on the edge of a pagination. Instead, you should use pageToken.

After the initial request, you can poll again immediately using pageToken to continue iterating through the pages of transactions. The endpoint always returns a nextPageToken, regardless of whether additional transactions match the request criteria. If the items array is empty, continue using the provided nextPageToken to poll for new transactions. New transactions will be returned when available.

We recommend storing pageToken values as part of your polling process. They don’t expire, allowing you to start from that point in the transaction stream again if you need to catch a system up to date or recover from a failure.

Note that pageToken values are unique per request, opaque, and shouldn’t be parsed or modified in any way. They are not guaranteed to be in any particular format, and may change in the future.

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
​
nextPageToken
string

The token used for pagination

Required string length: 1 - 1024