Brand
Order
Get Stats

Get Aggregate Order Stats

Returns aggregated counts for orders and prescriptions by states.

Overview

  • Method: GET
  • Path: /brand/order/get-stats
  • Tags: brand

Parameters

No parameters required.

Request Body

No request body required.

Responses

200

Successful response

Content Type: application/json

{
  "numOrdersIncomplete": 123,
  "numOrdersReadyToShip": 123,
  "numOrdersAssignedToPharmacy": 123,
  "numOrdersShipped": 123,
  "numOrdersCancelled": 123,
  "numOrdersPendingReview": 123,
  "numOrdersPendingReviewByPharmacy": 123,
  "numOrdersPendingPrescriptionReceipt": 123,
  "numOrdersAwaitingConsultationRequest": 123,
  "numOrdersAwaitingConsultation": 123,
  "numOrdersPaused": 123,
  "numOrdersAttemptedCall1Week": 123,
  "numPrescriptionsIncompete": 123,
  "numPrescriptionsPendingGeneration": 123,
  "numPrescriptionsPendingReceipt": 123,
  "numPrescriptionsPending": 123,
  "numPrescriptionsApproved": 123,
  "numPrescriptionsRejected": 123,
  "numOrdersQuestionnaireIncomplete": 123,
  "numOrdersQuestionnaireComplete": 123,
  "numOrdersIdComplete": 123,
  "numOrdersInsuranceComplete": 123,
  "numOrdersAwaitingConsultationRequestLessThan24Hours": 123,
  "numOrdersAwaitingConsultation24To48Hours": 123,
  "numOrdersAwaitingConsultationMoreThan48Hours": 123,
  "numOrdersAttemptedCall": 123,
  "numOrdersUnreadMessages": 123,
  "numOrdersUnreadUpdates": 123,
  "numOrdersAssigned": 123,
  "numOrdersUnassigned": 123,
  "numOrdersArchived": 123,
  "numOrdersReadyToFulfill": 123,
  "numOrdersInsuranceValidated": 123,
  "numOrdersRequiresInsuranceValidation": 123,
  "numOrdersSecondAttemptedCall": 123,
  "numOrdersAttemptedConsult": 123,
  "numOrdersSecondAttemptedConsult": 123,
  "numOrdersAttemptedConsult1Week": 123,
  "numOrdersAwaitingCustomerResponse": 123,
  "numOrdersAwaitingPayment": 123
}

400

Bad Request

Content Type: application/json

{
  "error": "string",
  "details": [
    {}
  ]
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X GET \
  https://api.pillexa.com/brand/order/get-stats \
  -H "Content-Type: application/json" \