POST/api/v1/logistics/predictive-scheduleBeta

Schedule a just-in-time rider

Predictive dispatch — instead of booking a rider now and burning their time idling at the counter, this stamps a READY-AT moment (paidAt + merchant prep minutes) and our cron worker dispatches when the rider's pickup ETA aligns with the package being ready. The rider rolls up exactly when the order's done. The same mechanism that powers Theyutes's internal `predictive` dispatch mode.

Authorization

Requires the logistics:write scope. See the auth guide for how to mint a token with the right scopes.

Parameters

Body parameters

Field	Type	Description
orderId required	string	Your internal order reference. Must be unique per merchant. e.g. ord_001
readyInMinutes optional	number	Override the merchant's default prep time (0–240). Best-effort — the merchant's stored avgPrepMinutes wins. e.g. 18
paidAt optional	string	ISO timestamp the order was paid. Defaults to now. e.g. 2026-05-28T14:30:00.000Z

Response

A successful call returns 200 OK with the body shown to the right. Errors follow the standard envelope.

Request

curl 'https://theyutes.com/api/v1/logistics/predictive-schedule' \
  -X POST \
  -H 'Authorization: Bearer tyk_••••••••••••••••••••••••••••••••' \
  -H 'Content-Type: application/json' \
  -d '{
  "orderId": "ord_001",
  "readyInMinutes": 18,
  "paidAt": "2026-05-28T14:30:00.000Z"
}'

Response · 200 OK

json

{
  "data": {
    "orderId": "ord_001",
    "scheduledReadyAt": "2026-05-28T14:48:00.000Z",
    "predictiveStatus": "queued",
    "nextCronTick": "<= 60s"
  }
}