Brand
Order
Get Stats

Get Stats

GET endpoint for /brand/order/get-stats in brand category

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

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

400

Bad Request

Content Type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "error",
    "details"
  ]
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X GET \
  http://localhost:9000/brand/order/get-stats \
  -H "Content-Type: application/json" \

Interactive Testing

You can test this endpoint interactively in the Swagger UI (opens in a new tab).

Get OrderGet Timeline Events