Dispatch plans

Import Routes Into Dispatch Plan

Take up to 1,500 whole undispatched routes per request into the plan's draft, archiving each live source route; its orders join the plan. Routes the plan already took are reported as unchanged, so a retry is safe. The whole selection is refused when any id is unknown or ineligible (400 PLAN_SELECTION_INVALID, naming the ids) or another plan holds one of its orders (409 ORDER_HELD_BY_PLAN). More ids than one request takes fail with 422 VALIDATION_ERRORS. A plan holds at most 22,000 orders, 1,500 routes and 24,000 stops; an import that would grow it past them is refused with 400 PLAN_DOCUMENT_INVALID. Fails with 409 PLAN_LEASE_HELD (naming heldBy) while anyone has the plan open in the Planner, and with 409 PLAN_REVISION_STALE (naming currentRevision) when the plan changed since expectedRevision.

post/v1/plans/{planId}/routes:import

Request

  • Base URL
    https://api.sandbox.usenash.com
  • Auth
    none declared

Path parameters

planIdstring required

Request body

expectedRevisioninteger required

The revision of the plan you last read.

routeIdsstring[] required

Undispatched routes to take.

Response

OK

planIdstring required
revisioninteger required
contentHashstring required
importedRouteIdsstring[] required

Routes taken into the plan and archived.

unchangedRouteIdsstring[] required

Routes the plan already took, left as they were.

importedOrderIdsstring[] required

Orders that joined the plan with the taken routes.

memberCountinteger required

Orders the plan holds now.

Changes

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