Global

Members

(constant) crypto

QSR Class File
Author:
  • Steve Ostopchuck
Source:

(constant) crypto

QSR Class File
Author:
  • Steve Ostopchuck
Source:

Type Definitions

CustomValues

Type:
  • Object
Properties:
Name Type Description
Name string Name of the guest custom record.
Value string Value of the guest custom record.
Source:

CustomValues

Type:
  • Object
Properties:
Name Type Description
Name string Name of the guest custom record.
Value string Value of the guest custom record.
Source:

Days

Type:
  • Object
Properties:
Name Type Description
ID string Identifier for the Day record.
Schedule Array.<Sessions> Collection of schedule data.
Session string Name of the corresponding session.
StartTime string Beginning time of the operating period, in ISO 8601 format.
Status string Operating status of the operating period. The following are considered accepted values: ‘Open’, ‘Closed’ and ‘Unknown’.
Source:

Days

Type:
  • Object
Properties:
Name Type Description
ID string Identifier for the Day record.
Schedule Array.<Sessions> Collection of schedule data.
Session string Name of the corresponding session.
StartTime string Beginning time of the operating period, in ISO 8601 format.
Status string Operating status of the operating period. The following are considered accepted values: ‘Open’, ‘Closed’ and ‘Unknown’.
Source:

FloorPlanSnapshot

Type:
  • Object
Properties:
Name Type Description
Name string Name of the floorplan.
UID string Globally unique identifier of the floorplan record.
Source:

FloorPlanSnapshot

Type:
  • Object
Properties:
Name Type Description
Name string Name of the floorplan.
UID string Globally unique identifier of the floorplan record.
Source:

GetPartnerSites

Type:
  • Object
Properties:
Name Type Description
PageData string Content of the page.
SiteUID string Globally unique identifier for a site. This is provided by QSR.
ExternalSiteID string External ID of the site.
HasMore boolean Indicates if additional page(s) are available. True or False.
Token string A token which can be provided as the Token URL parameter to retrieve the next page of sites.
Source:

GetPartnerSites

Type:
  • Object
Properties:
Name Type Description
PageData string Content of the page.
SiteUID string Globally unique identifier for a site. This is provided by QSR.
ExternalSiteID string External ID of the site.
HasMore boolean Indicates if additional page(s) are available. True or False.
Token string A token which can be provided as the Token URL parameter to retrieve the next page of sites.
Source:

Guest

QSR guest record.
Type:
  • Object
Properties:
Name Type Description
Addresses Array.<GuestAddress> Collection of GuestAddress objects representing the guest address records.
CustomValues Array.<GuestCustomValue> Collection of GuestCustomValue objects representing the guest custom value.
Email string Email.
FirstName string First name.
ID string A globally unique identifier for a QSR guest record.
IsAnonymous boolean Is anonymous guest record.
IsSubscribedToEmailMarketing boolean Flag to indicate whether a guest subscribes to email marketing.
IsSubscribedToQsrMarketing boolean Flag to indicate whether a guest subscribes to QSR’s marketing.
IsSubscribedtoSmsMarketing boolean Flag to indicate whether a guest subscribes to SMS marketing.
LastName string Last name.
Loyalty GuestLoyalty Guest loyalty info.
Notes string Notes.
PhoneNumbers Array.<GuestPhoneNumber> Collection of GuestPhoneNumber objects representing the guest phone number records.
NotificationType string Set NotificationType to 'None 'or 'SMS' to indicate guest's notification preference.
Source:

Guest

QSR guest record.
Type:
  • Object
Properties:
Name Type Description
Addresses Array.<GuestAddress> Collection of GuestAddress objects representing the guest address records.
CustomValues Array.<GuestCustomValue> Collection of GuestCustomValue objects representing the guest custom value.
Email string Email.
FirstName string First name.
ID string A globally unique identifier for a QSR guest record.
IsAnonymous boolean Is anonymous guest record.
IsSubscribedToEmailMarketing boolean Flag to indicate whether a guest subscribes to email marketing.
IsSubscribedToQsrMarketing boolean Flag to indicate whether a guest subscribes to QSR’s marketing.
IsSubscribedtoSmsMarketing boolean Flag to indicate whether a guest subscribes to SMS marketing.
LastName string Last name.
Loyalty GuestLoyalty Guest loyalty info.
Notes string Notes.
PhoneNumbers Array.<GuestPhoneNumber> Collection of GuestPhoneNumber objects representing the guest phone number records.
NotificationType string Set NotificationType to 'None 'or 'SMS' to indicate guest's notification preference.
Source:

GuestAddress

Type:
  • Object
Properties:
Name Type Description
Address string Address.
Address2 string Address line 2.
City string City.
County string County.
Postal string Postal.
State string State.
Country string Country.
Sort number Sort order.
Source:

GuestAddress

Type:
  • Object
Properties:
Name Type Description
Address string Address.
Address2 string Address line 2.
City string City.
County string County.
Postal string Postal.
State string State.
Country string Country.
Sort number Sort order.
Source:

GuestCustomValue

Type:
  • Object
Properties:
Name Type Description
Name string Name of the guest custom record.
Value string Value of the guest custom record.
Source:

GuestCustomValue

Type:
  • Object
Properties:
Name Type Description
Name string Name of the guest custom record.
Value string Value of the guest custom record.
Source:

GuestLoyalty

Type:
  • Object
Properties:
Name Type Description
LoyaltyCardID string Loyalty card ID
Source:

GuestLoyalty

Type:
  • Object
Properties:
Name Type Description
LoyaltyCardID string Loyalty card ID
Source:

GuestPhoneNumber

Type:
  • Object
Properties:
Name Type Description
ID string A globally unique identifier for a QSR guest phone record.
PhoneNumber string Phone number.
PhoneNumberString string Formatted phone number string..
Type string Type of phone number. The following are considered acceptable values: Mobile, Home, Work, Other.
Sort number Sort order.
Source:

GuestPhoneNumber

Type:
  • Object
Properties:
Name Type Description
ID string A globally unique identifier for a QSR guest phone record.
PhoneNumber string Phone number.
PhoneNumberString string Formatted phone number string..
Type string Type of phone number. The following are considered acceptable values: Mobile, Home, Work, Other.
Sort number Sort order.
Source:

OperatingInfo

Type:
  • Object
Properties:
Name Type Description
Days Array.<Days> Collection of operating days data.
Sessions Array.<Sessions> Collection of Sessions data. See Sessions.
Session string Name of the corresponding session.
StartTime string Beginning time of the operating period, in ISO 8601 format.
Status string Operating status of the operating period. The following are considered accepted values: ‘Open’, ‘Closed’ and ‘Unknown’.
Source:

OperatingInfo

Type:
  • Object
Properties:
Name Type Description
Days Array.<Days> Collection of operating days data.
Sessions Array.<Sessions> Collection of Sessions data. See Sessions.
Session string Name of the corresponding session.
StartTime string Beginning time of the operating period, in ISO 8601 format.
Status string Operating status of the operating period. The following are considered accepted values: ‘Open’, ‘Closed’ and ‘Unknown’.
Source:

PartyMix

Type:
  • Object
Properties:
Name Type Description
ID string Globally unique identifier of a site.
IID number Integer ID.
LastUpdate string The timestamp of the last update in ISO 8601 format.
ServerLastUpdate string Server last update timestamp of the event in ISO 8601 format.
Guest Array.<Guest> Collection of Guest.
GuestID string Unique identifier of a guest record.
Type string The type of.
Status string The current status of.
Size number Cover count.
SeatedTables Array.<SeatedTables> Collection of SeatedTables.
PreassignedTables Array.<VisitPreassignedTable> Collection of VisitPreassignedTable
Quote Quote Quote related information.
CreationTime string The creation timestamp of
EstimatedArrivalTime string Reservation time in ISO 8601 format.
ArrivalTime string Arrival time in ISO 8601 format.
PagedTime string Paged time in ISO 8601 format.
SeatedTime string Seated time in ISO 8601 format.
CompletedTime string Completed time in ISO 8601 format.
CanceledTime string Reservation cancellation timestamp in ISO 8601 format.
ConfirmationNumber string Confirmation number.
ConfirmationNumberId number Integer identifier of the visit confirmation number.
SeatingAreaId string A globally unique identifier for a QSR seating area.
SeatingAreaName string Seating area name.
Notes string Notes.
CustomValues Array.<CustomValues> Collection of CustomValues.
ExternalID string External ID.
PartyMix string Type and count of the party mixes.
Mixes Array.<VisitPartyMixEntry> Collection of VisitPartyMixEntry.
Source:

PartyMix

Type:
  • Object
Properties:
Name Type Description
ID string Globally unique identifier of a site.
IID number Integer ID.
LastUpdate string The timestamp of the last update in ISO 8601 format.
ServerLastUpdate string Server last update timestamp of the event in ISO 8601 format.
Guest Array.<Guest> Collection of Guest.
GuestID string Unique identifier of a guest record.
Type string The type of.
Status string The current status of.
Size number Cover count.
SeatedTables Array.<SeatedTables> Collection of SeatedTables.
PreassignedTables Array.<VisitPreassignedTable> Collection of VisitPreassignedTable
Quote Quote Quote related information.
CreationTime string The creation timestamp of
EstimatedArrivalTime string Reservation time in ISO 8601 format.
ArrivalTime string Arrival time in ISO 8601 format.
PagedTime string Paged time in ISO 8601 format.
SeatedTime string Seated time in ISO 8601 format.
CompletedTime string Completed time in ISO 8601 format.
CanceledTime string Reservation cancellation timestamp in ISO 8601 format.
ConfirmationNumber string Confirmation number.
ConfirmationNumberId number Integer identifier of the visit confirmation number.
SeatingAreaId string A globally unique identifier for a QSR seating area.
SeatingAreaName string Seating area name.
Notes string Notes.
CustomValues Array.<CustomValues> Collection of CustomValues.
ExternalID string External ID.
PartyMix string Type and count of the party mixes.
Mixes Array.<VisitPartyMixEntry> Collection of VisitPartyMixEntry.
Source:

PrecalculatedQuote

Type:
  • Object
Properties:
Name Type Description
quoteLow number Low quote range value as determined by your quote settings.
quoteHigh number High quote range value as determined by your quote settings.
siteQuoteString string "Exact Quote Label" configured for the quote time.
consumerQuoteString string "Quote Range Label" configured for the quote time.
exactQuote number Exact quote value generated by the system.
checkBackTime number Unused by QSR applications .Configurable value to provide to party to check back on.
autoNoShowTime number Unused by QSR applications .Configurable value for when to automatically no show a visit after check back time.
guestChitString string Configurable quote text to print on guest printer receipt.
Source:

PrecalculatedQuote

Type:
  • Object
Properties:
Name Type Description
quoteLow number Low quote range value as determined by your quote settings.
quoteHigh number High quote range value as determined by your quote settings.
siteQuoteString string "Exact Quote Label" configured for the quote time.
consumerQuoteString string "Quote Range Label" configured for the quote time.
exactQuote number Exact quote value generated by the system.
checkBackTime number Unused by QSR applications .Configurable value to provide to party to check back on.
autoNoShowTime number Unused by QSR applications .Configurable value for when to automatically no show a visit after check back time.
guestChitString string Configurable quote text to print on guest printer receipt.
Source:

PrecalculatedQuotePerPartySize

Type:
  • Object
Properties:
Name Type Description
quote Array.<PreCalculatedQuote> Collection PrecalculatedQuote data
partySize number Number of guests within a party for which the quote applies.
Source:

PrecalculatedQuotePerPartySize

Type:
  • Object
Properties:
Name Type Description
quote Array.<PreCalculatedQuote> Collection PrecalculatedQuote data
partySize number Number of guests within a party for which the quote applies.
Source:

PreCalculatedQuotes

Type:
  • Object
Properties:
Name Type Description
Quotes Array.<PrecalculatedQuotePerPartySize> Collection of PrecalculatedQuotes representing quotes per party size.
Source:

PreCalculatedQuotes

Type:
  • Object
Properties:
Name Type Description
Quotes Array.<PrecalculatedQuotePerPartySize> Collection of PrecalculatedQuotes representing quotes per party size.
Source:

Quote

Quote related information.
Type:
  • Object
Properties:
Name Type Description
ConsumerQuoteString string Quote string presented to guest/consumer.
QuoteHigh number High value of quote range.
QuoteLow number Low value of quote range.
SiteQuoteString string Quote string presented to site.
Source:

Quote

Quote related information.
Type:
  • Object
Properties:
Name Type Description
ConsumerQuoteString string Quote string presented to guest/consumer.
QuoteHigh number High value of quote range.
QuoteLow number Low value of quote range.
SiteQuoteString string Quote string presented to site.
Source:

ReservationAvailabilityDay

Type:
  • Object
Properties:
Name Type Description
Date string Target date of the ReservationAvailabilityDay record, in ISO 8601 format. Note: This field should be treated as site local business date and should never parsed as a DateTime.
Sessions Array.<ReservationAvailabilitySession> Collection of ReservationAvailabilitySession, each representing availability for a session within a day.
Source:

ReservationAvailabilityDay

Type:
  • Object
Properties:
Name Type Description
Date string Target date of the ReservationAvailabilityDay record, in ISO 8601 format. Note: This field should be treated as site local business date and should never parsed as a DateTime.
Sessions Array.<ReservationAvailabilitySession> Collection of ReservationAvailabilitySession, each representing availability for a session within a day.
Source:

ReservationAvailabilitySeatingArea

Type:
  • Object
Properties:
Name Type Description
GuestMessage string Message shown to guests when guests book a reservation with the seating area and the session.
SeatingAreaName string Name of the seating area.
SeatingAreaUID string Unique identifier of the seating area.
Times Array.<ReservationAvailabilityTimeSlot> Collection of ReservationAvailabilityTimeSlot, each representing availability for a calendar date.
Source:

ReservationAvailabilitySeatingArea

Type:
  • Object
Properties:
Name Type Description
GuestMessage string Message shown to guests when guests book a reservation with the seating area and the session.
SeatingAreaName string Name of the seating area.
SeatingAreaUID string Unique identifier of the seating area.
Times Array.<ReservationAvailabilityTimeSlot> Collection of ReservationAvailabilityTimeSlot, each representing availability for a calendar date.
Source:

ReservationAvailabilitySession

Type:
  • Object
Properties:
Name Type Description
SessionName string Name of the session record.
SeatingAreas Array.<ReservationAvailabilitySeatingArea> Collection of ReservationAvailabilitySeatingArea, each representing availability for a seating area within a session.
Source:

ReservationAvailabilitySession

Type:
  • Object
Properties:
Name Type Description
SessionName string Name of the session record.
SeatingAreas Array.<ReservationAvailabilitySeatingArea> Collection of ReservationAvailabilitySeatingArea, each representing availability for a seating area within a session.
Source:

ReservationAvailabilityTimeSlot

Type:
  • Object
Properties:
Name Type Description
IsAvailable boolean If time slot is available, "True." Otherwise, "False."
Time string It represents time of the time slot, in ISO 8601 format.
OnlineSuspended boolean If online reservations have been temporarily suspended by the restaurant, "True." Otherwise, "False."
Source:

ReservationAvailabilityTimeSlot

Type:
  • Object
Properties:
Name Type Description
IsAvailable boolean If time slot is available, "True." Otherwise, "False."
Time string It represents time of the time slot, in ISO 8601 format.
OnlineSuspended boolean If online reservations have been temporarily suspended by the restaurant, "True." Otherwise, "False."
Source:

SeatedTables

Type:
  • Object
Properties:
Name Type Description
TableID string A globally unique identifier for a QSR table record.
TableName string Name of the seated table.
StartTime string Start time in ISO 8601 format. Time when the visit is seated at the table.
EndTime string End time in ISO 8601 format. Time when the visit leaves the table.
IsActive boolean Flag to indicate whether this record is active.
IsCurrent boolean Flag to indicate whether this record is current.
Source:

SeatedTables

Type:
  • Object
Properties:
Name Type Description
TableID string A globally unique identifier for a QSR table record.
TableName string Name of the seated table.
StartTime string Start time in ISO 8601 format. Time when the visit is seated at the table.
EndTime string End time in ISO 8601 format. Time when the visit leaves the table.
IsActive boolean Flag to indicate whether this record is active.
IsCurrent boolean Flag to indicate whether this record is current.
Source:

Sessions

Type:
  • Object
Source:

Sessions

Type:
  • Object
Source:

ShiftSnapshot

Type:
  • Object
Properties:
Name Type Description
Name string Name of the shift.
UID string Globally unique identifier of the shift record.
Source:

ShiftSnapshot

Type:
  • Object
Properties:
Name Type Description
Name string Name of the shift.
UID string Globally unique identifier of the shift record.
Source:

Site

Type:
  • Object
Properties:
Name Type Description
SiteUID string A globally unique identifier for a site that will be provided by QSR.
CustomerSiteID string Customizable site identifier.
IID number An integer type identifier for a QSR visit record..
CompanyUID string A globally unique identifier for a company that will be provided by QSR.
CreationTime string Creation time in ISO 8601 format..
Name string Site name.
ContactNumber string Site contact phone number.
Hours string Site operation hours text.
Address string Address.
City string City.
County string Country.
State string State.
Postal string Postal code.
Country string Country.
TimeZoneId string Name of site time zone in Olson time zone list..
Latitude number Latitude of site location.
Longitude number Longitude of site location.
BrandUID string A globally unique identifier for a Brand/Concept that will be provided by QSR.
DisplayName string Descriptive alternate site name.
PrimaryCuisine string Name of the main type cuisine associated with the site.
Cuisines Array.<string> Name of cuisines associated with the site.
LastUpdate string The timestamp of the last update in ISO 8601 format.
Source:

Site

Type:
  • Object
Properties:
Name Type Description
SiteUID string A globally unique identifier for a site that will be provided by QSR.
CustomerSiteID string Customizable site identifier.
IID number An integer type identifier for a QSR visit record..
CompanyUID string A globally unique identifier for a company that will be provided by QSR.
CreationTime string Creation time in ISO 8601 format..
Name string Site name.
ContactNumber string Site contact phone number.
Hours string Site operation hours text.
Address string Address.
City string City.
County string Country.
State string State.
Postal string Postal code.
Country string Country.
TimeZoneId string Name of site time zone in Olson time zone list..
Latitude number Latitude of site location.
Longitude number Longitude of site location.
BrandUID string A globally unique identifier for a Brand/Concept that will be provided by QSR.
DisplayName string Descriptive alternate site name.
PrimaryCuisine string Name of the main type cuisine associated with the site.
Cuisines Array.<string> Name of cuisines associated with the site.
LastUpdate string The timestamp of the last update in ISO 8601 format.
Source:

StationSnapshot

Type:
  • Object
Properties:
Name Type Description
Name string Name of the station.
UID string Globally unique identifier of the station record.
Source:

StationSnapshot

Type:
  • Object
Properties:
Name Type Description
Name string Name of the station.
UID string Globally unique identifier of the station record.
Source:

Status

Type:
  • Object
Properties:
Name Type Description
PartySize number Number of guests in party.
Quote Array.<Quote> Collention of Quotes.
WebAheadStatus string Status of site WebAhead operations. The following are considered acceptable values: Disabled, NotAccepting, Available.
WebAheadStatusText string Status of site WebAhead operations in text form. Possible values are: Disabled, NotAccepting, Available.
Source:

Status

Type:
  • Object
Properties:
Name Type Description
PartySize number Number of guests in party.
Quote Array.<Quote> Collention of Quotes.
WebAheadStatus string Status of site WebAhead operations. The following are considered acceptable values: Disabled, NotAccepting, Available.
WebAheadStatusText string Status of site WebAhead operations in text form. Possible values are: Disabled, NotAccepting, Available.
Source:

TableEvent

Type:
  • Object
Properties:
Name Type Description
Category string Category of the event.
Content TableEventContent Content of the event.
LastUpdate string Last update timestamp of the event, in ISO 8601 format.
ServerLastUpdate string Server last update timestamp of the event, in ISO 8601 format.
SyncSource string Sync source of the event.
Type string Type of event.
UID number Globally unique identifier of the event.
Version number Version of the event.
Source:

TableEvent

Type:
  • Object
Properties:
Name Type Description
Category string Category of the event.
Content TableEventContent Content of the event.
LastUpdate string Last update timestamp of the event, in ISO 8601 format.
ServerLastUpdate string Server last update timestamp of the event, in ISO 8601 format.
SyncSource string Sync source of the event.
Type string Type of event.
UID number Globally unique identifier of the event.
Version number Version of the event.
Source:

TableEventContent

Type:
  • Object
Properties:
Name Type Description
FloorPlan FloorPlanSnapshot Snapshot of the floorplan information at the time of the event.
Shift ShiftSnapshot Snapshot of the shift information at the time of the event.
Station StationSnapshot Snapshot of the related stations information at the time of the event.
Table TableSnapshot Snapshot of the table information at the time of the event.
Source:

TableEventContent

Type:
  • Object
Properties:
Name Type Description
FloorPlan FloorPlanSnapshot Snapshot of the floorplan information at the time of the event.
Shift ShiftSnapshot Snapshot of the shift information at the time of the event.
Station StationSnapshot Snapshot of the related stations information at the time of the event.
Table TableSnapshot Snapshot of the table information at the time of the event.
Source:

TableEventPage

Type:
  • Object
Properties:
Name Type Description
Events Array.<TableEvent> Collection of TableEvent objects representing the requested page of TableEvent records.
MoreData boolean "True" indicates that the number of total results exceeds 100.
DownloadCutoff string The last update timestamp of the last record in the returned result set, in ISO 8601 format.
Source:

TableEventPage

Type:
  • Object
Properties:
Name Type Description
Events Array.<TableEvent> Collection of TableEvent objects representing the requested page of TableEvent records.
MoreData boolean "True" indicates that the number of total results exceeds 100.
DownloadCutoff string The last update timestamp of the last record in the returned result set, in ISO 8601 format.
Source:

TableHistory

Type:
  • Object
Properties:
Name Type Description
CleanedTime string Cleaned time of the table, in ISO 8601 format.
CreatedTime string Creation time of the table, in ISO 8601 format.
DirtiedTime string Dirty time of the table, in ISO 8601 format.
FloorPlanName string Name of the related floorplan for the table history record.
ID string Unique identifier of the table.
IsActive boolean Boolean flag to represent whether the table is active.
MaximumSeatCount number Maximum seat count of the table.
MiniumumSeatCount number Minimum seat count of the table.
Name string Name of the table.
OperatingPeriodName string Name of the related operating period for the table history record.
SeatCount number Seat count of the table.
ShiftName string Name of the related shift for the table history record.
Source:

TableHistory

Type:
  • Object
Properties:
Name Type Description
CleanedTime string Cleaned time of the table, in ISO 8601 format.
CreatedTime string Creation time of the table, in ISO 8601 format.
DirtiedTime string Dirty time of the table, in ISO 8601 format.
FloorPlanName string Name of the related floorplan for the table history record.
ID string Unique identifier of the table.
IsActive boolean Boolean flag to represent whether the table is active.
MaximumSeatCount number Maximum seat count of the table.
MiniumumSeatCount number Minimum seat count of the table.
Name string Name of the table.
OperatingPeriodName string Name of the related operating period for the table history record.
SeatCount number Seat count of the table.
ShiftName string Name of the related shift for the table history record.
Source:

TableHiTableHistoryPage

Type:
  • Object
Properties:
Name Type Description
History Array.<TableHistory> Collection of TableHistory objects representing the requested page of TableHistory records.
HasMoreData boolean "True" indicates that the number of total results exceeds 100.
CutOffDate string The last update timestamp of the last record in the returned result set, in ISO 8601 format.
Source:

TableHiTableHistoryPage

Type:
  • Object
Properties:
Name Type Description
History Array.<TableHistory> Collection of TableHistory objects representing the requested page of TableHistory records.
HasMoreData boolean "True" indicates that the number of total results exceeds 100.
CutOffDate string The last update timestamp of the last record in the returned result set, in ISO 8601 format.
Source:

TableSnapshot

Type:
  • Object
Properties:
Name Type Description
EndSeats boolean Flag to indicate whether table has endseat. "True" means active.
LastUpdate string The last update timestamp of the table record, in ISO 8601 format.
MaximumSeatCount number Maximum seat count of the table.
MiniumumSeatCount number Minimum seat count of the table.
Name string Name of the table.
QsrTableShapeID number QSR-defined integer ID representing the shape of the table.
SeatCount number Seat count of the table.
Statistics TableStatisticSnapshot TableStatisticSnapshot object of the table.
UID string Globally unique identifier of the event.
Source:

TableSnapshot

Type:
  • Object
Properties:
Name Type Description
EndSeats boolean Flag to indicate whether table has endseat. "True" means active.
LastUpdate string The last update timestamp of the table record, in ISO 8601 format.
MaximumSeatCount number Maximum seat count of the table.
MiniumumSeatCount number Minimum seat count of the table.
Name string Name of the table.
QsrTableShapeID number QSR-defined integer ID representing the shape of the table.
SeatCount number Seat count of the table.
Statistics TableStatisticSnapshot TableStatisticSnapshot object of the table.
UID string Globally unique identifier of the event.
Source:

TableStatisticSnapshot

Type:
  • Object
Properties:
Name Type Description
OpenedTime string The open timestamp of the table record, in ISO 8601 format.
ClosedTime string The close timestamp of the table record, in ISO 8601 format.
Source:

TableStatisticSnapshot

Type:
  • Object
Properties:
Name Type Description
OpenedTime string The open timestamp of the table record, in ISO 8601 format.
ClosedTime string The close timestamp of the table record, in ISO 8601 format.
Source:

TableStatus

Type:
  • Object
Properties:
Name Type Description
IsDirty boolean True flag indicates table is dirty.
OpenedTime string The open timestamp of the table status in ISO 8601 format.
ClosedTime string The close timestamp of the table status in ISO 8601 format.
DirtyTime string Dirty time of the table in ISO 8601 format.
CleanedTime string Cleaned time of the table in ISO 8601 format.
LastSeatedTime string Time of last seating in ISO 8601 format.
LastCompletedTime string Time table was last complete in ISO 8601 format.
LastAvailableTime string Last time the table was available in ISO 8601 format.
Status string Current status of the table.
ID string Identification number of the table.
LastUpdate string The timestamp of the last update of table status in ISO 8601 format.
Name string The table name.
SeatCount number The number of guests seated at the table.
MinimumSeatCount number The minimum number of guests that may be seated at table.
MaximumSeatCount number The maximum number of guests that may be seated at table.
IsActive boolean True flag indicates table is active.
SeatingAreaId string The area identification number in which the table is located.
HasMoreData boolean True flag indicates there is more table status data available.
CutOffDate string The cut off timestamp in ISO 8601 format.
Source:

TableStatus

Type:
  • Object
Properties:
Name Type Description
IsDirty boolean True flag indicates table is dirty.
OpenedTime string The open timestamp of the table status in ISO 8601 format.
ClosedTime string The close timestamp of the table status in ISO 8601 format.
DirtyTime string Dirty time of the table in ISO 8601 format.
CleanedTime string Cleaned time of the table in ISO 8601 format.
LastSeatedTime string Time of last seating in ISO 8601 format.
LastCompletedTime string Time table was last complete in ISO 8601 format.
LastAvailableTime string Last time the table was available in ISO 8601 format.
Status string Current status of the table.
ID string Identification number of the table.
LastUpdate string The timestamp of the last update of table status in ISO 8601 format.
Name string The table name.
SeatCount number The number of guests seated at the table.
MinimumSeatCount number The minimum number of guests that may be seated at table.
MaximumSeatCount number The maximum number of guests that may be seated at table.
IsActive boolean True flag indicates table is active.
SeatingAreaId string The area identification number in which the table is located.
HasMoreData boolean True flag indicates there is more table status data available.
CutOffDate string The cut off timestamp in ISO 8601 format.
Source:

TeamMember

Type:
  • Object
Properties:
Name Type Description
CardId string Card ID of the TeamMember record.
CreatedTime string The creation timestamp of the TeamMember record, in ISO 8601 format.
Email string Email of the TeamMember record.
ExternalId string External ID of the TeamMember record.
FirstName string FirstName of the TeamMember record.
HomePhone string HomePhone of the TeamMember record.
IsActive boolean Flag indicating whether the TeamMember record is active. "True" means active.
LastName string LastName of the TeamMember record.
MobilePhone string MobilePhone of the TeamMember record.
Notes string Notes of the TeamMember record.
ServerID number Integer ID of the TeamMember record.
UID string Globally unique identifier of the TeamMember record.
Source:

TeamMember

Type:
  • Object
Properties:
Name Type Description
CardId string Card ID of the TeamMember record.
CreatedTime string The creation timestamp of the TeamMember record, in ISO 8601 format.
Email string Email of the TeamMember record.
ExternalId string External ID of the TeamMember record.
FirstName string FirstName of the TeamMember record.
HomePhone string HomePhone of the TeamMember record.
IsActive boolean Flag indicating whether the TeamMember record is active. "True" means active.
LastName string LastName of the TeamMember record.
MobilePhone string MobilePhone of the TeamMember record.
Notes string Notes of the TeamMember record.
ServerID number Integer ID of the TeamMember record.
UID string Globally unique identifier of the TeamMember record.
Source:

TeamMemberEvent

Type:
  • Object
Properties:
Name Type Description
Category string Category of the event.
Content TeamMemberEventContent Content of the event.
LastUpdate string Last update timestamp of the event, in ISO 8601 format.
ServerLastUpdate string Server last update timestamp of the event, in ISO 8601 format.
SyncSource string Sync source of the event. See Standard Parameters & DTOs.
Type string Type of event.
UID string Globally unique identifier of the event.
Version string Version of the event.
Source:

TeamMemberEvent

Type:
  • Object
Properties:
Name Type Description
Category string Category of the event.
Content TeamMemberEventContent Content of the event.
LastUpdate string Last update timestamp of the event, in ISO 8601 format.
ServerLastUpdate string Server last update timestamp of the event, in ISO 8601 format.
SyncSource string Sync source of the event. See Standard Parameters & DTOs.
Type string Type of event.
UID string Globally unique identifier of the event.
Version string Version of the event.
Source:

TeamMemberEventContent

Type:
  • Object
Properties:
Name Type Description
FloorPlan FloorPlanSnapshot Snapshot of the floorplan information at the time of the event.
Shift ShiftSnapshot Snapshot of the shift information at the time of the event.
Station StationSnapshot Snapshot of the related stations information at the time of the event.
TeamMember TeamMemberSnapshot Snapshot of the team member information at the time of the event.
Source:

TeamMemberEventContent

Type:
  • Object
Properties:
Name Type Description
FloorPlan FloorPlanSnapshot Snapshot of the floorplan information at the time of the event.
Shift ShiftSnapshot Snapshot of the shift information at the time of the event.
Station StationSnapshot Snapshot of the related stations information at the time of the event.
TeamMember TeamMemberSnapshot Snapshot of the team member information at the time of the event.
Source:

TeamMemberEventPage

Type:
  • Object
Properties:
Name Type Description
Events Array.<TeamMemberEvent> Collection of TeamMemberEvent objects representing the requested page of matching team member event records.
MoreData boolean "True" indicates that the number of total results exceeds 100.
DownloadCutoff string The last update timestamp of the last record in the returned result set, in ISO 8601 format.
Source:

TeamMemberEventPage

Type:
  • Object
Properties:
Name Type Description
Events Array.<TeamMemberEvent> Collection of TeamMemberEvent objects representing the requested page of matching team member event records.
MoreData boolean "True" indicates that the number of total results exceeds 100.
DownloadCutoff string The last update timestamp of the last record in the returned result set, in ISO 8601 format.
Source:

TeamMemberSnapshot

Type:
  • Object
Properties:
Name Type Description
CardId string Card ID of the TeamMember record.
CreatedTime string The creation timestamp of the TeamMember record, in ISO 8601 format.
Email string Email of the TeamMember record.
ExternalId string External ID of the TeamMember record.
FirstName string FirstName of the TeamMember record.
HomePhone string HomePhone of the TeamMember record.
Id number number ID of the TeamMember record.
ImageId number number ID of the image of the TeamMember record.
LastName string LastName of the TeamMember record.
MobilePhone string MobilePhone of the TeamMember record.
Notes string Notes of the TeamMember record.
SiteID number number ID of the site for the TeamMember record.
UID string Globally unique identifier of the TeamMember record.
Source:

TeamMemberSnapshot

Type:
  • Object
Properties:
Name Type Description
CardId string Card ID of the TeamMember record.
CreatedTime string The creation timestamp of the TeamMember record, in ISO 8601 format.
Email string Email of the TeamMember record.
ExternalId string External ID of the TeamMember record.
FirstName string FirstName of the TeamMember record.
HomePhone string HomePhone of the TeamMember record.
Id number number ID of the TeamMember record.
ImageId number number ID of the image of the TeamMember record.
LastName string LastName of the TeamMember record.
MobilePhone string MobilePhone of the TeamMember record.
Notes string Notes of the TeamMember record.
SiteID number number ID of the site for the TeamMember record.
UID string Globally unique identifier of the TeamMember record.
Source:

Visit

QSR Visit record
Type:
  • Object
Properties:
Name Type Description
ArrivalTime string Arrival time in ISO 8601 format.
CanceledTime string Canceled time in ISO 8601 format.
CompletedTime string Completed time in ISO 8601 format.
ConfirmationNumber string Confirmation number.
CreationTime string Creation time in ISO 8601 format.
CustomValues Array.<VisitCustomValue> Collection of VisitCustomValue objects representing the visit custom value.
EstimatedArrivalTime string Estimated arrival time in ISO 8601 format.
ExternalID string External identifier of the visit record from a 3rd party.
Guest Guest A guest record tied to current QSR visit record.
GuestID string A globally unique identifier for the QSR guest record tied to the current QSR visit record.
ID string A globally unique identifier for a QSR visit record.
IID number An integer type identifier for a QSR visit record.
Notes string Notes.
NotificationType string Set Notification Type to None, Call, SMS, or Pager.
PagedTime string Paged time in ISO 8601 format.
PagerID string ID number of associated pager.
PartyMix VisitPartyMix Visit party mix data.
PreassignedTables Array.<VisitPreassignedTable> Collection of VisitPreassignedTable objects representing preassigned tables with the visit.
Quote Quote Quote-related information.
SeatedTables Array.<VisitSeatedTable> Collection of VisitSeatedTable objects representing seated tables with the visit.
SeatedTime string Seated time in ISO 8601 format.
SeatingAreaID string A globally unique identifier for a QSR seating area.
SeatingAreaName string Seating area name
Size number Cover count
Status string Status of current QSR visit record. The following are considered acceptable values: NotYetArrived, PartiallyArrived, Waiting, NoShow, WalkAway, Notified, PartiallySeated, Seated, AlmostFinished, Payment, Completed, CheckStarted, Canceled.
Type string Type of current QSR visit record. The following are considered acceptable values: WalkIn, CallAhead, Reservation, Carryout.
VisitSource string Origination of the visit.
Source:

Visit

QSR Visit record
Type:
  • Object
Properties:
Name Type Description
ArrivalTime string Arrival time in ISO 8601 format.
CanceledTime string Canceled time in ISO 8601 format.
CompletedTime string Completed time in ISO 8601 format.
ConfirmationNumber string Confirmation number.
CreationTime string Creation time in ISO 8601 format.
CustomValues Array.<VisitCustomValue> Collection of VisitCustomValue objects representing the visit custom value.
EstimatedArrivalTime string Estimated arrival time in ISO 8601 format.
ExternalID string External identifier of the visit record from a 3rd party.
Guest Guest A guest record tied to current QSR visit record.
GuestID string A globally unique identifier for the QSR guest record tied to the current QSR visit record.
ID string A globally unique identifier for a QSR visit record.
IID number An integer type identifier for a QSR visit record.
Notes string Notes.
NotificationType string Set Notification Type to None, Call, SMS, or Pager.
PagedTime string Paged time in ISO 8601 format.
PagerID string ID number of associated pager.
PartyMix VisitPartyMix Visit party mix data.
PreassignedTables Array.<VisitPreassignedTable> Collection of VisitPreassignedTable objects representing preassigned tables with the visit.
Quote Quote Quote-related information.
SeatedTables Array.<VisitSeatedTable> Collection of VisitSeatedTable objects representing seated tables with the visit.
SeatedTime string Seated time in ISO 8601 format.
SeatingAreaID string A globally unique identifier for a QSR seating area.
SeatingAreaName string Seating area name
Size number Cover count
Status string Status of current QSR visit record. The following are considered acceptable values: NotYetArrived, PartiallyArrived, Waiting, NoShow, WalkAway, Notified, PartiallySeated, Seated, AlmostFinished, Payment, Completed, CheckStarted, Canceled.
Type string Type of current QSR visit record. The following are considered acceptable values: WalkIn, CallAhead, Reservation, Carryout.
VisitSource string Origination of the visit.
Source:

VisitCustomValue

QSR visit custom record.
Type:
  • Object
Properties:
Name Type Description
Name string Name of the visit custom record.
Value string Value of the visit custom record.
Source:

VisitCustomValue

QSR visit custom record.
Type:
  • Object
Properties:
Name Type Description
Name string Name of the visit custom record.
Value string Value of the visit custom record.
Source:

VisitPartyMix

Type:
  • Object
Properties:
Name Type Description
Mixes Array.<VisitPartyMixEntry> Collection of VisitPartyMixEntry.
Source:

VisitPartyMix

Type:
  • Object
Properties:
Name Type Description
Mixes Array.<VisitPartyMixEntry> Collection of VisitPartyMixEntry.
Source:

VisitPartyMixEntry

Type:
  • Object
Properties:
Name Type Description
Count number Count of the party mix type.
Type string Type of the party mix. The following are considered acceptable values: Adult, Child, Infant, Senior.
Source:

VisitPartyMixEntry

Type:
  • Object
Properties:
Name Type Description
Count number Count of the party mix type.
Type string Type of the party mix. The following are considered acceptable values: Adult, Child, Infant, Senior.
Source:

VisitPollResponse

Type:
  • Object
Properties:
Name Type Description
Visits Array.<Visit> Collection of Visit objects representing the requested page of matching guest records.
MoreData boolean 'True' indicates that the number of total results exceeds 30.
TimestampCutoff string The last update timestamp of the last record in the returned result set in ISO 8601 format.
Source:

VisitPollResponse

Type:
  • Object
Properties:
Name Type Description
Visits Array.<Visit> Collection of Visit objects representing the requested page of matching guest records.
MoreData boolean 'True' indicates that the number of total results exceeds 30.
TimestampCutoff string The last update timestamp of the last record in the returned result set in ISO 8601 format.
Source:

VisitPreassignedTable

QSR VisitPreassignedTable record representing a preassigned table for a visit.
Type:
  • Object
Properties:
Name Type Description
StartTime string Start time in ISO 8601 format. Time when the visit is seated at the table.
EndTime string End time in ISO 8601 format. Time when the visit leaves the table.
IsCurrent boolean Flag to indicate whether this record is current.
IsActive boolean Flag to indicate whether this record is active.
TableID string A globally unique identifier for a QSR table record.
TableName string Name of the seated table.
Source:

VisitPreassignedTable

QSR VisitPreassignedTable record representing a preassigned table for a visit.
Type:
  • Object
Properties:
Name Type Description
StartTime string Start time in ISO 8601 format. Time when the visit is seated at the table.
EndTime string End time in ISO 8601 format. Time when the visit leaves the table.
IsCurrent boolean Flag to indicate whether this record is current.
IsActive boolean Flag to indicate whether this record is active.
TableID string A globally unique identifier for a QSR table record.
TableName string Name of the seated table.
Source:

VisitSeatedTable

QSR VisitSeatedTable record representing a seated table for a visit.
Type:
  • Object
Properties:
Name Type Description
StartTime string Start time in ISO 8601 format. Time when the visit is seated at the table.
EndTime string End time in ISO 8601 format. Time when the visit leaves the table.
IsCurrent boolean Flag to indicate whether this record is current.
IsActive boolean Flag to indicate whether this record is active.
TableID string A globally unique identifier for a QSR table record.
TableName string Name of the seated table.
Source:

VisitSeatedTable

QSR VisitSeatedTable record representing a seated table for a visit.
Type:
  • Object
Properties:
Name Type Description
StartTime string Start time in ISO 8601 format. Time when the visit is seated at the table.
EndTime string End time in ISO 8601 format. Time when the visit leaves the table.
IsCurrent boolean Flag to indicate whether this record is current.
IsActive boolean Flag to indicate whether this record is active.
TableID string A globally unique identifier for a QSR table record.
TableName string Name of the seated table.
Source:

WaitListStatus

Type:
  • Object
Properties:
Name Type Description
SiteUID string A globally unique identifier for a site that will be provided by QSR.
WebAheadStatus string Status of site WebAhead operations. The following are considered acceptable values: Disabled, NotAccepting, Available.
NumberWaitingVisits number Number of current waiting visits on site.
Quote Quote Current quote information.
Statuses Array.<Status> Current quote information.
Source:

WaitListStatus

Type:
  • Object
Properties:
Name Type Description
SiteUID string A globally unique identifier for a site that will be provided by QSR.
WebAheadStatus string Status of site WebAhead operations. The following are considered acceptable values: Disabled, NotAccepting, Available.
NumberWaitingVisits number Number of current waiting visits on site.
Quote Quote Current quote information.
Statuses Array.<Status> Current quote information.
Source:

WaitListStatusForSites

Type:
  • Object
Properties:
Name Type Description
WaitListStatusList WaitListStatus List of WaitListStatus for specified sites.
Source:

WaitListStatusForSites

Type:
  • Object
Properties:
Name Type Description
WaitListStatusList WaitListStatus List of WaitListStatus for specified sites.
Source:

WebAhead

Type:
  • Object
Properties:
Name Type Description
ID string A globally unique identifier for a QSR visit record.
SiteUID string Globally unique identifier for a site. This is provided by QSR.
NotificationType string Set Notification Type to None, Call, SMS, or Pager.
PlaceInWaitList number 1-based position of a current WebAhead visit in the wait list.
Type string Type of current QSR visit record. The following are considered acceptable values: WalkIn, CallAhead, Reservation.
Status string Status of a current QSR visit record. The following are considered acceptable values: NotYetArrived, PartiallyArrived, Waiting, NoShow, WalkAway, Notified, PartiallySeated, Seated, AlmostFinished, Payment, Completed, CheckStarted, and Canceled.
Size number Cover count
ConfirmationNumber string Confirmation number
ConfirmationNumberID number number identifier of the visit confirmation number.
Notes string Notes
CreationTime string Creation time in ISO 8601 format.
EstimatedArrivalTime string Estimated arrival time in ISO 8601 format.
ArrivalTime string Arrival time in ISO 8601 format.
PagedTime string Paged time in ISO 8601 format.
Quote Quote Quote-related information.
UpdatedQuote UpdatedQuote The party's most recently updated Quote information with a GeneratedDateTime in ISO 8601 format.
PreassignedTables Array.<VisitPreassignedTable> Collection of VisitPreassignedTable objects representing preassigned tables.
CustomValues Array.<VisitCustomValue> Collection of VisitCustomValue objects representing visit custom value.
Guest Guest A QSR guest record tied to a current QSR visit record.
GuestID string A globally unique identifier for the QSR guest record tied to a current QSR WebAhead record.
SeatingAreaID string A globally unique identifier for a QSR seating area.
SeatingAreaName string Seating area name.
SeatedTime string Seated time in ISO 8601 format.
CompletedTime string Completed time in ISO 8601 format.
SeatedTables Array.<VisitSeatedTable> Collection of VisitSeatedTime objects representing seated tables.
Source:

WebAhead

Type:
  • Object
Properties:
Name Type Description
ID string A globally unique identifier for a QSR visit record.
SiteUID string Globally unique identifier for a site. This is provided by QSR.
NotificationType string Set Notification Type to None, Call, SMS, or Pager.
PlaceInWaitList number 1-based position of a current WebAhead visit in the wait list.
Type string Type of current QSR visit record. The following are considered acceptable values: WalkIn, CallAhead, Reservation.
Status string Status of a current QSR visit record. The following are considered acceptable values: NotYetArrived, PartiallyArrived, Waiting, NoShow, WalkAway, Notified, PartiallySeated, Seated, AlmostFinished, Payment, Completed, CheckStarted, and Canceled.
Size number Cover count
ConfirmationNumber string Confirmation number
ConfirmationNumberID number number identifier of the visit confirmation number.
Notes string Notes
CreationTime string Creation time in ISO 8601 format.
EstimatedArrivalTime string Estimated arrival time in ISO 8601 format.
ArrivalTime string Arrival time in ISO 8601 format.
PagedTime string Paged time in ISO 8601 format.
Quote Quote Quote-related information.
UpdatedQuote UpdatedQuote The party's most recently updated Quote information with a GeneratedDateTime in ISO 8601 format.
PreassignedTables Array.<VisitPreassignedTable> Collection of VisitPreassignedTable objects representing preassigned tables.
CustomValues Array.<VisitCustomValue> Collection of VisitCustomValue objects representing visit custom value.
Guest Guest A QSR guest record tied to a current QSR visit record.
GuestID string A globally unique identifier for the QSR guest record tied to a current QSR WebAhead record.
SeatingAreaID string A globally unique identifier for a QSR seating area.
SeatingAreaName string Seating area name.
SeatedTime string Seated time in ISO 8601 format.
CompletedTime string Completed time in ISO 8601 format.
SeatedTables Array.<VisitSeatedTable> Collection of VisitSeatedTime objects representing seated tables.
Source: