BLbluehive-health
Orders

Search Order Items

Changed on

Search order items with optional filtering and pagination. Results are sorted by creation date descending.

get/v1/orderItems

Request

Query parameters

pageinteger
pageSizeinteger
idstring

Filter by exact document ID (_id)

orderNumberstring

Filter by exact order number

orderIdstring

Filter by exact order ID

employeeIdstring

Filter by exact employee ID

employerIdstring

Filter by exact employer ID

providerIdstring

Filter by exact provider ID

orderAccessCodestring

Filter by exact order access code

serviceIdstring

Filter by exact service ID within services array

statusstring

Filter by service status within orderItems

idContainsstring

Filter by document ID containing this value (case-insensitive)

orderNumberContainsstring

Filter by order number containing this value (case-insensitive)

orderIdContainsstring

Filter by order ID containing this value (case-insensitive)

employeeIdContainsstring

Filter by employee ID containing this value (case-insensitive)

orderAccessCodeContainsstring

Filter by order access code containing this value (case-insensitive)

sincestring date-time

Filter orderItems created after this time

untilstring date-time

Filter orderItems created before this time

Response

Default Response

Changes

  • a8bcbdf02e33Revision changes
    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property //// from the response with the status

  • d753865b0837Revision changes
    • info

      added the optional property //// to the response with the status