v1

latestOpenAPI 3.0.02026-07-2421110121.4 KB

Transaction (v3)

Get a Transaction

Returns the specified Transaction.

get/v3/transactions/{transactionId}

Path parameters

transactionIdnumber required

The numeric transaction ID.

Query parameters

expand'message'

This optional parameter will embed the specified object into the return payload.

Headers

orderful-api-keystring required

Your Orderful API key.

Response

Transaction details.

idstring required

Transaction ID.

hrefstring required

Transaction URL.

version'v3' required

stream'TEST' | 'LIVE' required

businessNumberstring required

Business identifier for the transaction.

messageobject required

Transaction message. Contains an href link to the message content. When expand=message is used, the full transactionSets array is included.

validationStatus'PROCESSING' | 'VALID' | 'INVALID' required

Validation status of the transaction.

deliveryStatus'PENDING' | 'SENT' | 'DELIVERED' | 'FAILED' required

Delivery status of the transaction.

acknowledgmentStatus'NOT_ACKNOWLEDGED' | 'ACCEPTED' | 'REJECTED' | 'OVERDUE' | 'ACCEPTED_WITH_ERRORS' required

Acknowledgment status of the transaction.

createdAtstring date-time required

Datetime the transaction was created.

lastUpdatedAtstring date-time required

Datetime the transaction was last updated.

Example response

{
  "id": "000000",
  "href": "https://api.orderful.com/v3/transactions/000000",
  "version": "v3",
  "stream": "TEST",
  "businessNumber": "BUSINESS_NUMBER",
  "referenceIdentifiers": [
    {
      "value": "000000001",
      "type": "INTERCHANGE",
      "owner": "SENDER"
    },
    {
      "value": "1",
      "type": "GROUP",
      "owner": "SENDER"
    },
    {
      "value": "0001",
      "type": "TRANSACTION",
      "owner": "SENDER"
    }
  ],
  "message": {
    "href": "https://api.orderful.com/v3/transactions/000000/message"
  },
  "validationStatus": "VALID",
  "deliveryStatus": "DELIVERED",
  "acknowledgmentStatus": "ACCEPTED",
  "createdAt": "2025-12-24T14:01:23.613Z",
  "lastUpdatedAt": "2025-12-24T14:01:23.613Z",
  "acknowledgment": {
    "href": "https://api.orderful.com/v3/transactions/000000/acknowledgment"
  }
}