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 Foundation
import ServiceStack

public class RefreshmentsOverviewRequest : Codable
{
    public var ownerId:Int?
    public var seriesId:Int?
    public var fromUtc:Date?
    public var toUtc:Date?
    public var compareFromUtc:Date?
    public var compareToUtc:Date?
    public var bucket:String?
    public var topEventsLimit:Int?
    public var recentOrdersLimit:Int?

    required public init(){}
}

public class RefreshmentsOverviewResult : Codable
{
    public var current:RefreshmentsKpis?
    public var previous:RefreshmentsKpis?
    public var delta:RefreshmentsDeltas?
    public var trend:[SalesTrendBucket] = []
    public var previousTrend:[SalesTrendBucket] = []
    public var products:[RefreshmentsProduct] = []
    public var events:[RefreshmentsEventRow] = []
    public var byHourOfDay:[SalesHourBucket] = []
    public var byDayOfWeek:[SalesDowBucket] = []
    public var byPaymentMethod:[RefreshmentsPaymentMethodRow] = []
    public var recentOrders:[RefreshmentsRecentOrder] = []
    public var hasAnyDataEver:Bool?
    public var bucket:String?
    public var freshnessUtc:Date?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class RefreshmentsKpis : Codable
{
    public var revenue:Double?
    public var refunded:Double?
    public var units:Int?
    public var orders:Int?
    public var aov:Double?
    public var unitsPerOrder:Double?
    public var attendance:Int?
    public var perCap:Double?

    required public init(){}
}

public class RefreshmentsDeltas : Codable
{
    public var revenue:KpiDelta?
    public var refunded:KpiDelta?
    public var units:KpiDelta?
    public var orders:KpiDelta?
    public var aov:KpiDelta?
    public var perCap:KpiDelta?

    required public init(){}
}

public class KpiDelta : Codable
{
    public var abs:Double?
    public var pct:Double?
    public var dir:String?

    required public init(){}
}

public class SalesTrendBucket : Codable
{
    public var bucket:Date?
    public var revenue:Double?
    public var tickets:Int?

    required public init(){}
}

public class RefreshmentsProduct : Codable
{
    public var ticketTypeId:Int?
    public var name:String?
    public var units:Int?
    public var revenue:Double?
    public var orders:Int?
    public var lastSoldAt:Date?

    required public init(){}
}

public class RefreshmentsEventRow : Codable
{
    public var eventId:Int?
    public var eventName:String?
    public var eventDate:Date?
    public var revenue:Double?
    public var units:Int?
    public var orders:Int?
    public var attendance:Int?
    public var perCap:Double?

    required public init(){}
}

public class SalesHourBucket : Codable
{
    public var hour:Int?
    public var revenue:Double?
    public var orders:Int?
    public var tickets:Int?

    required public init(){}
}

public class SalesDowBucket : Codable
{
    public var dow:Int?
    public var revenue:Double?
    public var orders:Int?
    public var tickets:Int?

    required public init(){}
}

public class RefreshmentsPaymentMethodRow : Codable
{
    public var paymentMethodId:String?
    public var revenue:Double?
    public var units:Int?
    public var orders:Int?

    required public init(){}
}

public class RefreshmentsRecentOrder : Codable
{
    public var ticketId:Int?
    public var createdAt:Date?
    public var eventName:String?
    public var amount:Double?
    public var units:Int?
    public var paymentMethodId:String?

    required public init(){}
}

Swift RefreshmentsOverviewRequest DTOs

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

HTTP + CSV

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

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

HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","revenue":0,"tickets":0}],"previousTrend":[{"bucket":"0001-01-01T00:00:00.0000000","revenue":0,"tickets":0}],"products":[{"ticketTypeId":0,"name":"String","units":0,"revenue":0,"orders":0,"lastSoldAt":"0001-01-01T00:00:00.0000000"}],"events":[{"eventId":0,"eventName":"String","eventDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","eventName":"String","amount":0,"units":0,"paymentMethodId":"String"}],"hasAnyDataEver":false,"bucket":"String","freshnessUtc":"0001-01-01T00:00:00.0000000","statusCode":0,"message":"String"}