| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Sales.Total |
| POST | /sales/refreshments/overview |
|---|
export class RefreshmentsKpis
{
public revenue?: number;
public refunded?: number;
public units?: number;
public orders?: number;
public aov?: number;
public unitsPerOrder?: number;
public attendance?: number;
public perCap?: number;
public constructor(init?: Partial<RefreshmentsKpis>) { (Object as any).assign(this, init); }
}
export class KpiDelta
{
public abs?: number;
public pct?: number;
public dir?: string;
public constructor(init?: Partial<KpiDelta>) { (Object as any).assign(this, init); }
}
export class RefreshmentsDeltas
{
public revenue?: KpiDelta;
public refunded?: KpiDelta;
public units?: KpiDelta;
public orders?: KpiDelta;
public aov?: KpiDelta;
public perCap?: KpiDelta;
public constructor(init?: Partial<RefreshmentsDeltas>) { (Object as any).assign(this, init); }
}
export class SalesTrendBucket
{
public bucket?: string;
public revenue?: number;
public tickets?: number;
public constructor(init?: Partial<SalesTrendBucket>) { (Object as any).assign(this, init); }
}
export class RefreshmentsProduct
{
public ticketTypeId?: number;
public name?: string;
public units?: number;
public revenue?: number;
public orders?: number;
public lastSoldAt?: string;
public constructor(init?: Partial<RefreshmentsProduct>) { (Object as any).assign(this, init); }
}
export class RefreshmentsEventRow
{
public eventId?: number;
public eventName?: string;
public eventDate?: string;
public revenue?: number;
public units?: number;
public orders?: number;
public attendance?: number;
public perCap?: number;
public constructor(init?: Partial<RefreshmentsEventRow>) { (Object as any).assign(this, init); }
}
export class SalesHourBucket
{
public hour?: number;
public revenue?: number;
public orders?: number;
public tickets?: number;
public constructor(init?: Partial<SalesHourBucket>) { (Object as any).assign(this, init); }
}
export class SalesDowBucket
{
public dow?: number;
public revenue?: number;
public orders?: number;
public tickets?: number;
public constructor(init?: Partial<SalesDowBucket>) { (Object as any).assign(this, init); }
}
export class RefreshmentsPaymentMethodRow
{
public paymentMethodId?: string;
public revenue?: number;
public units?: number;
public orders?: number;
public constructor(init?: Partial<RefreshmentsPaymentMethodRow>) { (Object as any).assign(this, init); }
}
export class RefreshmentsRecentOrder
{
public ticketId?: number;
public createdAt?: string;
public eventName?: string;
public amount?: number;
public units?: number;
public paymentMethodId?: string;
public constructor(init?: Partial<RefreshmentsRecentOrder>) { (Object as any).assign(this, init); }
}
export class RefreshmentsOverviewResult
{
public current?: RefreshmentsKpis;
public previous?: RefreshmentsKpis;
public delta?: RefreshmentsDeltas;
public trend?: SalesTrendBucket[];
public previousTrend?: SalesTrendBucket[];
public products?: RefreshmentsProduct[];
public events?: RefreshmentsEventRow[];
public byHourOfDay?: SalesHourBucket[];
public byDayOfWeek?: SalesDowBucket[];
public byPaymentMethod?: RefreshmentsPaymentMethodRow[];
public recentOrders?: RefreshmentsRecentOrder[];
public hasAnyDataEver?: boolean;
public bucket?: string;
public freshnessUtc?: string;
public statusCode?: number;
public message?: string;
public constructor(init?: Partial<RefreshmentsOverviewResult>) { (Object as any).assign(this, init); }
}
export class RefreshmentsOverviewRequest
{
public ownerId?: number;
public seriesId?: number;
public fromUtc?: string;
public toUtc?: string;
public compareFromUtc?: string;
public compareToUtc?: string;
public bucket?: string;
public topEventsLimit?: number;
public recentOrdersLimit?: number;
public constructor(init?: Partial<RefreshmentsOverviewRequest>) { (Object as any).assign(this, init); }
}
TypeScript RefreshmentsOverviewRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sales/refreshments/overview HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<RefreshmentsOverviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<Bucket>String</Bucket>
<CompareFromUtc>0001-01-01T00:00:00</CompareFromUtc>
<CompareToUtc>0001-01-01T00:00:00</CompareToUtc>
<FromUtc>0001-01-01T00:00:00</FromUtc>
<OwnerId>0</OwnerId>
<RecentOrdersLimit>0</RecentOrdersLimit>
<SeriesId>0</SeriesId>
<ToUtc>0001-01-01T00:00:00</ToUtc>
<TopEventsLimit>0</TopEventsLimit>
</RefreshmentsOverviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RefreshmentsOverviewResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<Bucket>String</Bucket>
<ByDayOfWeek>
<SalesDowBucket>
<Dow>0</Dow>
<Orders>0</Orders>
<Revenue>0</Revenue>
<Tickets>0</Tickets>
</SalesDowBucket>
</ByDayOfWeek>
<ByHourOfDay>
<SalesHourBucket>
<Hour>0</Hour>
<Orders>0</Orders>
<Revenue>0</Revenue>
<Tickets>0</Tickets>
</SalesHourBucket>
</ByHourOfDay>
<ByPaymentMethod>
<RefreshmentsPaymentMethodRow>
<Orders>0</Orders>
<PaymentMethodId>String</PaymentMethodId>
<Revenue>0</Revenue>
<Units>0</Units>
</RefreshmentsPaymentMethodRow>
</ByPaymentMethod>
<Current>
<Aov>0</Aov>
<Attendance>0</Attendance>
<Orders>0</Orders>
<PerCap>0</PerCap>
<Refunded>0</Refunded>
<Revenue>0</Revenue>
<Units>0</Units>
<UnitsPerOrder>0</UnitsPerOrder>
</Current>
<Delta>
<Aov>
<Abs>0</Abs>
<Dir>String</Dir>
<Pct>0</Pct>
</Aov>
<Orders>
<Abs>0</Abs>
<Dir>String</Dir>
<Pct>0</Pct>
</Orders>
<PerCap>
<Abs>0</Abs>
<Dir>String</Dir>
<Pct>0</Pct>
</PerCap>
<Refunded>
<Abs>0</Abs>
<Dir>String</Dir>
<Pct>0</Pct>
</Refunded>
<Revenue>
<Abs>0</Abs>
<Dir>String</Dir>
<Pct>0</Pct>
</Revenue>
<Units>
<Abs>0</Abs>
<Dir>String</Dir>
<Pct>0</Pct>
</Units>
</Delta>
<Events>
<RefreshmentsEventRow>
<Attendance>0</Attendance>
<EventDate>0001-01-01T00:00:00</EventDate>
<EventId>0</EventId>
<EventName>String</EventName>
<Orders>0</Orders>
<PerCap>0</PerCap>
<Revenue>0</Revenue>
<Units>0</Units>
</RefreshmentsEventRow>
</Events>
<FreshnessUtc>0001-01-01T00:00:00</FreshnessUtc>
<HasAnyDataEver>false</HasAnyDataEver>
<Message>String</Message>
<Previous>
<Aov>0</Aov>
<Attendance>0</Attendance>
<Orders>0</Orders>
<PerCap>0</PerCap>
<Refunded>0</Refunded>
<Revenue>0</Revenue>
<Units>0</Units>
<UnitsPerOrder>0</UnitsPerOrder>
</Previous>
<PreviousTrend>
<SalesTrendBucket>
<Bucket>0001-01-01T00:00:00</Bucket>
<Revenue>0</Revenue>
<Tickets>0</Tickets>
</SalesTrendBucket>
</PreviousTrend>
<Products>
<RefreshmentsProduct>
<LastSoldAt>0001-01-01T00:00:00</LastSoldAt>
<Name>String</Name>
<Orders>0</Orders>
<Revenue>0</Revenue>
<TicketTypeId>0</TicketTypeId>
<Units>0</Units>
</RefreshmentsProduct>
</Products>
<RecentOrders>
<RefreshmentsRecentOrder>
<Amount>0</Amount>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<EventName>String</EventName>
<PaymentMethodId>String</PaymentMethodId>
<TicketId>0</TicketId>
<Units>0</Units>
</RefreshmentsRecentOrder>
</RecentOrders>
<StatusCode>0</StatusCode>
<Trend>
<SalesTrendBucket>
<Bucket>0001-01-01T00:00:00</Bucket>
<Revenue>0</Revenue>
<Tickets>0</Tickets>
</SalesTrendBucket>
</Trend>
</RefreshmentsOverviewResult>