BLbluehive-health
Orders

Send Order for Employee

Changed on

Send an order for a specific employee. Requires API key, login token, and user ID. This endpoint specifically handles employer-to-employee order sending.

post/v1/orders/send

Request

Headers

authorizationstring required

Bearer <API_KEY>

login-tokenstring required

User login token

user-idstring required

User ID

Request body

employeeIdstring required

Employee ID to send order to

employerIdstring required

Employer ID sending the order

servicesIdsstring[] required

Array of service IDs to include in the order

quantitiesobject

Service ID to quantity mapping

providerIdstring

Single provider ID (shortcut when all services map to one provider)

brandIdstring

Brand ID for branded orders

dueDatestring

Due date for the order (date or date-time ISO string)

dueDatesstring[]

Array of due dates per service

providerCreatedboolean

Whether this order is being created by a provider (affects permission checking)

metadataobject

Optional arbitrary metadata to store on the order (non-indexed passthrough, <=10KB when JSON stringified)

priority'normal' | 'high'

Order priority level

Response

Order sent successfully (single or split)

OR

Changes

  • a8bcbdf02e33Revision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      removed the non-success response with the status

  • cbee4fee80fbRevision changes
    • info

      added the new optional request property