Transfers

Skips a waypoint, redirecting the lines still assigned to it (Skip Waypoint).

Requires ManageTransfers and an Idempotency-Key header. Body (required when lines are still to be dropped off there): { "destinationType": "Waypoint", "destinationId": 42 } (a later Pending waypoint), { "destinationType": "Destination" } or { "destinationType": "Location", "destinationId": 4 } (an active location, added as a drop-off waypoint at the end of the route). The waypoint must be Pending (an Arrived one already had its lines dropped off - leave it with …/depart); it becomes Skipped and the transfer moves on to the next Pending waypoint or InTransitToDestination. Same transfer rule as …/arrive.

post/api/v1/transfers/{id}/waypoints/{waypointId}/skip

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/transfers/{id}/waypoints/{waypointId}/skip
  • Auth: HTTP bearer

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

waypointIdinteger required

Waypoint id (waypoints[].id).

Request body

destinationType'Waypoint' | 'Destination' | 'Location'

Where a redirected line, or a line on a skipped waypoint, goes instead: Waypoint, Destination or Location.

destinationIdinteger nullable

Waypoint id or location id, per destinationType; ignored for Destination. Example: 4.

Response

Transfer id and confirmation (e.g. Waypoint skipped. 2 item(s) redirected.).

idinteger

Id of the resource the operation acted on (e.g. the job id).

messagestring nullable

Human-readable confirmation from the service (e.g. "Job started."). May be null.

warningstring nullable

Non-fatal problem encountered while completing the operation (e.g. a notification email that could not be sent). Null when there was none.

Changes

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