BLbluehive-health
Orders

Update an existing order

Changed on

Update order details and associated order items. Allows updating order status, metadata, and modifying order item services.

post/v1/orders/{orderId}

Request

Path parameters

orderIdstring required

The ID of the order to update

Request body

status'order_sent' | 'order_accepted' | 'order_refused' | 'employee_confirmed' | 'order_fulfilled' | 'order_complete'
metadataobject

Arbitrary metadata to update on the order (non-indexed passthrough, <=10KB when JSON stringified)

Response

Default Response

successtrue required
messagestring required
orderIdstring required
orderNumberstring required
updatedFieldsstring[]

Changes

  • a8bcbdf02e33Revision changes
    • warning

      removed the request property

    • warning

      removed the request property //

  • 088f5a47edc2Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property //