Transfers

Arrives at a waypoint: the lines assigned to it are dropped off there.

Requires ManageTransfers and an Idempotency-Key header; no body. The transfer must be a standalone transfer in an in-transit status and the waypoint (waypoints[].id) Pending. The units of every line whose destinationWaypointId is this waypoint move to its location (with their bundles); the waypoint becomes Arrived and the transfer AtWaypoint. The final destination is reached with POST …/complete.

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

Request

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

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

waypointIdinteger required

Waypoint id (waypoints[].id of GET /api/v1/transfers/{id}).

Response

Transfer id and confirmation (e.g. Waypoint marked as arrived. 1 item(s) delivered to Van 2.).

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.