v2

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

Create delivery

Accept a quote and create a delivery. The nonce field provides idempotency.

post/deliveries

Request body

request_idstring required

The delivery request to fulfill.

quote_idstring required

The accepted quote.

noncestring required

Client-generated idempotency key.

webhook_urlstring nullable

Optional URL to receive delivery event webhook notifications.

event_vocabularystring

Event vocabulary standard to use.

Response

Delivery created.

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).