Items

Deactivates (soft-deletes) an item.

Requires ManageInventory and an Idempotency-Key header. Same as "Deactivate" on the Items page: the item leaves the catalogue and this API (GETs answer 404), its physical inventory rows and history are untouched, and a user can restore it from Items → Deactivated Items in the app. A parent group that still contains active items is refused with 409; repeat with ?cascadeChildren=true to deactivate the group and its items together (each restorable individually).

delete/api/v1/items/{id}

Request

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

Path parameters

idinteger required

Numeric item id.

Query parameters

cascadeChildrenboolean

For a parent group: also deactivate its active child items instead of refusing.

Response

The item was deactivated; body carries its id and a confirmation (mentions cascaded children when any).

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.