NikoHealth integration

Create Sales Order (Generic)

Perform Create Sales Order (Generic) through NikoHealth.

View as Markdown

nikohealth_create_sales_order_generic

writenikohealth

Inputs

order_start_date
expressionrequired
Order Start Date
Required literal value or workflow expression.
patient_id
expressionrequired
Patient Id
Required literal value or workflow expression.
service_location_id
textrequired
Service Location Id
Required text value.
items
expressionrequired
Items
Required literal value or workflow expression.
delivery_type
selectrequired
Delivery Type
Required selected identifier or value.
Default: "1"
Options: Ship (Home Delivery) ("1"), In-Store Pickup ("2")
ship_to
expression
Ship To
Optional literal value or workflow expression.
delivery_address_line
expression
Delivery Address Line
Optional literal value or workflow expression.
delivery_address_line_2
expression
Delivery Address Line 2
Optional literal value or workflow expression.
delivery_city
expression
Delivery City
Optional literal value or workflow expression.
delivery_state
expression
Delivery State
Optional literal value or workflow expression.
delivery_zip
expression
Delivery Zip
Optional literal value or workflow expression.
pickup_location_id
expression
Pickup Location Id
Optional literal value or workflow expression.
order_tag_ids
expression
Order Tag Ids
Optional literal value or workflow expression.
description
expression
Description
Optional literal value or workflow expression.
referring_provider_npi
expression
Referring Provider Npi
Optional literal value or workflow expression.
diagnosis_codes
expression
Diagnosis Codes
Optional literal value or workflow expression.
length_of_need
expression
Length Of Need
Optional literal value or workflow expression.

Outputs

successSuccess
order_idOrder Id
order_urlOrder Url
patient_idPatient Id
service_location_idService Location Id
item_countItem Count
tag_idsTag Ids
referring_provider_attach_skipped_reasonReferring Provider Attach Skipped Reason
failure_categoryFailure Category
status_codeStatus Code
correlation_idCorrelation Id
error_typeError Type
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": [
    "order_start_date",
    "patient_id",
    "service_location_id",
    "items",
    "delivery_type"
  ],
  "properties": {
    "items": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "ship_to": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "description": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "delivery_zip": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "delivery_city": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "delivery_type": {
      "enum": [
        "1",
        "2"
      ],
      "type": "string",
      "default": "1",
      "description": "Required selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "order_tag_ids": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "delivery_state": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "length_of_need": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "diagnosis_codes": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "order_start_date": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "pickup_location_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "service_location_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "delivery_address_line": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "referring_provider_npi": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "delivery_address_line_2": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "tag_ids": {},
    "order_id": {},
    "order_url": {},
    "error_type": {},
    "item_count": {},
    "patient_id": {},
    "status_code": {},
    "correlation_id": {},
    "failure_category": {},
    "service_location_id": {},
    "referring_provider_attach_skipped_reason": {}
  },
  "additionalProperties": true
}

View all NikoHealth actions