Transfers

Cancels a job-site or standalone transfer and releases its stock.

Requires ManageTransfers and an Idempotency-Key header; no body. A job-site transfer (isJobTransfer true) is cancelled like the Job Details "Cancel" button: the stock becomes available again, the job lines return to Planned and a "Transfer cancelled" entry is added to the job history. A standalone transfer is cancelled like the Transfers page's "Cancel Transfer" button, which is offered only while it is Draft, or Pending and not awaiting approval (reject it instead). Sales-order transfers are cancelled in the app.

post/api/v1/transfers/{id}/cancel

Request

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

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

Response

Transfer id and confirmation message (e.g. Transfer cancelled. Items are now available again.).

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.