ORorderful
Transaction

Create an Acknowledgment

Changed on

Acknowledges an inbound Transaction as ACCEPTED or REJECTED.

Every inbound delivery gives you what you need for this call — in the body pushed to your <a href="https://docs.orderful.com/docs/inbound-http" target="_blank">Inbound HTTP Communication Channel</a> and in each item returned by <a href="https://docs.orderful.com/reference/inboxcontroller_list" target="_blank">Inbox</a>. Either use the payload's id field as the compositeTransactionId, or POST straight to the finished URL in transaction.acknowledgment.href — they refer to the same Transaction. You can also find the Transaction — and its ready-built links.acknowledgment URL — with <a href="https://docs.orderful.com/reference/transactionv4controller_listtransactions" target="_blank">List Transactions</a>.

integrationPayloadId is a different identifier and will not work here.

Acknowledgments can only be sent once — a Transaction that is already ACCEPTED or REJECTED returns 400. This endpoint applies to Relationships that trade JSON; X12 and EDIFACT Relationships acknowledge through a 997 Functional Acknowledgment instead.

post/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.

Request body

status'ACCEPTED' | 'REJECTED' required

Whether the received Transaction is accepted or rejected.

Example request

{
  "status": "ACCEPTED",
  "errors": [
    {
      "path": "/message",
      "code": "00",
      "message": "Purchase order references an unknown ship-to location"
    }
  ]
}

Response

Acknowledgment created successfully.

Changes