Delivery

Fail a Delivery

Fails the specified Delivery. This link is included when a Transaction is retrieved from a <a href="https://docs.orderful.com/reference/pollingcontroller_list" target="_blank">Poller Bucket</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 Poller Bucket, this will also remove the Transactions from that Bucket.

post/v3/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/v3/deliveries/:deliveryId/fail/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

deliveryIdstring required

Request body

notestring

Changes

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