ORorderful
Transaction

List Transactions

Changed on

Returns your organization's Transactions — inbound and outbound, across every trading relationship — sorted in descending order by their creation date. A maximum of 100 Transactions are returned per page; follow metadata.pagination.links.next to <a href="https://docs.orderful.com/reference/pagination" target="_blank">paginate</a> through the rest.

Every item carries ready-built links to the Transaction itself, its <a href="https://docs.orderful.com/reference/compositetransactioncontroller_getacknowledgment" target="_blank">acknowledgment</a>, and its <a href="https://docs.orderful.com/reference/transactionv4controller_getmessage" target="_blank">message content</a>, so you never need to assemble URLs from IDs.

get/transactions

Request

Query parameters

prevCursorstring

If results are <a href="https://docs.orderful.com/reference/pagination" target="_blank">paginated</a>, this will point to the previous set of results.

nextCursorstring

If results are <a href="https://docs.orderful.com/reference/pagination" target="_blank">paginated</a>, this will point to the next set of results.

limitinteger

How many Transactions to return per page. Defaults to 100.

directionstring[]

Return only Transactions your organization received (in) or sent (out).

businessNumberstring[]

The business number(s) to filter by — the identifier the document carries in your business, for example an invoice or purchase order number. You may indicate up to 5 values, each up to 100 characters.

validationStatusstring[]

The one or more validation status(es) you would like to filter by.

deliveryStatusstring[]

The one or more delivery status(es) you would like to filter by.

acknowledgmentStatusstring[]

The one or more acknowledgment status(es) you would like to filter by.

streamstring[]

Indicates whether you want results from the test and/or live stream. Note the lowercase values — this differs from the v3 list, which uses TEST/LIVE.

ediTransactionTypestring[]

The EDI transaction type(s) to filter by, for example 810_INVOICE. You may indicate up to 5 <a href="https://docs.orderful.com/reference/available-transaction-types" target="_blank">Transaction Types</a>. When combined with simplifiedTransactionType, a Transaction must match both filters.

simplifiedTransactionTypestring[]

Filter by business name instead of EDI transaction type, for example INVOICE to match every invoice type at once. For the full mapping, see <a href="https://docs.orderful.com/reference/mosaic-schemas" target="_blank">Mosaic Schemas</a>.

senderIdstring[]

The sender ISA ID(s) to filter by, matched against the senderId field. You may indicate up to 5 values.

receiverIdstring[]

The receiver ISA ID(s) to filter by, matched against the receiverId field. You may indicate up to 5 values.

createdAtStartstring

Return only Transactions created at or after this ISO 8601 timestamp, for example 2026-05-26T00:00:00.000Z.

createdAtEndstring

Return only Transactions created at or before this ISO 8601 timestamp, for example 2026-05-27T00:00:00.000Z.

Headers

orderful-api-keystring required

Your Orderful API key.

orderful-api-versionstring required

Specifies the API version to use. This endpoint requires v4; omitting the header returns 404.

Response

List of transactions, newest first.

Example response

{
  "data": [
    {
      "id": "019e4ac5-d900-720f-a54c-26e9f114ac4f",
      "direction": "out",
      "senderId": "MosaicNT",
      "receiverId": "MosaicDemo",
      "ediTransactionType": "850_PURCHASE_ORDER",
      "simplifiedTransactionType": "PURCHASE_ORDER",
      "stream": "live",
      "validationStatus": "VALID",
      "deliveryStatus": "DELIVERED",
      "acknowledgmentStatus": "ACCEPTED",
      "businessNumber": "PO5786344061670677",
      "createdAt": "2026-05-26T10:00:00.000Z",
      "links": {
        "self": "https://api.orderful.com/transactions/019e4ac5-d900-720f-a54c-26e9f114ac4f",
        "acknowledgment": "https://api.orderful.com/transactions/019e4ac5-d900-720f-a54c-26e9f114ac4f/acknowledgment",
        "message": "https://api.orderful.com/transactions/019e4ac5-d900-720f-a54c-26e9f114ac4f/message"
      }
    }
  ]
}

Changes