v1

latestOpenAPI 3.0.02026-07-2421110121.4 KB

Transaction (v3)

Confirm the delivery of a set of Transactions

Orderful will soon deprecate this endpoint. After retrieving Transactions from a Polling Bucket, you should use the Delivery API to mark a Delivery as <a href="https://docs.orderful.com/reference/deliverycontroller_handledeliveryapproved" target="_blank">Approved</a> or <a href="https://docs.orderful.com/reference/deliverycontroller_handlefaildeliveryrequest" target="_blank">Failed</a>. This will automatically remove the Transaction from the Bucket.

post/v3/transactions/confirm-delivery

Request body

transactionIdstring required

deliveryStatus'DELIVERED' | 'FAILED' required

notestring

Note will be added to the audit trail.

Response

The confirmation batch was successfully processed.

object required

Example response

{
  "12345": "Successfully confirmed failed delivery for transaction 12345",
  "99999": "Transaction ID 99999 not found",
  "988765": "Successfully confirmed delivery for transaction 988765",
  "NO_OP": "Transaction ID NO_OP not found"
}