VEvetcove
Orders

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.

get/ext/v2/order-analytics/

Request

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

Query parameters

start_date__gtestring date nullable

Start date (YYYY-MM-DD). Defaults to 4 weeks ago

end_date__ltestring date nullable

End date (YYYY-MM-DD). Defaults to today

last_modified__gtestring 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'

Parameter to sort results by

order_statusesOrderStatus[] nullable

List of Order Status values to filter by

order_item_statusesOrderItemStatus[] nullable

List of Order Item Status values to filter by

idsinteger[] nullable

When provided, filters to objects with these IDs.

starting_afterinteger 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.

limitinteger

The maximum number of items to return per page.

Response

OK

has_moreboolean

Whether there are more pages or data in this list.

next_pagestring required

A URL linking to the next page of this list.

typestring

Type of this object. Always list.

Changes

No recorded changes to this operation across all 1 revision of this API.