Skip to documentation
Consignment Intake integration

Recover Consignment Stock Holds

Perform Recover Consignment Stock Holds through Consignment Intake.

View as Markdown
recover_consignment_stock_holds
write

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "Consignment Intake",
  "params": {
    "apply_reprocess": false,
    "include_line_fill_stock_holds": false,
    "complete_billing_owned_elsewhere": false
  },
  "handler": "recover_consignment_stock_holds"
}

Action contracts and connections · Run recovery

Inputs

  • source_workflow_id
    workflow_selectrequired
    Source Workflow Id

    Required selected identifier or value.

  • apply_reprocess
    boolean
    Apply Reprocess

    Optional true-or-false value.

    Default: false

  • complete_billing_owned_elsewhere
    boolean
    Complete Billing Owned Elsewhere

    Optional true-or-false value.

    Default: false

  • include_line_fill_stock_holds
    boolean
    Include Line Fill Stock Holds

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • dry_runDry Run
  • candidatesCandidates
  • ready_existingReady Existing
  • ready_restockedReady Restocked
  • still_shortStill Short
  • conflictsConflicts
  • not_in_processNot In Process
  • unavailableUnavailable
  • already_attemptedAlready Attempted
  • other_holdsOther Holds
  • deferred_by_capDeferred By Cap
  • held_after_rerunHeld After Rerun
  • max_attemptsMax Attempts
  • backed_offBacked Off
  • selectedSelected
  • dispatchedDispatched
  • completedCompleted
  • skippedSkipped
  • errorsErrors
  • outcomesOutcomes
  • warehouse_ownersWarehouse Owners
  • aged_stock_holdsAged Stock Holds
  • stock_hold_alert_postedStock Hold Alert Posted
  • errorError

Output schema completeness: best_effort_declared

Safety

External effect
write
Confirmation recommended
No
Retry safe
No
Dry run supported
No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "required": [
    "source_workflow_id"
  ],
  "properties": {
    "apply_reprocess": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "source_workflow_id": {
      "type": "string",
      "description": "Required selected identifier or value.",
      "x-workflow-field-type": "workflow_select"
    },
    "include_line_fill_stock_holds": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "complete_billing_owned_elsewhere": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "errors": {},
    "dry_run": {},
    "skipped": {},
    "success": {},
    "outcomes": {},
    "selected": {},
    "completed": {},
    "conflicts": {},
    "backed_off": {},
    "candidates": {},
    "dispatched": {},
    "other_holds": {},
    "still_short": {},
    "unavailable": {},
    "max_attempts": {},
    "not_in_process": {},
    "ready_existing": {},
    "deferred_by_cap": {},
    "ready_restocked": {},
    "aged_stock_holds": {},
    "held_after_rerun": {},
    "warehouse_owners": {},
    "already_attempted": {},
    "stock_hold_alert_posted": {}
  },
  "additionalProperties": true
}
View all Consignment Intake actions