Order Orchestration APIs
Order Orchestration is the heart of the Skeep engine. It manages the entire lifecycle of a delivery, from creation to final fulfillment.
Order Lifecycle
1. Create Delivery Order
POST /deliveries
Creates a new delivery request. This is used by all platforms (WhatsApp, Dashboard, Express API, Internal).
2. Update Delivery
PATCH /deliveries/{id}
Update information about an active delivery (e.g., updating drop-off instructions or recipient contact).
3. Cancel Delivery
POST /deliveries/{id}/cancel
Cancels an active delivery request. Cancellation fees may apply based on the delivery status.
Order Configuration
| Property | Type | Description |
|---|---|---|
pickup | Object | Coordinates, address, and contact for pickup. |
drop_off | Array | One or more destinations for the delivery. |
metadata | Object | Weight, category (Food, Package), and fragility. |
priority | String | express (immediate) or scheduled. |
Retrieval
1. Get Delivery Details
GET /deliveries/{id}
Fetches the full state of a specific delivery.
2. List Deliveries
GET /deliveries
Returns a paginated list of deliveries. Supports filters for status, vendor_id, and date_range.