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.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Start date (YYYY-MM-DD). Defaults to 4 weeks ago
End date (YYYY-MM-DD). Defaults to today
Orders modified on or after a date (YYYY-MM-DD). Modifications include order status updates and refunds
Parameter to sort results by
ORDER_PLACED_TIME_ASC, ORDER_PLACED_TIME_DESC, ORDER_PLACED_TIME_ASC_V2, ORDER_PLACED_TIME_DESC_V2, MODIFIED_ASC, MODIFIED_DESC List of Order Status values to filter by
APPROVAL_NEEDED, APPROVED, CANCELED, PAYMENT_FAILED, SENT_TO_VENDOR, SHIPPED, COMPLETED, TRIAGED List of Order Item Status values to filter by
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 When provided, filters to objects with these IDs.
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.
The maximum number of items to return per page.
1 <= x <= 100Response
OK