Skip to main content

Drop-Ship and Direct-Ship via API

Ship an entire order, or individual items on it, through an integrated drop-ship vendor or with your own carrier and tracking number.

These are the Quick-Ship endpoints. In Swagger, find them under Orders / Quick-Ship.


Which One Should I Use?

Method

Use when

Endpoint

Drop ship

A vendor integrated with NikoHealth (e.g. McKesson, Medline, PPM) ships the item to the patient for you

POST /v1/orders/{orderId}/drop-ship

Direct ship

You ship the item yourself from non-inventoried stock and have the carrier and tracking number

POST /v1/orders/{orderId}/direct-ship

💡 Ship everything or pick items. On both endpoints, if you leave out Items, all order items in Pending status are shipped. To ship only some items, list them in Items.


Before You Start: Lookups

What you need

Endpoint

Order item IDs

GET /v1/orders/{orderId}/items

Drop-ship accounts (drop ship only)

GET /v1/orders/dropship/accounts

Drop-Ship Accounts Response

[
{
"id": "string",
"accountNumber": "123456",
"accountType": "string",
"integrationType": "McKesson",
"isDefault": true
}
]

This response uses camelCase field names (accountNumber, integrationType), unlike most NikoHealth responses.


Drop Ship

POST /v1/orders/{orderId}/drop-ship

Sends the order, or selected items, to your drop-ship vendor for fulfillment.

Order-Level Fields

Field

Notes

AccountNumber

The drop-ship account number. Required unless set on every item.

IntegrationType

The drop-ship vendor. Required unless set on every item.

Items

Optional. The specific items to ship, with per-item settings.

Supported IntegrationType Values

VGM, McKesson, PPM, CardinalHealth, Medline, Gemco, Amoena, TwinMed, Milliken, DDP, Mercy, ThreePL, GeriMed, ProMed

Item-Level Fields

Field

Required

Notes

ItemId

✅

The order item ID from GET /v1/orders/{orderId}/items

Qty

Defaults to the item's existing quantity

AccountNumber

Overrides the order-level account for this item

IntegrationType

Overrides the order-level vendor for this item

PurchaseAbbreviation

The vendor's unit-of-measure purchase abbreviation

Notes

Item notes

Example: drop ship the whole order

POST /v1/orders/SO05adce00ef4b092b90f42f97b2ec3e36/drop-ship
{
"AccountNumber": "123456",
"IntegrationType": "McKesson"
}

Example: drop ship selected items, split across vendors

{
"Items": [
{
"ItemId": "UN05adce00ef4b39680ac425a3882b0190",
"Qty": 2,
"AccountNumber": "123456",
"IntegrationType": "McKesson"
},
{
"ItemId": "UN43944100153bc51b8444d45b07c841c0",
"AccountNumber": "789012",
"IntegrationType": "Medline",
"Notes": "Ship with signature required"
}
]
}

Response: 200 OK


Direct Ship

POST /v1/orders/{orderId}/direct-ship

Records that you shipped the order, or selected items, yourself from non-inventoried stock.

Order-Level Fields

Field

Notes

Carrier

The carrier code. Required unless set on every item.

TrackingNumber

Required unless set on every item.

Date

The shipping date, YYYY-MM-DD. Required unless set on every item.

Items

Optional. The specific items to ship, with per-item settings.

📦 Tracking updates are only supported for UPS, USPS, and FedEx. Other carriers can be recorded, but NikoHealth won't pull tracking status for them.

Item-Level Fields

Field

Required

Notes

ItemId

✅

The order item ID

Qty

Defaults to the item's existing quantity

Carrier

Overrides the order-level carrier

TrackingNumber

Overrides the order-level tracking number

Date

Overrides the order-level ship date

SerialNumber

For serialized products

LotNumber

For lotted products

Components

Component details for bundle products

Notes

Item notes

Example: direct ship the whole order

POST /v1/orders/SO05adce00ef4b092b90f42f97b2ec3e36/direct-ship
{
"Carrier": "UPS",
"TrackingNumber": "1Z999AA10123456784",
"Date": "2026-11-10"
}

Example: direct ship a serialized item in its own package

{
"Items": [
{
"ItemId": "UN05adce00ef4b39680ac425a3882b0190",
"Carrier": "FedEx",
"TrackingNumber": "794600000000",
"Date": "2026-11-10",
"SerialNumber": "SN-0012345"
}
]
}

Response: 200 OK


After Shipping

  • Check the shipping status and tracking with GET /v1/orders/{orderId}/items. Shipped items include a Shipped block with Carrier, TrackingNumber, and ShippedDate.

  • Mark items delivered with PUT /v1/orders/{orderId}/items/{itemId}/status.

  • Subscribe to the order.item.updated webhook to be notified when an item's status changes.


Common Errors

Code

Meaning

400

Invalid request, e.g. a missing AccountNumber/IntegrationType (drop ship) or Carrier/TrackingNumber/Date (direct ship), or an item that isn't in a shippable status

401

Token missing, expired, or invalid

403

You don't have permission to access this resource

404

Order or item not found

429

Too many requests


Related articles

Did this answer your question?