Tenant API reference

Generated from api/openapi.yaml (version 1.0.0-alpha). 23 operations.

Method	Path	Scope	Idempotency-Key	What it does
POST	/v1/geography/resolve	geography.read	—	Resolve a pin to suburb, zone and gateway.
GET	/v1/geography/suburbs	geography.read	—	Serviceable suburbs, by name.
GET	/v1/vehicle-types	geography.read	—	Vehicle types for a delivery between two suburbs.
POST	/v1/delivery/quote	quotes.create	Optional	Authoritative quote with expiry and pricing version.
GET	/v1/partners	partners.read	—	Delivery partners available to this tenant.
POST	/v1/delivery/jobs	delivery.create	Required	Confirm a quote into exactly one delivery job.
GET	/v1/delivery/jobs/{ref}	delivery.read	—	Authoritative job state with its customer-safe status.
POST	/v1/bulk-deliveries	delivery.create	Required	Create a Bulk Delivery, one parent with two to five children.
GET	/v1/bulk-deliveries/{ref}	delivery.read	—	A Bulk Delivery and its children.
POST	/v1/bulk-deliveries/{ref}/recipients	delivery.create	Required	Add recipients before the sender confirms, while positions remain.
POST	/v1/bulk-deliveries/{ref}/recipients/{child_ref}/resend	delivery.create	Required	Resend one recipient's link before the sender confirms.
POST	/v1/bulk-deliveries/{ref}/recipients/{child_ref}/remove	delivery.create	Required	Remove one recipient before the sender confirms.
POST	/v1/bulk-deliveries/{ref}/quote	quotes.create	Optional	Quote every confirmed child; the total is their sum.
POST	/v1/bulk-deliveries/{ref}/confirm	delivery.create	Required	Confirm the reviewed revision; one job per child.
POST	/v1/bulk-deliveries/{ref}/cancel	delivery.cancel	Required	Cancel the whole Bulk before dispatch; per child after.
GET	/v1/bulk-deliveries/{ref}/progress	delivery.read	—	The sender's Bulk progress view, "3 of 5 delivered".
POST	/v1/webhooks	webhooks.manage	Required	Register or update a webhook endpoint and its subscriptions.
POST	/v1/webhooks/{id}/replay	webhooks.manage	Required	Replay an endpoint's undelivered events within the retention window.
POST	/v1/delivery/jobs/{ref}/cancel	delivery.cancel	Required	Cancel at a permitted stage, with a reason.
POST	/v1/delivery/jobs/{ref}/reassign	delivery.reassign	Required	Trigger recovery re-dispatch.
POST	/v1/delivery/jobs/{ref}/complete	delivery.complete	Required	Server-authoritative completion of the tenant's own delivery.
GET	/v1/delivery/jobs/{ref}/events	delivery.read	—	Customer-safe event history, ordered by sequence.
GET	/v1/analytics	delivery.read	—	Delivery analytics for the calling tenant.