Tenant.public.sales Data.index

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filter[sale_type_id]integerOptional

filter[item_customer_group_id]integerOptional

filter[sell_date_from]string · date-timeOptional

filter[sell_date_to]string · date-timeOptional

filter[item_id]integerOptional

filter[customer_group_id]integerOptional

filter[sale_type_name]string · max: 255Optional

filter[item_name]string · max: 255Optional

filter[customer_group_name]string · max: 255Optional

sortstring · max: 255Optional

per_pageinteger · min: 1 · max: 5000Optional

cursorstringOptional

includestring · max: 255Optional

Responses

200Success

application/json

messageconst: Sales data retrieved successfully.Required

dataarray · min: 1 · max: 1Required

metaany ofRequired

or

stringOptional

linksstringRequired

401

Unauthenticated

application/json

422

Validation error

application/json

get/sales-data

GET /your-tenant/api/v1/sales-data HTTP/1.1
Host: plan.claret.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text",
  "data": [],
  "meta": [],
  "links": "text"
}