Special/Bulk Order Webhooks

Webhooks for special and bulk orders can be configured on the Client Home screen of the Tenovi web app to relay information to your systems. This data is sent at a POST request with the JSON schema outlined below. These webhooks are separate from the normal fulfillment webhooks that send payloads for devices dropshipped by Tenovi.

Order Types

Any order in the Special Orders screen of the Tenovi web app will send webhook payloads. This includes supply, bulk, replacement, return labels, and demo units.

Special Order Webhook Structure

Parameter	Description
request_id	The root order id (for ASR plans, equivalent to the ID returned on the Supply Request creation)
order_number	The Special Order number shown on the Tenovi Web App
order_type	The Special Order type: DE = Demo BU = Bulk SU = Supplies RE = Replacement RL = Return Label
hardware_uuid	The related Gateway ID or IMEI, if applicable
client_device_id	The ID of the ClientDevice associated with this order, if applicable
patient_id	The External Patient ID associated with this device, if it was provided when the device was requested (see Activating/Requesting Devices)
status	Readable order status: Pending Shipped Delivered Returned
created_on	The date & time the order was requested, in YYYY-MM-DDTHH:MM:SS.ssssssZ format
updated_on	The date & time the order was last updated, in YYYY-MM-DDTHH:MM:SS.ssssssZ format
tracking_link	The tracking link for this order, if it has been shipped
contents	An array of objects describing what is in the Special Order
contents.name	The name of the included device/supply item. See our Device Overview page for a complete listing of avaiable device types and our Supply Types API endpoint for relevant supply types.
contents.quantity	The quantity
contents.kit_id	The Kit ID, if applicable (applies to Bulk Orders only)
manifest	An object containing details on Gateway and IMEIs included in the Special Order
manifest.gateway_ids	An array of Gateway IDs for the included Gateways (applies to Bulk Orders only)
manifest.imeis	An array of IMEIs for the included cellular devices (applies to Bulk Orders only)

Example JSON Payloads

Below are examples of JSON payloads for supply orders and bulk orders. You can send test data using the Testing Tools on the Client Home Screen and using API calls.

Supply Order

{
  "request_id": "12345678-abcd-1234-abcd-1234567890ab"
  "order_number": "240123",
  "order_type": "SU",
  "hardware_uuid": "1234abcd5678",
  "client_device_id": "12345678-abcd-1234-abcd-1234567890ab",
  "patient_id": "12345",
  "status": "Pending",
  "created_on": "2024-05-11T12:00:00.000000Z",
  "updated_on": "2024-05-11T12:00:00.000000Z",
  "tracking_link": "https://tools.usps.com/",
  "contents": [
    {
      "name": "Glucometer Strips",
      "quantity: 1,
      "kit_id": 0,
    }
  ]
}

Bulk Order

{
  "request_id": "12345678-abcd-1234-abcd-1234567890ab"
  "order_number": "240123",
  "order_type": "BU",
  "hardware_uuid": "1234abcd5678",
  "client_device_id": "12345678-abcd-1234-abcd-1234567890ab",
  "patient_id": "12345",
  "status": "Pending",
  "created_on": "2024-05-11T12:00:00.000000Z",
  "updated_on": "2024-05-11T12:00:00.000000Z",
  "tracking_link": "https://tools.usps.com/",
  "contents": [
    {
      "name": "Tenovi BPM - L",
      "quantity: 5,
      "kit_id": 0,
    }
  ],
    "manifest": [
        "gateway_ids": [
            "1234ABCD1234",
            "4567CDEF4567",
            "123443212344",
            "5436234664EF",
            "1239CDEAA011"
        ],
    ]
}