---
updatedAt: 2026-04-22T01:03:05.000Z
agentTools:
projectIndex: https://docs.orderful.com/llms.txt
---
# List Transactions
Returns an array of Transactions sorted in descending order by their creation date. A maximum of 100 Transactions will be returned at a time.
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "Orderful API",
"description": "The official Orderful API documentation.",
"version": "2.15.0",
"contact": {
"name": "Orderful",
"url": "https://orderful.com",
"email": "developers@orderful.com"
},
"termsOfService": "https://orderful.com/terms-and-conditions/"
},
"servers": [
{
"url": "https://api.orderful.com"
}
],
"tags": [
{
"name": "Transaction (v3)",
"description": "Create and manage EDI transactions using the v3 API."
}
],
"security": [
{
"API_KEY": []
}
],
"paths": {
"/v3/transactions": {
"get": {
"operationId": "TransactionControllerV3_list",
"summary": "List Transactions",
"description": "Returns an array of Transactions sorted in descending order by their creation date. A maximum of 100 Transactions will be returned at a time.\n",
"tags": [
"Transaction (v3)"
],
"parameters": [
{
"name": "orderful-api-key",
"in": "header",
"required": true,
"description": "Your Orderful API key.",
"schema": {
"type": "string"
}
},
{
"name": "prevCursor",
"in": "query",
"required": false,
"description": "If results are paginated, this will point to the previous set of results.\n",
"schema": {
"type": "string"
}
},
{
"name": "nextCursor",
"in": "query",
"required": false,
"description": "If results are paginated, this will point to the next set of results.\n",
"schema": {
"type": "string"
}
},
{
"name": "createdAt",
"in": "query",
"required": false,
"description": "The date and time that the Transactions were created on or before, in ISO-8601 format. This is used to filter results.\n",
"schema": {
"type": "string"
}
},
{
"name": "stream",
"in": "query",
"required": false,
"description": "Indicates whether you want results from the Test and/or Live stream.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"TEST",
"LIVE"
]
}
}
},
{
"name": "businessNumber",
"in": "query",
"required": false,
"description": "Indicates which business number(s) you would like to list Transactions from. You may indicate up to 5 business numbers.\n",
"schema": {
"type": "array",
"maxItems": 5,
"items": {
"type": "string"
}
}
},
{
"name": "transactionType",
"in": "query",
"required": false,
"description": "Indicates the Transaction Type(s) you would like to filter by. You may indicate up to 5 Transaction Types.\n",
"schema": {
"type": "array",
"maxItems": 5,
"items": {
"type": "string"
}
}
},
{
"name": "validationStatus",
"in": "query",
"required": false,
"description": "The one or more validation status(es) you would like to filter by.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"PROCESSING",
"VALID",
"INVALID"
]
}
}
},
{
"name": "deliveryStatus",
"in": "query",
"required": false,
"description": "The one or more delivery status(es) you would like to filter by.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"PENDING",
"SENT",
"DELIVERED",
"FAILED"
]
}
}
},
{
"name": "acknowledgmentStatus",
"in": "query",
"required": false,
"description": "The one or more acknowledgment status(es) you would like to filter by.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"NOT_ACKNOWLEDGED",
"ACCEPTED",
"REJECTED",
"OVERDUE",
"ACCEPTED_WITH_ERRORS"
]
}
}
},
{
"name": "senderIsaId",
"in": "query",
"required": false,
"description": "The Sender ISA ID(s) that you would like to list Transactions from. You may indicate up to 5 Sender ISA IDs.\n",
"schema": {
"type": "array",
"maxItems": 5,
"items": {
"type": "string"
}
}
},
{
"name": "receiverIsaId",
"in": "query",
"required": false,
"description": "The Receiver ISA ID(s) that you would like to list Transactions from. You may indicate up to 5 Receiver ISA IDs.\n",
"schema": {
"type": "array",
"maxItems": 5,
"items": {
"type": "string"
}
}
},
{
"name": "referenceIdentifier",
"in": "query",
"required": false,
"description": "Reference Identifier Value you would like to filter by.",
"schema": {
"type": "string"
}
},
{
"name": "senderInterchangeReferenceIdentifier",
"in": "query",
"required": false,
"description": "Sender's Interchange Reference Identifier Value you would like to filter by.",
"schema": {
"type": "string"
}
},
{
"name": "senderGroupReferenceIdentifier",
"in": "query",
"required": false,
"description": "Sender's (Functional) Group Reference Identifier Value you would like to filter by.",
"schema": {
"type": "string"
}
},
{
"name": "senderTransactionReferenceIdentifier",
"in": "query",
"required": false,
"description": "Sender's Transaction Reference Identifier Value you would like to filter by.",
"schema": {
"type": "string"
}
},
{
"name": "receiverInterchangeReferenceIdentifier",
"in": "query",
"required": false,
"description": "Receiver's Interchange Reference Identifier Value you would like to filter by.",
"schema": {
"type": "string"
}
},
{
"name": "receiverGroupReferenceIdentifier",
"in": "query",
"required": false,
"description": "Receiver's (Functional) Group Reference Identifier Value you would like to filter by.",
"schema": {
"type": "string"
}
},
{
"name": "receiverTransactionReferenceIdentifier",
"in": "query",
"required": false,
"description": "Receiver's Transaction Reference Identifier Value you would like to filter by.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "List of transactions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTransactionsResponseV3Dto"
}
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"API_KEY": {
"type": "apiKey",
"in": "header",
"name": "orderful-api-key"
}
},
"schemas": {
"ListTransactionsResponseV3Dto": {
"type": "object",
"required": [
"metadata",
"data"
],
"properties": {
"metadata": {
"description": "Pagination metadata.",
"allOf": [
{
"$ref": "#/components/schemas/ListTransactionsResponseV3MetadataDto"
}
]
},
"data": {
"description": "List of transactions.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TransactionV3Dto"
}
}
}
},
"ListTransactionsResponseV3MetadataDto": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/PaginationV3"
}
}
},
"PaginationV3": {
"type": "object",
"required": [
"links"
],
"properties": {
"links": {
"$ref": "#/components/schemas/PaginationLinkV3"
}
}
},
"PaginationLinkV3": {
"type": "object",
"required": [
"next",
"prev"
],
"properties": {
"next": {
"type": "string",
"nullable": true,
"description": "Next URL which you can use to fetch the next page."
},
"prev": {
"type": "string",
"nullable": true,
"description": "Previous URL which you can use to fetch the previous page."
}
}
},
"TransactionV3Dto": {
"type": "object",
"required": [
"id",
"href",
"version",
"sender",
"receiver",
"type",
"stream",
"businessNumber",
"referenceIdentifiers",
"message",
"validationStatus",
"deliveryStatus",
"acknowledgmentStatus",
"createdAt",
"lastUpdatedAt",
"acknowledgment"
],
"properties": {
"id": {
"type": "string",
"example": "000000",
"description": "Transaction ID."
},
"href": {
"type": "string",
"example": "https://api.orderful.com/v3/transactions/000000",
"description": "Transaction URL."
},
"version": {
"type": "string",
"enum": [
"v3"
],
"example": "v3"
},
"sender": {
"description": "Sender identity information.",
"example": {
"isaId": "ISA_ID_SENDER",
"isaIdQualifier": "ZZ",
"testIsaId": "ISA_ID_SENDER_TEST",
"testIsaIdQualifier": "ZZ",
"name": ""
},
"allOf": [
{
"$ref": "#/components/schemas/TransactionIdentityV3Dto"
}
]
},
"receiver": {
"description": "Receiver identity information.",
"example": {
"isaId": "ISA_ID_RECEIVER",
"isaIdQualifier": "ZZ",
"testIsaId": "ISA_ID_RECEIVER_TEST",
"testIsaIdQualifier": "ZZ",
"name": ""
},
"allOf": [
{
"$ref": "#/components/schemas/TransactionIdentityV3Dto"
}
]
},
"type": {
"description": "Transaction type information.",
"example": {
"name": "850_PURCHASE_ORDER"
},
"allOf": [
{
"$ref": "#/components/schemas/TransactionTypeV3Dto"
}
]
},
"stream": {
"type": "string",
"enum": [
"TEST",
"LIVE"
],
"example": "TEST"
},
"businessNumber": {
"type": "string",
"description": "Business identifier for the transaction.",
"example": "BUSINESS_NUMBER"
},
"referenceIdentifiers": {
"type": "array",
"description": "Reference identifiers for the transaction.",
"example": [
{
"value": "000000001",
"type": "INTERCHANGE",
"owner": "SENDER"
},
{
"value": "1",
"type": "GROUP",
"owner": "SENDER"
},
{
"value": "0001",
"type": "TRANSACTION",
"owner": "SENDER"
}
],
"items": {
"$ref": "#/components/schemas/TransactionReferenceIdentifierV3Dto"
}
},
"message": {
"type": "object",
"description": "Transaction message. Contains an href link to the message content. When expand=message is used, the full transactionSets array is included.\n",
"example": {
"href": "https://api.orderful.com/v3/transactions/000000/message"
}
},
"validationStatus": {
"type": "string",
"description": "Validation status of the transaction.",
"enum": [
"PROCESSING",
"VALID",
"INVALID"
],
"example": "VALID"
},
"deliveryStatus": {
"type": "string",
"description": "Delivery status of the transaction.",
"enum": [
"PENDING",
"SENT",
"DELIVERED",
"FAILED"
],
"example": "DELIVERED"
},
"acknowledgmentStatus": {
"type": "string",
"description": "Acknowledgment status of the transaction.",
"enum": [
"NOT_ACKNOWLEDGED",
"ACCEPTED",
"REJECTED",
"OVERDUE",
"ACCEPTED_WITH_ERRORS"
],
"example": "ACCEPTED"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Datetime the transaction was created.",
"example": "2025-12-24T14:01:23.613Z"
},
"lastUpdatedAt": {
"type": "string",
"format": "date-time",
"description": "Datetime the transaction was last updated.",
"example": "2025-12-24T14:01:23.613Z"
},
"acknowledgment": {
"description": "Acknowledgment reference.",
"example": {
"href": "https://api.orderful.com/v3/transactions/000000/acknowledgment"
},
"allOf": [
{
"$ref": "#/components/schemas/TransactionAcknowledgmentRefV3Dto"
}
]
}
}
},
"TransactionIdentityV3Dto": {
"type": "object",
"required": [
"isaId",
"isaIdQualifier",
"testIsaId",
"testIsaIdQualifier",
"name"
],
"properties": {
"isaId": {
"type": "string",
"description": "ISA ID for production."
},
"isaIdQualifier": {
"type": "string",
"description": "ISA ID qualifier."
},
"testIsaId": {
"type": "string",
"description": "ISA ID for test stream."
},
"testIsaIdQualifier": {
"type": "string",
"description": "Test ISA ID qualifier."
},
"name": {
"type": "string",
"description": "EDI account name."
}
}
},
"TransactionTypeV3Dto": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Transaction type name (e.g., 850_PURCHASE_ORDER)."
}
}
},
"TransactionReferenceIdentifierV3Dto": {
"type": "object",
"required": [
"value",
"type",
"owner"
],
"properties": {
"value": {
"type": "string",
"description": "Reference identifier value."
},
"type": {
"type": "string",
"description": "Reference identifier type.",
"enum": [
"INTERCHANGE",
"GROUP",
"TRANSACTION"
]
},
"owner": {
"type": "string",
"description": "Owner of the reference identifier.",
"enum": [
"SENDER",
"RECEIVER"
]
}
}
},
"TransactionAcknowledgmentRefV3Dto": {
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"type": "string",
"description": "Acknowledgment URL.",
"example": "https://api.orderful.com/v3/transactions/000000/acknowledgment"
}
}
}
}
}
}
```