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

Request

Base URL
http://localhost:8000
Auth
none declared
TypeScript
https://skmtc.dev/palette-labs-inc/apis/local-protocol/docs/deliveries/:delivery_id/event/patch.ts
A function with typed inputs. Its response is checked against the schema.

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 original 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

Delivery creation timestamp (RFC 3339).

updated_atstring date-time required

Last update timestamp (RFC 3339).