TicketUserServices

<back to all web services

RefreshmentsOverviewRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired 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 .xml suffix or ?format=xml

HTTP + 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>