NikoHealth integration

Claim Tagged Orders

Perform Claim Tagged Orders through NikoHealth.

View as Markdown

nikohealth_claim_tagged_orders

writenikohealth

Inputs

trigger_tag_name
textrequired
Trigger Tag Name
Required text value.
processing_tag_name
textrequired
Processing Tag Name
Required text value.
exclude_tag_names
expression
Exclude Tag Names
Optional literal value or workflow expression.
exclude_statuses
expression
Exclude Statuses
Optional literal value or workflow expression.
Default: ["Cancelled"]
include_statuses
expression
Include Statuses
Optional literal value or workflow expression.
lookback_hours
number
Lookback Hours
Optional numeric value.
Default: 720
created_from
expression
Created From
Optional literal value or workflow expression.
created_to
expression
Created To
Optional literal value or workflow expression.
timezone
text
Timezone
Optional text value.
Default: "America/Chicago"
page_size
number
Page Size
Optional numeric value.
Default: 100
max_pages
number
Max Pages
Optional numeric value.
record_limit
number
Record Limit
Optional numeric value.
dry_run
boolean
Dry Run
Optional true-or-false value.
Default: true

Outputs

successSuccess
errorError
itemsItems
countCount
claimed_countClaimed Count
claim_attemptedClaim Attempted
claim_failed_countClaim Failed Count
claim_failed_order_idsClaim Failed Order Ids
skipped_stale_countSkipped Stale Count
verify_failed_countVerify Failed Count
diagnosticsDiagnostics

Output schema completeness: best_effort_declared

Safety

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

Schemas

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

Input schema

{
  "type": "object",
  "required": [
    "trigger_tag_name",
    "processing_tag_name"
  ],
  "properties": {
    "dry_run": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "timezone": {
      "type": "string",
      "default": "America/Chicago",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "max_pages": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "page_size": {
      "type": "number",
      "default": 100,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "created_to": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "created_from": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "record_limit": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "lookback_hours": {
      "type": "number",
      "default": 720,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "exclude_statuses": {
      "default": [
        "Cancelled"
      ],
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "include_statuses": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "trigger_tag_name": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "exclude_tag_names": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "processing_tag_name": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "items": {},
    "success": {},
    "diagnostics": {},
    "claimed_count": {},
    "claim_attempted": {},
    "claim_failed_count": {},
    "skipped_stale_count": {},
    "verify_failed_count": {},
    "claim_failed_order_ids": {}
  },
  "additionalProperties": true
}

View all NikoHealth actions