Skip to documentation
Consignment Intake integration

Plan Consignment Inbox Runs

Perform Plan Consignment Inbox Runs through Consignment Intake.

View as Markdown
plan_consignment_inbox_runs
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": {},
  "handler": "plan_consignment_inbox_runs"
}

Action contracts and connections · Run recovery

Inputs

  • messages
    jsonrequired
    Messages

    Required JSON value.

  • assigned_message_id
    text
    Assigned Message Id

    Optional text value.

  • batch_limit
    numberrequired
    Batch Limit

    Required numeric value.

  • is_targeted_search
    boolean
    Is Targeted Search

    Optional true-or-false value.

Outputs

  • successSuccess
  • roleRole
  • queue_messagesQueue Messages
  • batch_limitBatch Limit
  • report_backlogReport Backlog
  • parallel_runsParallel Runs
  • claimed_elsewhereClaimed Elsewhere
  • dispatched_countDispatched Count
  • active_workersActive Workers
  • send_failuresSend Failures
  • assigned_message_listedAssigned Message Listed
  • 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": [
    "messages",
    "batch_limit"
  ],
  "properties": {
    "messages": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "batch_limit": {
      "type": "number",
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    },
    "is_targeted_search": {
      "type": "boolean",
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "assigned_message_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "role": {},
    "error": {},
    "success": {},
    "batch_limit": {},
    "parallel_runs": {},
    "send_failures": {},
    "active_workers": {},
    "queue_messages": {},
    "report_backlog": {},
    "dispatched_count": {},
    "claimed_elsewhere": {},
    "assigned_message_listed": {}
  },
  "additionalProperties": true
}
View all Consignment Intake actions