Get the AI approval summary
GET/api/send-plans/:sendPlan/ai-approval
Everything a one-click approval of a send plan approves, calculated from the plan (the AI only words the narrative): totals (units, cases, estimated weight in lb, volume in ft³, pallets, value at average cost, SKUs, kept for self-fulfilled orders, stock-outs before arrival, shortfall, supplier units/value); per destination the same numbers plus sources, draft groups, reasons and checks before shipping; supplier orders shipped direct (supplier × destination, units, value, lead time, ETA, prep notes); lines already drafted; the SKU closest to running out; what changed since the previous full working plan; a plain narrative; approvable (why this plan can't be approved here, or null — scenarios and send runs aren't); and the latest approval with its run state.
send-plans:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
fingerprint ties an approval to these numbers: send it back with POST ai-approval. Needs send_planner.view; API tokens: send-plans:read.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.