Transaction

Fail a transaction delivery.

Fails the specified transaction delivery.

Do not build this URL yourself. POST to the delivery.fail.href included with every Transaction retrieved from a <a href="https://docs.orderful.com/reference/inboxcontroller_list" target="_blank">Inbox</a> or delivered via an <a href="https://docs.orderful.com/docs/inbound-http" target="_blank">Inbound HTTP Communication Channel</a>. The numeric transaction ID that appears in this path is deprecated and will be removed in an upcoming release; the href will keep working.

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 an inbox, this will also remove the Transactions from that inbox.

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

Request

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

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.

Changes

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