Get Top Selling Items

Get top selling items based on the number of times they were purchased. Returns the top items sorted by purchase count.

get/dashboard/top-selling-items

Request

Base URL
https://docs.decodahealth.com (the document declares no server; this is the origin it was published from)
Auth
none declared. Required headers: TENANT, API-KEY
TypeScript
https://skmtc.dev/decodahealth/apis/decoda-api/docs/dashboard/top-selling-items/get.ts
A function with typed inputs. Its response is checked against the schema.

pageinteger nullable

per_pageinteger nullable

sort_bystring nullable

sort_direction'asc' | 'desc' nullable

location_idstring nullable

start_datestring required

end_datestring required

location_idsstring[] nullable

payment_mediumsstring[] nullable

tzstring required

limitinteger nullable

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Successful Response

idstring required

namestring required

descriptionstring nullable

pricenumber required

totalQuantityinteger required

numberOfPurchasesinteger required

totalRevenuenumber required

averageQuantityPerPurchasenumber required

No recorded changes to this operation across all 2 revisions of this API.