ORorderful
Transaction

Get an Acknowledgment

Changed on

Returns the acknowledgment for the specified Transaction.

Use the id from the inbound delivery body, or follow its transaction.acknowledgment.href directly. Both the sender and the receiver of the Transaction can read the acknowledgment.

A Transaction that has not been acknowledged yet returns 404 — this is the expected response for NOT_ACKNOWLEDGED, not an error in your integration.

get/transactions/{compositeTransactionId}/acknowledgment

Request

Path parameters

compositeTransactionIdstring uuid required

The Transaction UUID, taken from the id field of 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

Acknowledgment details.

hrefstring required

URL of this acknowledgment resource.

createdAtstring date-time required

Acknowledgment creation timestamp.

status'ACCEPTED' | 'REJECTED' | 'ACCEPTED_WITH_ERRORS' required

Current acknowledgment status of the Transaction. ACCEPTED_WITH_ERRORS is set by Orderful when a 997 reports partial acceptance; you can only set ACCEPTED or REJECTED.

Example response

{
  "href": "https://api.orderful.com/transactions/019faa61-2fea-719b-a0f8-e6d42fbbc430/acknowledgment",
  "createdAt": "2026-07-28T20:18:43.818Z",
  "status": "ACCEPTED",
  "transaction": {
    "href": "https://api.orderful.com/transactions/019faa61-2fea-719b-a0f8-e6d42fbbc430"
  },
  "errors": [
    {
      "path": "/message",
      "code": "00",
      "message": "Purchase order references an unknown ship-to location"
    }
  ]
}

Changes