v1

latestOpenAPI 3.0.02026-07-2421110121.4 KB
Transaction

Fail a transaction delivery.

Fails the specified transaction delivery. This link is included when a Transaction is retrieved from a <a href="https://docs.orderful.com/reference/pollingcontroller_list" target="_blank">Inbox</a> or via an <a href="https://docs.orderful.com/docs/inbound-http" target="_blank">Inbound HTTP Communication Channel</a>.

If this Delivery is the most recent one associated with a Transaction, this will update the Transaction's deliveryStatus to FAILED.

If this Delivery is associated with one or more Transactions in a inbox, this will also remove the Transactions from that inbox.

post/transactions/{transactionId}/deliveries/{deliveryId}/fail

Path parameters

transactionIdnumber required
deliveryIdstring required

Headers

orderful-api-versionstring

Specifies the API version to use.

Request body

notestring required

Additional information about the failure.

Response

Transaction marked as failed.