Orders report

Retrieve a report of orders by date range and status.

GET /api/v1/reports/orders

Orders report

cURL

curl --request GET \
  --url https://api.byblend.com/api/v1/reports/orders \
  --header 'Authorization: Bearer <token>'

200

{
  "date_range": "2025-01-01 to 2025-01-31",
  "total_orders": 179,
  "orders_by_status": [
    {
      "status": "received",
      "count": 23
    },
    {
      "status": "data_entry",
      "count": 19
    },
    {
      "status": "shipped",
      "count": 46
    }
  ],
  "orders_by_product": {
    "prescription": [
      {
        "name": "Rapamycin 100mg",
        "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
        "count": 920
      }
    ],
    "non_prescription": [
      {
        "name": "PABA-free sunscreen",
        "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
        "count": 412
      }
    ],
    "order_material": [
      {
        "name": "Q4 2025 information packet",
        "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
        "count": 550
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date · string<date> · required

Start date of the date range to report on

Example:

"2025-01-01"

end_date · string<date> · required

End date of the date range to report on

Example:

"2025-01-31"

include · string

Optional parameter to specify which fields to return in the report (status, count, products). Separate multiple fields with commas.

Example:

"status,count"

Response

200 - application/json

Successful response with order report

date_range · string

Example:

"2025-01-01 to 2025-01-31"

total_orders · integer

Example:

179

orders_by_status · object[]

Show child attributes

orders_by_product · object

Order counts by product

Show child attributes