> ## Documentation Index > Fetch the complete documentation index at: https://developer.vetcove.com/llms.txt > Use this file to discover all available pages before exploring further. # List Order Analytics > 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. ## OpenAPI ````yaml get /ext/v2/order-analytics/ openapi: 3.1.0 info: description: '' title: NinjaAPI version: 2.0.0 servers: - url: https://connect.vetcove.com/ security: [] paths: /ext/v2/order-analytics/: get: tags: - Orders summary: List Order Analytics description: >- 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. operationId: orders_list parameters: - description: Start date (YYYY-MM-DD). Defaults to 4 weeks ago in: query name: start_date__gte required: false schema: anyOf: - format: date type: string - type: 'null' description: Start date (YYYY-MM-DD). Defaults to 4 weeks ago title: Start Date Gte - description: End date (YYYY-MM-DD). Defaults to today in: query name: end_date__lte required: false schema: anyOf: - format: date type: string - type: 'null' description: End date (YYYY-MM-DD). Defaults to today title: End Date Lte - description: >- Orders modified on or after a date (YYYY-MM-DD). Modifications include order status updates and refunds in: query name: last_modified__gte required: false schema: anyOf: - format: date type: string - type: 'null' description: >- Orders modified on or after a date (YYYY-MM-DD). Modifications include order status updates and refunds title: Last Modified Gte - description: Parameter to sort results by in: query name: sort_by required: false schema: anyOf: - $ref: '#/components/schemas/ExternalOrderAnalyticsSortOptions' - type: 'null' description: Parameter to sort results by - description: List of Order Status values to filter by in: query name: order_statuses required: false schema: anyOf: - items: $ref: '#/components/schemas/OrderStatus' type: array - type: 'null' description: List of Order Status values to filter by title: Order Statuses - description: List of Order Item Status values to filter by in: query name: order_item_statuses required: false schema: anyOf: - items: $ref: '#/components/schemas/OrderItemStatus' type: array - type: 'null' description: List of Order Item Status values to filter by title: Order Item Statuses - description: When provided, filters to objects with these IDs. in: query name: ids required: false schema: anyOf: - items: type: integer type: array - type: 'null' description: When provided, filters to objects with these IDs. title: Ids - description: >- 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`. in: query name: starting_after required: false schema: anyOf: - type: integer - type: 'null' description: >- 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`. title: Starting After - description: The maximum number of items to return per page. in: query name: limit required: false schema: default: 10 description: The maximum number of items to return per page. maximum: 100 minimum: 1 title: Limit type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderList' description: OK security: - ExternalAPIAuth: [] components: schemas: ExternalOrderAnalyticsSortOptions: enum: - ORDER_PLACED_TIME_ASC - ORDER_PLACED_TIME_DESC - ORDER_PLACED_TIME_ASC_V2 - ORDER_PLACED_TIME_DESC_V2 - MODIFIED_ASC - MODIFIED_DESC title: ExternalOrderAnalyticsSortOptions type: string OrderStatus: enum: - APPROVAL_NEEDED - APPROVED - CANCELED - PAYMENT_FAILED - SENT_TO_VENDOR - SHIPPED - COMPLETED - TRIAGED title: OrderStatus type: string OrderItemStatus: enum: - APPROVAL_NEEDED - APPROVED - CLINIC_CANCELED - CLIENT_CANCELED - CLINIC_CANCELED_REFUNDED - CLINIC_CANCELED_CREDITED - FAILED_SEND_TO_VENDOR - SENT_TO_VENDOR - TRIAGED - VENDOR_CANCELED - FULLY_SHIPPED - PARTIALLY_SHIPPED - DELIVERED title: OrderItemStatus type: string OrderList: properties: data: description: A single page of data contained within this list. items: $ref: '#/components/schemas/ExternalOrderAnalyticsSchema' title: Data type: array has_more: default: false description: Whether there are more pages or data in this list. title: Has More type: boolean next_page: description: A URL linking to the next page of this list. title: Next Page type: string type: default: list description: Type of this object. Always `list`. title: Type type: string required: - data - next_page title: OrderList type: object ExternalOrderAnalyticsSchema: properties: cart_id: anyOf: - type: integer - type: 'null' description: Cart ID used to generate the order title: Cart Id charge_capture_date: anyOf: - format: date type: string - type: 'null' description: Date when the payment charge was captured title: Charge Capture Date client_note: anyOf: - type: string - type: 'null' description: Note from the client title: Client Note client_service_fee: description: >- 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. title: Client Service Fee type: number client_type: anyOf: - type: string - type: 'null' description: The classification of the client (e.g. first-time, returning) title: Client Type clinic_client_id: description: ID of the client that placed the order title: Clinic Client Id type: integer clinic_id: description: ID of the clinic that received the order title: Clinic Id type: integer clinic_note: anyOf: - type: string - type: 'null' description: Note from the clinic title: Clinic Note creator_type: anyOf: - type: string - type: 'null' description: How the order was created (e.g. client, clinic) title: Creator Type discount: description: Total discount applied title: Discount type: number display_number: anyOf: - type: string - type: 'null' description: User-facing display number title: Display Number handling_fee: description: Handling fee applied to the order title: Handling Fee type: number id: description: Unique ID of the order title: Id type: integer is_urgent: description: Whether this order was marked as urgent title: Is Urgent type: boolean last_modified: description: Alias for the most recent update time format: date-time title: Last Modified type: string order_item_ids: anyOf: - items: type: integer type: array - type: 'null' description: List of order items included in this order title: Order Item Ids order_placed_datetime: anyOf: - format: date-time type: string - type: 'null' description: Datetime when the order was placed title: Order Placed Datetime payment_method_id: anyOf: - type: integer - type: 'null' description: ID of the payment method used for this order title: Payment Method Id refund_ids: anyOf: - items: type: integer type: array - type: 'null' description: List of refund records associated with this order title: Refund Ids shipping: description: Shipping amount paid by the client on the order title: Shipping type: number shipping_address: anyOf: - $ref: '#/components/schemas/ExternalAddressSchema' - type: 'null' description: Shipping address for the order status: description: Internal status code for the order title: Status type: string status_display: description: Human-readable status for the order title: Status Display type: string subtotal: description: Subtotal amount in dollars title: Subtotal type: number tax: description: Tax amount title: Tax type: number total: description: Total amount charged including fees and tax title: Total type: number transfer_ids: anyOf: - items: type: integer type: array - type: 'null' description: List of transfer records associated with this order title: Transfer Ids urgency_fee: description: Urgency fee amount title: Urgency Fee type: number wholesale_tax: description: Amount paid by clinic in wholesale tax upon item sale to the clinic title: Wholesale Tax type: number required: - id - last_modified - clinic_id - clinic_client_id - subtotal - total - tax - shipping - handling_fee - discount - status - status_display - is_urgent - urgency_fee - wholesale_tax - client_service_fee title: Order type: object ExternalAddressSchema: properties: address_one: description: The first line of the address. maxLength: 100 title: Address One type: string address_two: default: '' description: The second line of the address. maxLength: 100 title: Address Two type: string city: description: The city of the address. maxLength: 100 title: City type: string country: allOf: - $ref: '#/components/schemas/Countries' default: US description: The 2-letter code of the country of the address. county: default: '' description: The county of the address. maxLength: 100 title: County type: string id: description: The ID of the address. title: Id type: integer name: default: '' description: The name of the address. maxLength: 100 title: Name type: string phone_number: anyOf: - type: integer - type: 'null' description: The phone number of the address. title: Phone Number state: description: >- The 2-letter code of the state/province/region of the address. Legacy data could deviate from the 2-letter code convention. title: State type: string zipcode: description: The zip code/postal code of the address. maxLength: 10 title: Zipcode type: string required: - address_one - city - state - zipcode - id title: ExternalAddressSchema type: object Countries: enum: - CA - US - AS - GU - MP - PR - VI title: Countries type: string securitySchemes: ExternalAPIAuth: scheme: bearer type: http ````