v2

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-10204364.2 KB

deliveries

Update delivery event

Transition a delivery to a new event state. If a webhook URL was registered, the server pushes an event notification in the background.

patch/deliveries/{delivery_id}/event

delivery_idstring required

Delivery identifier.

eventstring required

Event identifier from the delivery's event vocabulary.

event_descriptionstring required

Human-readable event description.

Delivery event updated.

idstring required

Unique delivery identifier.

request_idstring required

Reference to the delivery request.

quote_idstring required

Reference to the accepted quote.

payment_instrument_idstring required

Reference to the payment instrument used to create this delivery.

eventstring required

Current event identifier.

event_descriptionstring required

Human-readable description of the current event.

event_vocabularystring required

Event vocabulary standard in use.

webhook_urlstring nullable

Registered webhook URL, if any.

created_atstring date-time required

Creation timestamp (RFC 3339).

updated_atstring date-time required

Last update timestamp (RFC 3339).