---
title: "Skips a waypoint, redirecting the lines still assigned to it (Skip Waypoint)."
method: POST
path: "/api/v1/transfers/{id}/waypoints/{waypointId}/skip"
tags: ["Transfers"]
---

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

`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

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`.

## Path parameters

- `id` integer, required
- `waypointId` integer, required

## Request body

- SkipTransferWaypointRequest: Optional body of `POST /api/v1/transfers/{id}/waypoints/{waypointId}/skip`: where the lines still assigned to the skipped waypoint go instead. Required (both fields) when it has such lines. Example: `{ "destinationType": "Destination" }`.
  - `destinationType` 'Waypoint' | 'Destination' | 'Location': Where a redirected line, or a line on a skipped waypoint, goes instead: `Waypoint`, `Destination` or `Location`.
  - `destinationId` integer, nullable: Waypoint id or location id, per `destinationType`; ignored for `Destination`. Example: `4`.

## Response `200`

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

- ApiOperationResponse: Body of a successful workflow-style write that has no richer resource to return (assign, start, complete, void…). Id is the affected resource's id; Warning carries a non-fatal note from the service (e.g. an email that could not be sent).
  - `id` integer: Id of the resource the operation acted on (e.g. the job id).
  - `message` string, nullable: Human-readable confirmation from the service (e.g. "Job started."). May be null.
  - `warning` string, nullable: Non-fatal problem encountered while completing the operation (e.g. a notification email that could not be sent). Null when there was none.

## Other responses

- `400`: Malformed body or missing `Idempotency-Key`.
- `401`: Unauthorized
- `403`: Forbidden
- `404`: No such transfer in this organization, or no such waypoint on it.
- `409`: The waypoint is `Arrived`, `Departed` or already `Skipped`, the transfer is not in transit, a job-site or sales-order transfer, or the key's creator is unknown on this server.
- `422`: Lines still assigned and no `destinationType`, or an unusable `destinationId` (field listed in `errors`).
- `429`: Too Many Requests
- `500`: The change could not be saved. Retry with the same `Idempotency-Key`.

---

[API](https://skmtc.dev/flexonthejob/apis/flex-api.md) · [All operations](https://skmtc.dev/flexonthejob/apis/flex-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flexonthejob/apis/flex-api/revisions/19c8f4d27acf?raw)