---
title: "List Order Analytics"
method: GET
path: "/ext/v2/order-analytics/"
tags: ["Orders"]
---

# List Order Analytics

`GET /ext/v2/order-analytics/`

## Request

- Base URL: `https://connect.vetcove.com`
- URL: `https://connect.vetcove.com/ext/v2/order-analytics/`
- Auth: HTTP bearer

Returns a paginated list of product orders across all clinics in the organization.

An **order** represents a product purchase placed through the Vetcove platform on behalf of a clinic client (pet parent). Each order is associated with a clinic and client, and contains one or more order items representing the individual products purchased.

## Query parameters

- `start_date__gte` string, date, nullable: Start date (YYYY-MM-DD). Defaults to 4 weeks ago
- `end_date__lte` string, date, nullable: End date (YYYY-MM-DD). Defaults to today
- `last_modified__gte` string, date, nullable: Orders modified on or after a date (YYYY-MM-DD). Modifications include order status updates and refunds
- `sort_by` 'ORDER_PLACED_TIME_ASC' | 'ORDER_PLACED_TIME_DESC' | 'ORDER_PLACED_TIME_ASC_V2' | 'ORDER_PLACED_TIME_DESC_V2' | 'MODIFIED_ASC' | 'MODIFIED_DESC'
- `order_statuses` OrderStatus[], nullable: List of Order Status values to filter by
- `order_item_statuses` OrderItemStatus[], nullable: List of Order Item Status values to filter by
- `ids` integer[], nullable: When provided, filters to objects with these IDs.
- `starting_after` integer, nullable: A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`.
- `limit` integer: The maximum number of items to return per page.

## Response `200`

OK

- OrderList
  - `data` ExternalOrderAnalyticsSchema[], required: A single page of data contained within this list.
    - `cart_id` integer, nullable: Cart ID used to generate the order
    - `charge_capture_date` string, date, nullable: Date when the payment charge was captured
    - `client_note` string, nullable: Note from the client
    - `client_service_fee` number, required: This fee is configured by your clinic and can cover additional expenses such as order processing, administrative support, or compliance costs. Often referred to as 'Service Fees' in your storefront.
    - `client_type` string, nullable: The classification of the client (e.g. first-time, returning)
    - `clinic_client_id` integer, required: ID of the client that placed the order
    - `clinic_id` integer, required: ID of the clinic that received the order
    - `clinic_note` string, nullable: Note from the clinic
    - `creator_type` string, nullable: How the order was created (e.g. client, clinic)
    - `discount` number, required: Total discount applied
    - `display_number` string, nullable: User-facing display number
    - `handling_fee` number, required: Handling fee applied to the order
    - `id` integer, required: Unique ID of the order
    - `is_urgent` boolean, required: Whether this order was marked as urgent
    - `last_modified` string, date-time, required: Alias for the most recent update time
    - `order_item_ids` integer[], nullable: List of order items included in this order
    - `order_placed_datetime` string, date-time, nullable: Datetime when the order was placed
    - `payment_method_id` integer, nullable: ID of the payment method used for this order
    - `refund_ids` integer[], nullable: List of refund records associated with this order
    - `shipping` number, required: Shipping amount paid by the client on the order
    - `shipping_address` ExternalAddressSchema
      - `address_one` string, required: The first line of the address.
      - `address_two` string: The second line of the address.
      - `city` string, required: The city of the address.
      - `country` 'CA' | 'US' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI'
      - `county` string: The county of the address.
      - `id` integer, required: The ID of the address.
      - `name` string: The name of the address.
      - `phone_number` integer, nullable: The phone number of the address.
      - `state` string, required: The 2-letter code of the state/province/region of the address. Legacy data could deviate from the 2-letter code convention.
      - `zipcode` string, required: The zip code/postal code of the address.
    - `status` string, required: Internal status code for the order
    - `status_display` string, required: Human-readable status for the order
    - `subtotal` number, required: Subtotal amount in dollars
    - `tax` number, required: Tax amount
    - `total` number, required: Total amount charged including fees and tax
    - `transfer_ids` integer[], nullable: List of transfer records associated with this order
    - `urgency_fee` number, required: Urgency fee amount
    - `wholesale_tax` number, required: Amount paid by clinic in wholesale tax upon item sale to the clinic
  - `has_more` boolean: Whether there are more pages or data in this list.
  - `next_page` string, required: A URL linking to the next page of this list.
  - `type` string: Type of this object. Always `list`.

---

[API](https://skmtc.dev/vetcove/apis/ninjaapi.md) - [All operations](https://skmtc.dev/vetcove/apis/ninjaapi/llms.txt) - [OpenAPI document](https://skmtc.dev/vetcove/apis/ninjaapi/revisions/4ceaed956e15?raw)