lots

Get plan

Returns state: "PROCESSING" with routes: null while the optimizer works. Once it finishes, this call stores the routes, moves the lot to PROCESSED and returns the full plan. Keep calling it until state is PROCESSED; stops are charged at that moment.

Returns 404 before any plan was queued.

get/lots/{id}/plan

Request

  • Base URL: https://api.vepathos.com
  • URL: https://api.vepathos.com/lots/{id}/plan
  • Auth: API key in header Authorization

Path parameters

idinteger required

Response

The plan, or a short poll response while it is still running.

state'UNPROCESSED' | 'PROCESSING' | 'OPTIMIZING' | 'PROCESSED' | 'CANCELED' required
session_idstring uuid

Optimizer run id. Poll GET /lots/{id}/plan/status for progress while state is PROCESSING.

optimizer_session_idstring uuid

Alias of session_id (same optimizer task UUID).

Changes

No recorded changes to this operation across all 1 revision of this API.