TicketUserServices

RefreshmentsOverviewRequest

**Requires Authentication**
Requires any of the roles:	Admin, TeamAdmin	Required permission:	Sales.Total

The following routes are available for this service:
POST	/sales/refreshments/overview

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefreshmentsKpis:
    revenue: Optional[Decimal] = None
    refunded: Optional[Decimal] = None
    units: Optional[int] = None
    orders: Optional[int] = None
    aov: Optional[Decimal] = None
    units_per_order: Optional[Decimal] = None
    attendance: Optional[int] = None
    per_cap: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KpiDelta:
    abs: Optional[Decimal] = None
    pct: Optional[float] = None
    dir: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefreshmentsDeltas:
    revenue: Optional[KpiDelta] = None
    refunded: Optional[KpiDelta] = None
    units: Optional[KpiDelta] = None
    orders: Optional[KpiDelta] = None
    aov: Optional[KpiDelta] = None
    per_cap: Optional[KpiDelta] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesTrendBucket:
    bucket: Optional[datetime.datetime] = None
    revenue: Optional[Decimal] = None
    tickets: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefreshmentsProduct:
    ticket_type_id: Optional[int] = None
    name: Optional[str] = None
    units: Optional[int] = None
    revenue: Optional[Decimal] = None
    orders: Optional[int] = None
    last_sold_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefreshmentsEventRow:
    event_id: Optional[int] = None
    event_name: Optional[str] = None
    event_date: Optional[datetime.datetime] = None
    revenue: Optional[Decimal] = None
    units: Optional[int] = None
    orders: Optional[int] = None
    attendance: Optional[int] = None
    per_cap: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesHourBucket:
    hour: Optional[int] = None
    revenue: Optional[Decimal] = None
    orders: Optional[int] = None
    tickets: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesDowBucket:
    dow: Optional[int] = None
    revenue: Optional[Decimal] = None
    orders: Optional[int] = None
    tickets: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefreshmentsPaymentMethodRow:
    payment_method_id: Optional[str] = None
    revenue: Optional[Decimal] = None
    units: Optional[int] = None
    orders: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefreshmentsRecentOrder:
    ticket_id: Optional[int] = None
    created_at: Optional[datetime.datetime] = None
    event_name: Optional[str] = None
    amount: Optional[Decimal] = None
    units: Optional[int] = None
    payment_method_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefreshmentsOverviewResult:
    current: Optional[RefreshmentsKpis] = None
    previous: Optional[RefreshmentsKpis] = None
    delta: Optional[RefreshmentsDeltas] = None
    trend: Optional[List[SalesTrendBucket]] = None
    previous_trend: Optional[List[SalesTrendBucket]] = None
    products: Optional[List[RefreshmentsProduct]] = None
    events: Optional[List[RefreshmentsEventRow]] = None
    by_hour_of_day: Optional[List[SalesHourBucket]] = None
    by_day_of_week: Optional[List[SalesDowBucket]] = None
    by_payment_method: Optional[List[RefreshmentsPaymentMethodRow]] = None
    recent_orders: Optional[List[RefreshmentsRecentOrder]] = None
    has_any_data_ever: Optional[bool] = None
    bucket: Optional[str] = None
    freshness_utc: Optional[datetime.datetime] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RefreshmentsOverviewRequest:
    owner_id: Optional[int] = None
    series_id: Optional[int] = None
    from_utc: Optional[datetime.datetime] = None
    to_utc: Optional[datetime.datetime] = None
    compare_from_utc: Optional[datetime.datetime] = None
    compare_to_utc: Optional[datetime.datetime] = None
    bucket: Optional[str] = None
    top_events_limit: Optional[int] = None
    recent_orders_limit: Optional[int] = None

Python RefreshmentsOverviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ownerId: 0,
	seriesId: 0,
	fromUtc: 0001-01-01,
	toUtc: 0001-01-01,
	compareFromUtc: 0001-01-01,
	compareToUtc: 0001-01-01,
	bucket: String,
	topEventsLimit: 0,
	recentOrdersLimit: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	current: 
	{
		revenue: 0,
		refunded: 0,
		units: 0,
		orders: 0,
		aov: 0,
		unitsPerOrder: 0,
		attendance: 0,
		perCap: 0
	},
	previous: 
	{
		revenue: 0,
		refunded: 0,
		units: 0,
		orders: 0,
		aov: 0,
		unitsPerOrder: 0,
		attendance: 0,
		perCap: 0
	},
	delta: 
	{
		revenue: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		refunded: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		units: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		orders: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		aov: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		perCap: 
		{
			abs: 0,
			pct: 0,
			dir: String
		}
	},
	trend: 
	[
		{
			bucket: 0001-01-01,
			revenue: 0,
			tickets: 0
		}
	],
	previousTrend: 
	[
		{
			bucket: 0001-01-01,
			revenue: 0,
			tickets: 0
		}
	],
	products: 
	[
		{
			ticketTypeId: 0,
			name: String,
			units: 0,
			revenue: 0,
			orders: 0,
			lastSoldAt: 0001-01-01
		}
	],
	events: 
	[
		{
			eventId: 0,
			eventName: String,
			eventDate: 0001-01-01,
			revenue: 0,
			units: 0,
			orders: 0,
			attendance: 0,
			perCap: 0
		}
	],
	byHourOfDay: 
	[
		{
			hour: 0,
			revenue: 0,
			orders: 0,
			tickets: 0
		}
	],
	byDayOfWeek: 
	[
		{
			dow: 0,
			revenue: 0,
			orders: 0,
			tickets: 0
		}
	],
	byPaymentMethod: 
	[
		{
			paymentMethodId: String,
			revenue: 0,
			units: 0,
			orders: 0
		}
	],
	recentOrders: 
	[
		{
			ticketId: 0,
			createdAt: 0001-01-01,
			eventName: String,
			amount: 0,
			units: 0,
			paymentMethodId: String
		}
	],
	hasAnyDataEver: False,
	bucket: String,
	freshnessUtc: 0001-01-01,
	statusCode: 0,
	message: String
}