Skip to documentation
NikoHealth integration

List Inventory

Perform List Inventory through NikoHealth.

View as Markdown
nikohealth_list_inventory
readnikohealth

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": "NikoHealth",
  "params": {
    "max_results": 200
  },
  "handler": "nikohealth_list_inventory"
}

Action contracts and connections · Run recovery

Inputs

  • product_name
    text
    Product Name

    Optional text value.

  • part_number
    text
    Part Number

    Optional text value.

  • hcpcs_code
    text
    Hcpcs Code

    Optional text value.

  • product_ids
    text
    Product Ids

    Optional text value.

  • location_name
    text
    Location Name

    Optional text value.

  • location_type
    text
    Location Type

    Optional text value.

  • status
    text
    Status

    Optional text value.

  • max_results
    number
    Max Results

    Optional numeric value.

    Default: 200

Outputs

  • successSuccess
  • itemsItems
  • countCount
  • total_countTotal Count
  • truncatedTruncated
  • errorError
  • error_typeError Type

Output schema completeness: best_effort_declared

Safety

External effect
read
Confirmation recommended
No
Retry safe
Yes
Dry run supported
No

Schemas

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

Input schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "hcpcs_code": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "max_results": {
      "type": "number",
      "default": 200,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "part_number": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "product_ids": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "product_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "location_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "location_type": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "items": {},
    "success": {},
    "truncated": {},
    "error_type": {},
    "total_count": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions