ORorderful
Transaction

Get a Transaction

Changed on

Returns the specified Transaction in the same shape as each item of <a href="https://docs.orderful.com/reference/transactionv4controller_listtransactions" target="_blank">List Transactions</a>.

The response's links object carries ready-built URLs to this Transaction's <a href="https://docs.orderful.com/reference/compositetransactioncontroller_getacknowledgment" target="_blank">acknowledgment</a> and <a href="https://docs.orderful.com/reference/transactionv4controller_getmessage" target="_blank">message content</a>.

get/transactions/{transactionId}

Request

Path parameters

transactionIdstring uuid required

The Transaction UUID, taken from the id field of a listed Transaction or an inbound delivery. Must be a UUID — numeric transaction IDs are not accepted on this endpoint.

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

Transaction details.

idstring uuid required

The Transaction's unique ID. This is the same value delivered as id in an inbound delivery payload, and the value the v4 transaction endpoints take as their path parameter.

direction'in' | 'out' required

Whether the transaction was received (in) or sent (out) by your organization.

senderIdstring required

ISA ID of the party that sent the transaction.

receiverIdstring required

ISA ID of the party that received the transaction.

ediTransactionTypestring required

The full Orderful transaction type identifier, for example 850_PURCHASE_ORDER or the EDIFACT ORDERS_PURCHASE_ORDER. See <a href="https://docs.orderful.com/reference/available-transaction-types" target="_blank">Available Transaction Types</a>.

simplifiedTransactionType'PURCHASE_ORDER' | 'PURCHASE_ORDER_ACKNOWLEDGMENT' | 'PURCHASE_ORDER_CHANGE' | 'SHIP_NOTICE' | 'INVOICE' | 'INVENTORY_ADVICE' | 'PRICE_SALES_CATALOG' | 'WAREHOUSE_SHIPPING_ORDER' | 'WAREHOUSE_SHIPPING_ADVICE' | 'WAREHOUSE_STOCK_TRANSFER_SHIPMENT' | 'WAREHOUSE_STOCK_TRANSFER_RECEIPT' nullable required

Business name shared by every EDI transaction type that carries the same document, for example INVOICE for both 810_INVOICE and INVOIC_INVOICE. null for any transaction type that has no alias — check for null rather than assuming a value is present. For the full mapping, see <a href="https://docs.orderful.com/reference/mosaic-schemas" target="_blank">Mosaic Schemas</a>.

stream'test' | 'live' required

Whether the transaction belongs to the test or the live stream.

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

Whether the transaction message passed guideline validation.

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

How far the transaction has progressed towards its recipient.

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

Whether the recipient has acknowledged the transaction.

businessNumberstring nullable required

Identifier the document carries in your business, for example an invoice or purchase order number.

createdAtstring date-time required

When the transaction was created.

Example response

{
  "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