Skip to documentation
NikoHealth integration

Quick-Ship From Inventory

Perform Quick-Ship From Inventory through NikoHealth.

View as Markdown
nikohealth_quick_ship_from_inventory
irreversiblenikohealth

Inputs

  • order_id
    expressionrequired
    Order Id

    Required literal value or workflow expression.

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • source_location_id
    expressionrequired
    Source Location Id

    Required literal value or workflow expression.

  • shipped_date
    expressionrequired
    Shipped Date

    Required literal value or workflow expression.

  • equipment_statuses
    expression
    Equipment Statuses

    Optional literal value or workflow expression.

    Default: ["Active","Reserved"]

  • location_type_ids
    expression
    Location Type Ids

    Optional literal value or workflow expression.

Outputs

  • successSuccess
  • order_idOrder Id
  • patient_idPatient Id
  • shipped_item_idsShipped Item Ids
  • skipped_already_shipped_item_idsSkipped Already Shipped Item Ids
  • failure_categoryFailure Category
  • retryableRetryable
  • errorError

Output schema completeness: best_effort_declared

Safety

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

Schemas

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

Input schema
{
  "type": "object",
  "required": [
    "order_id",
    "patient_id",
    "source_location_id",
    "shipped_date"
  ],
  "properties": {
    "order_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "shipped_date": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "location_type_ids": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "equipment_statuses": {
      "default": [
        "Active",
        "Reserved"
      ],
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "source_location_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "order_id": {},
    "retryable": {},
    "patient_id": {},
    "failure_category": {},
    "shipped_item_ids": {},
    "skipped_already_shipped_item_ids": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions