Transaction (v3)

Create an Acknowledgment

Creates an acknowledgment with the specified status for the specified Transaction, using the numeric transaction ID.

If you are building on v4, use <a href="https://docs.orderful.com/reference/compositetransactioncontroller_createacknowledgment" target="_blank">Create an Acknowledgment</a> instead. That endpoint takes the Transaction UUID and its URL is handed to you directly as transaction.acknowledgment.href in every inbound delivery. This v3 endpoint remains fully supported for integrations that work with numeric transaction IDs.

post/v3/transactions/{transactionId}/acknowledgment

Request

Base URL
https://api.orderful.com
Auth
API key in header orderful-api-key
TypeScript
https://skmtc.dev/orderful/apis/orderful-api/docs/v3/transactions/:transactionId/acknowledgment/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

transactionIdnumber required

The numeric transaction ID.

Headers

orderful-api-keystring required

Your Orderful API key.

Request body

status'ACCEPTED' | 'REJECTED' required

Status of the acknowledgment.

Example request

{
  "errors": [
    {
      "path": "/message",
      "code": "00",
      "message": "This is a top-level error message for JSON transaction"
    }
  ]
}

Response

Acknowledgment created successfully.

Changes

No recorded changes to this operation across all 2 revisions of this API.