Constructor
new QSR(companyUID, apiKeysopt)
Create a QSR instance.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
companyUID |
string | Globally unique identifier for a company. This is provided by QSR. | |||||||||||||
apiKeys |
Object |
<optional> |
Optional. API Keys Object.
Properties
|
- Source:
Methods
(async) addGuest(data, syncSourceopt) → {Guest}
Adds a guest record to the company guestbook.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
Object | Guest data to add.
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
syncSource |
string |
<optional> |
Optional. QSR-defined string representing a source of records. |
- Source:
Returns:
- Guest.
- Type
- Guest
(async) addGuest(data, syncSourceopt) → {Guest}
Adds a guest record to the company guestbook.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
Object | Guest data to add.
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
syncSource |
string |
<optional> |
Optional. QSR-defined string representing a source of records. |
- Source:
Returns:
- Guest.
- Type
- Guest
(async) addReservation(siteUID, info) → {Visit}
Adds a reservation to the site for the specified date and time.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info |
Object | Information for the reservation.
Properties
|
- Source:
Returns:
- QSR visit record.
- Type
- Visit
(async) addReservation(siteUID, info) → {Visit}
Adds a reservation to the site for the specified date and time.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info |
Object | Information for the reservation.
Properties
|
- Source:
Returns:
- QSR visit record.
- Type
- Visit
(async) addTableEvent(siteUID, info) → {boolean}
Raise a table event for the specified table at the specified site.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||
info |
Object | The table event to post.
Properties
|
- Source:
Returns:
- True if is successful.
- Type
- boolean
(async) addTableEvent(siteUID, info) → {boolean}
Raise a table event for the specified table at the specified site.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||
info |
Object | The table event to post.
Properties
|
- Source:
Returns:
- True if is successful.
- Type
- boolean
(async) addTeamMember(siteUID, teamMember) → {Array.<TeamMember>}
Add team members to the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
teamMember |
TeamMember | TeamMember object to add |
- Source:
Returns:
- Collection of TeamMember.
- Type
- Array.<TeamMember>
(async) addTeamMember(siteUID, teamMember) → {Array.<TeamMember>}
Add team members to the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
teamMember |
TeamMember | TeamMember object to add |
- Source:
Returns:
- Collection of TeamMember.
- Type
- Array.<TeamMember>
(async) addWalkIn(siteUID, info) → {Visit}
Adds an arrived WalkIn visit.
Providing Guest.ID or Guest.Loyalty.LoyaltyCardID indicates an existing QSR guest record.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||
info |
* | WalkIn information.
Properties
|
- Source:
Returns:
- QSR visit record.
- Type
- Visit
(async) addWalkIn(siteUID, info) → {boolean}
Adds a WebAhead, therefore adding the specified party to the Waitlist.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info |
Object | Information object for WebAhead.
Properties
|
- Source:
Returns:
- True if post is successful.
- Type
- boolean
(async) addWalkIn(siteUID, info) → {Visit}
Adds an arrived WalkIn visit.
Providing Guest.ID or Guest.Loyalty.LoyaltyCardID indicates an existing QSR guest record.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||
info |
* | WalkIn information.
Properties
|
- Source:
Returns:
- QSR visit record.
- Type
- Visit
(async) addWalkIn(siteUID, info) → {boolean}
Adds a WebAhead, therefore adding the specified party to the Waitlist.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info |
Object | Information object for WebAhead.
Properties
|
- Source:
Returns:
- True if post is successful.
- Type
- boolean
(async) arriveReservation(siteUID, visitID) → {boolean}
Arrive a Visit.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitID |
string | Globally unique identifier for a QSR visit record (WebAhead, reservation, or walk-in). |
- Source:
Returns:
- Returns true is successful.
- Type
- boolean
(async) arriveReservation(siteUID, visitID) → {boolean}
Arrive a Visit.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitID |
string | Globally unique identifier for a QSR visit record (WebAhead, reservation, or walk-in). |
- Source:
Returns:
- Returns true is successful.
- Type
- boolean
(async) arriveVisit(siteUID, visitID) → {boolean}
Arrive a Visit.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitID |
string | A globally unique identifier for a QSR visit record. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) arriveVisit(siteUID, visitID) → {boolean}
Arrive a Visit.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitID |
string | A globally unique identifier for a QSR visit record. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) arriveWebAhead(siteUID, visitID) → {boolean}
Arrive a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitID |
string | A globally unique identifier for a QSR visit record. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) arriveWebAhead(siteUID, visitID) → {boolean}
Arrive a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitID |
string | A globally unique identifier for a QSR visit record. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) arriveWebAheadByConfirmation(confirmationNumber) → {boolean}
Arrive a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Description |
|---|---|---|
confirmationNumber |
string | Confirmation number. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) arriveWebAheadByConfirmation(confirmationNumber) → {boolean}
Arrive a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Description |
|---|---|---|
confirmationNumber |
string | Confirmation number. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) arriveWebAheadByConfirmationId(confirmationNumberId) → {boolean}
Arrive a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Description |
|---|---|---|
confirmationNumberId |
number | Integer identifier of the visit confirmation number. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) arriveWebAheadByConfirmationId(confirmationNumberId) → {boolean}
Arrive a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Description |
|---|---|---|
confirmationNumberId |
number | Integer identifier of the visit confirmation number. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) cancelWebAhead(siteUID, visitID, checkStatusopt) → {boolean}
Cancel a WebAhead. This call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
visitID |
string | A globally unique identifier for a QSR visit record. | |
checkStatus |
boolean |
<optional> |
Optional. If true, only a WebAhead not yet arrived will successfully cancel. |
- Source:
Returns:
- True if is successful.
- Type
- boolean
(async) cancelWebAhead(siteUID, visitID, checkStatusopt) → {boolean}
Cancel a WebAhead. This call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
visitID |
string | A globally unique identifier for a QSR visit record. | |
checkStatus |
boolean |
<optional> |
Optional. If true, only a WebAhead not yet arrived will successfully cancel. |
- Source:
Returns:
- True if is successful.
- Type
- boolean
(async) cancelWebAheadByConfirmation(confirmationNumber, checkStatusopt) → {boolean}
Cancel a WebAhead. This call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
confirmationNumber |
string | Confirmation number. | |
checkStatus |
boolean |
<optional> |
Optional. If true, only a WebAhead not yet arrived will successfully cancel. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) cancelWebAheadByConfirmation(confirmationNumber, checkStatusopt) → {boolean}
Cancel a WebAhead. This call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
confirmationNumber |
string | Confirmation number. | |
checkStatus |
boolean |
<optional> |
Optional. If true, only a WebAhead not yet arrived will successfully cancel. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) cancelWebAheadByConfirmationId(confirmationNumberId, checkStatusopt) → {boolean}
Cancel a WebAhead. This call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
confirmationNumberId |
number | Integer identifier of the visit confirmation number. | |
checkStatus |
boolean |
<optional> |
Optional. If true, only a WebAhead not yet arrived will successfully cancel. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) cancelWebAheadByConfirmationId(confirmationNumberId, checkStatusopt) → {boolean}
Cancel a WebAhead. This call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
confirmationNumberId |
number | Integer identifier of the visit confirmation number. | |
checkStatus |
boolean |
<optional> |
Optional. If true, only a WebAhead not yet arrived will successfully cancel. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) disableWebAhead(siteUID) → {boolean}
Disable WebAhead for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) disableWebAhead(siteUID) → {boolean}
Disable WebAhead for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) enableWebAhead(siteUID) → {boolean}
Enable WebAhead for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) enableWebAhead(siteUID) → {boolean}
Enable WebAhead for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) getAllPartnerSites(numSitesopt) → {Array.<Object>}
Get a list of all sites associated with the partner on the API key.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
numSites |
number |
<optional> |
0 | Optional. Number of sites to return. Default all. |
- Source:
Returns:
- Associated sites.
- Type
- Array.<Object>
(async) getAllPartnerSites(numSitesopt) → {Array.<Object>}
Get a list of all sites associated with the partner on the API key.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
numSites |
number |
<optional> |
0 | Optional. Number of sites to return. Default all. |
- Source:
Returns:
- Associated sites.
- Type
- Array.<Object>
(async) getAllTableEvents(siteUID, startTime, endTime, numPagesopt) → {Array.<TableEvent>}
Get the list of all table events updates for a specified site within a specified time range.
This is ordered by last server update timestamp of the records.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||
startTime |
Date | Start time of updates. | ||
endTime |
Date | End time of updates. | ||
numPages |
number |
<optional> |
0 | Optional. Number of pages (100 records) to return. |
- Source:
Returns:
- Collection of TableEvent.
- Type
- Array.<TableEvent>
(async) getAllTableEvents(siteUID, startTime, endTime, numPagesopt) → {Array.<TableEvent>}
Get the list of all table events updates for a specified site within a specified time range.
This is ordered by last server update timestamp of the records.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||
startTime |
Date | Start time of updates. | ||
endTime |
Date | End time of updates. | ||
numPages |
number |
<optional> |
0 | Optional. Number of pages (100 records) to return. |
- Source:
Returns:
- Collection of TableEvent.
- Type
- Array.<TableEvent>
(async) getAllTableHistory(siteUID, startTime, endTime, numPagesopt) → {Array.<TableHistory>}
Get the list of all table history updates for a specified site within a specified time range.
This is ordered by last server update timestamp of the records.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||
startTime |
Date | Start time of updates. | ||
endTime |
Date | End time of updates. | ||
numPages |
number |
<optional> |
0 | Optional. Limit number of pages (100 records) to return. |
- Source:
Returns:
- Collection of TableHistory.
- Type
- Array.<TableHistory>
(async) getAllTableHistory(siteUID, startTime, endTime, numPagesopt) → {Array.<TableHistory>}
Get the list of all table history updates for a specified site within a specified time range.
This is ordered by last server update timestamp of the records.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||
startTime |
Date | Start time of updates. | ||
endTime |
Date | End time of updates. | ||
numPages |
number |
<optional> |
0 | Optional. Limit number of pages (100 records) to return. |
- Source:
Returns:
- Collection of TableHistory.
- Type
- Array.<TableHistory>
(async) getAllTeamMemberEvents(siteUID, startTime, endTime, numPagesopt) → {Array.<TeamMemberEvent>}
Get the list of all team member events for the specified site within a specified time range.
This is ordered by last server update timestamp of the records.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||
startTime |
Date | Start time of updates. | ||
endTime |
Date | End time of updates. | ||
numPages |
number |
<optional> |
0 | Optional. Limit number of pages (100 records) to return. |
- Source:
Returns:
- Collection of TeamMemberEvent.
- Type
- Array.<TeamMemberEvent>
(async) getAllTeamMemberEvents(siteUID, startTime, endTime, numPagesopt) → {Array.<TeamMemberEvent>}
Get the list of all team member events for the specified site within a specified time range.
This is ordered by last server update timestamp of the records.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||
startTime |
Date | Start time of updates. | ||
endTime |
Date | End time of updates. | ||
numPages |
number |
<optional> |
0 | Optional. Limit number of pages (100 records) to return. |
- Source:
Returns:
- Collection of TeamMemberEvent.
- Type
- Array.<TeamMemberEvent>
(async) getAllVisitUpdates(siteUID, startTime, stopTime, syncSourceopt) → {Array.<Visit>}
Get all visit updates for a specified site within a specified time range,
excluding updates made by the specified 'syncSource'.
This is ordered by last update timestamp of the visit records.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
startTime |
string | Start time of updates. | |
stopTime |
string | End time of updates. | |
syncSource |
string |
<optional> |
Exclude results made by specified 'syncSource' |
- Source:
Returns:
- Collection of Visit.
- Type
- Array.<Visit>
(async) getAllVisitUpdates(siteUID, startTime, stopTime, syncSourceopt) → {Array.<Visit>}
Get all visit updates for a specified site within a specified time range,
excluding updates made by the specified 'syncSource'.
This is ordered by last update timestamp of the visit records.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
startTime |
string | Start time of updates. | |
stopTime |
string | End time of updates. | |
syncSource |
string |
<optional> |
Exclude results made by specified 'syncSource' |
- Source:
Returns:
- Collection of Visit.
- Type
- Array.<Visit>
(async) getBrands() → {string}
Get information about Concepts by CompanyUID.
- Source:
Returns:
- BrandUID - A globally unique identifier for a Brand/Concept
- Type
- string
(async) getBrands() → {string}
Get information about Concepts by CompanyUID.
- Source:
Returns:
- BrandUID - A globally unique identifier for a Brand/Concept
- Type
- string
(async) getCompanySites() → {Array.<Site>}
Get information of all active sites for a company by CompanyUID.
- Source:
Returns:
- A collection of Site objects
- Type
- Array.<Site>
(async) getCompanySites() → {Array.<Site>}
Get information of all active sites for a company by CompanyUID.
- Source:
Returns:
- A collection of Site objects
- Type
- Array.<Site>
(async) getCustomerSiteIdMap(onlyActiveSites) → {string}
Get SiteUID and CustomerSiteID for all sites within a Company.
Parameters:
| Name | Type | Description |
|---|---|---|
onlyActiveSites |
boolean | If true, only records for active sites returned. |
- Source:
Returns:
- CustomerSiteID - Customizable site identifier
- Type
- string
(async) getCustomerSiteIdMap(onlyActiveSites) → {string}
Get SiteUID and CustomerSiteID for all sites within a Company.
Parameters:
| Name | Type | Description |
|---|---|---|
onlyActiveSites |
boolean | If true, only records for active sites returned. |
- Source:
Returns:
- CustomerSiteID - Customizable site identifier
- Type
- string
(async) getOperatingInfo(siteUID) → {Array.<OperatingInfo>}
Get the list of operating information.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- Collection of operating information.
- Type
- Array.<OperatingInfo>
(async) getOperatingInfo(siteUID) → {Array.<OperatingInfo>}
Get the list of operating information.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- Collection of operating information.
- Type
- Array.<OperatingInfo>
(async) getPartnerSites(numSitesopt) → {GetPartnerSites}
Get a list of all sites associated with the partner on the API key.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
numSites |
number |
<optional> |
0 | Optional. Number of sites to return. Default all. |
- Source:
Returns:
- GetPartnerSites.
- Type
- GetPartnerSites
(async) getPartnerSites(numSitesopt) → {GetPartnerSites}
Get a list of all sites associated with the partner on the API key.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
numSites |
number |
<optional> |
0 | Optional. Number of sites to return. Default all. |
- Source:
Returns:
- GetPartnerSites.
- Type
- GetPartnerSites
(async) getPrecalculatedQuotes(siteUID, partySizeopt) → {PrecalculatedQuotes|Array.<PrecalculatedQuotes>}
Retrieve the current quote times at a site for a specific party size or all party sizes.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
partySize |
number |
<optional> |
The Party Size for which quote time is being requested. Quote times for all party sizes 1-12 will be returned if not specified. |
- Source:
Returns:
- PrecalculatedQuotes for a single party size or all party sizes.
- Type
- PrecalculatedQuotes | Array.<PrecalculatedQuotes>
(async) getPrecalculatedQuotes(siteUID, partySizeopt) → {PrecalculatedQuotes|Array.<PrecalculatedQuotes>}
Retrieve the current quote times at a site for a specific party size or all party sizes.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
partySize |
number |
<optional> |
The Party Size for which quote time is being requested. Quote times for all party sizes 1-12 will be returned if not specified. |
- Source:
Returns:
- PrecalculatedQuotes for a single party size or all party sizes.
- Type
- PrecalculatedQuotes | Array.<PrecalculatedQuotes>
(async) getReservationAvailability(siteUID, date, partySize) → {Array.<ReservationAvailabilityDay>}
Gets the reservation availability for the specified site, the target business date, and target party size.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
date |
Date | Target date. |
partySize |
number | Size of the party. |
- Source:
Returns:
- Collection of ReservationAvailabilityDay, each representing availability for a calendar date.
- Type
- Array.<ReservationAvailabilityDay>
(async) getReservationAvailability(siteUID, date, partySize) → {Array.<ReservationAvailabilityDay>}
Gets the reservation availability for the specified site, the target business date, and target party size.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
date |
Date | Target date. |
partySize |
number | Size of the party. |
- Source:
Returns:
- Collection of ReservationAvailabilityDay, each representing availability for a calendar date.
- Type
- Array.<ReservationAvailabilityDay>
(async) getReservationByConfirmation(siteUID, confimationNumber) → {Visit}
Gets the reservation visit for the specified site and the specified confirmation number.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
confimationNumber |
string | Confirmation number of the reservation. |
- Source:
Returns:
- QSR visit record.
- Type
- Visit
(async) getReservationByConfirmation(siteUID, confimationNumber) → {Visit}
Gets the reservation visit for the specified site and the specified confirmation number.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
confimationNumber |
string | Confirmation number of the reservation. |
- Source:
Returns:
- QSR visit record.
- Type
- Visit
(async) getSite(siteUID) → {Site}
Get information for a site by SiteUID.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- Site object
- Type
- Site
(async) getSite(siteUID) → {Site}
Get information for a site by SiteUID.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- Site object
- Type
- Site
(async) getTableEvents(siteUID, startTime, endTime) → {TableEventPage}
Get the paged list of table events updates for a specified site within a specified time range.
This is ordered by last server update timestamp of the records. Page size is 100.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
startTime |
Date | Start time of updates. |
endTime |
Date | End time of updates. |
- Source:
Returns:
- TableEventPage.
- Type
- TableEventPage
(async) getTableEvents(siteUID, startTime, endTime) → {TableEventPage}
Get the paged list of table events updates for a specified site within a specified time range.
This is ordered by last server update timestamp of the records. Page size is 100.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
startTime |
Date | Start time of updates. |
endTime |
Date | End time of updates. |
- Source:
Returns:
- TableEventPage.
- Type
- TableEventPage
(async) getTableHistory(siteUID, startTime, endTime) → {TableHiTableHistoryPage}
Get the paged list of table history updates for a specified site within a specified time range.
This is ordered by last server update timestamp of the records. Page size is 100.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
startTime |
Date | Start time of updates. |
endTime |
Date | End time of updates. |
- Source:
Returns:
- TableHiTableHistoryPage.
(async) getTableHistory(siteUID, startTime, endTime) → {TableHiTableHistoryPage}
Get the paged list of table history updates for a specified site within a specified time range.
This is ordered by last server update timestamp of the records. Page size is 100.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
startTime |
Date | Start time of updates. |
endTime |
Date | End time of updates. |
- Source:
Returns:
- TableHiTableHistoryPage.
(async) getTables(siteUID) → {Array.<Object>}
Gets the list of tables for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- Collection of Table objects.
- Type
- Array.<Object>
(async) getTables(siteUID) → {Array.<Object>}
Gets the list of tables for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- Collection of Table objects.
- Type
- Array.<Object>
(async) getTableStatus(siteUID, startTime, endTime) → {Array.<TableStatus>}
Gets the list of table statuses for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
startTime |
Date | Start time in ISO 8601 format. |
endTime |
Date | End time in ISO 8601 format. |
- Source:
Returns:
- Collection of Table statuses.
- Type
- Array.<TableStatus>
(async) getTableStatus(siteUID, startTime, endTime) → {Array.<TableStatus>}
Gets the list of table statuses for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
startTime |
Date | Start time in ISO 8601 format. |
endTime |
Date | End time in ISO 8601 format. |
- Source:
Returns:
- Collection of Table statuses.
- Type
- Array.<TableStatus>
(async) getTeamMemberEvents(siteUID, startTime, endTime) → {TeamMemberEventPage}
Get the paged list of team member events for the specified site within a specified time range.
This is ordered by last server update timestamp of the records. Page size is 100.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
startTime |
Date | Start time of updates. |
endTime |
Date | End time of updates. |
- Source:
Returns:
- TeamMemberEventPage.
- Type
- TeamMemberEventPage
(async) getTeamMemberEvents(siteUID, startTime, endTime) → {TeamMemberEventPage}
Get the paged list of team member events for the specified site within a specified time range.
This is ordered by last server update timestamp of the records. Page size is 100.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
startTime |
Date | Start time of updates. |
endTime |
Date | End time of updates. |
- Source:
Returns:
- TeamMemberEventPage.
- Type
- TeamMemberEventPage
(async) getTeamMembers(siteUID, startTime, endTime) → {Array.<TeamMember>}
Gets the list of team members for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
startTime |
Date | Start time of updates. |
endTime |
Date | End time of updates. |
- Source:
Returns:
- Collection of TeamMember.
- Type
- Array.<TeamMember>
(async) getTeamMembers(siteUID, startTime, endTime) → {Array.<TeamMember>}
Gets the list of team members for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
startTime |
Date | Start time of updates. |
endTime |
Date | End time of updates. |
- Source:
Returns:
- Collection of TeamMember.
- Type
- Array.<TeamMember>
(async) getVisit(siteUID, visitID) → {Visit}
Get a visit by ID.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitID |
string | Unique identifier of the target QSR visit record. |
- Source:
Returns:
- Visit.
- Type
- Visit
(async) getVisit(siteUID, visitID) → {Visit}
Get a visit by ID.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitID |
string | Unique identifier of the target QSR visit record. |
- Source:
Returns:
- Visit.
- Type
- Visit
(async) getVisitByExternalId(siteUID, externalUID) → {Visit}
Get a visit by its external ID.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
externalUID |
string | External ID of the target QSR visit record. |
- Source:
Returns:
- Visit.
- Type
- Visit
(async) getVisitByExternalId(siteUID, externalUID) → {Visit}
Get a visit by its external ID.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
externalUID |
string | External ID of the target QSR visit record. |
- Source:
Returns:
- Visit.
- Type
- Visit
(async) getVisitByLoyalityCard(siteUID, loyalityCardID, statusopt) → {Visit}
Get an "open" visit by guest’s Loyalty Card ID
An "open" visit is a visit that is not completed and not canceled.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
loyalityCardID |
string | Loyalty card ID of the guest for the target visits. | |
status |
string |
<optional> |
Only "open" is currently accepted. |
- Source:
Returns:
- Visit.
- Type
- Visit
(async) getVisitByLoyalityCard(siteUID, phoneNumber, countryCode, statusopt) → {Visit}
Get an "open" visit by guest’s phone number.
An "open" visit is a visit that is not completed and not canceled.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
phoneNumber |
string | Phone number of the guest for the target visits. Only US numbers can be used. Accepted formats include: E.164 format, national format. Example: ‘+12223334444’, ‘(222) 333-4444’, ‘2223334444’. | |
countryCode |
sring | Country code of the phone number of the guest for the target visits. Accepted values include ISO 3166-1 alpha-2. Example: US for the United States, and GB for the United Kingdom. | |
status |
string |
<optional> |
Only "open" is currently accepted. |
- Source:
Returns:
- Visit.
- Type
- Visit
(async) getVisitByLoyalityCard(siteUID, pagerID, statusopt) → {Visit}
Get an "open" visit by guest’s pager number.
An "open" visit is a visit that is not completed and not canceled.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
pagerID |
string | The pager number associated with the visit. | |
status |
string |
<optional> |
Only "open" is currently accepted. |
- Source:
Returns:
- Visit.
- Type
- Visit
(async) getVisitByLoyalityCard(siteUID, loyalityCardID, statusopt) → {Visit}
Get an "open" visit by guest’s Loyalty Card ID
An "open" visit is a visit that is not completed and not canceled.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
loyalityCardID |
string | Loyalty card ID of the guest for the target visits. | |
status |
string |
<optional> |
Only "open" is currently accepted. |
- Source:
Returns:
- Visit.
- Type
- Visit
(async) getVisitByLoyalityCard(siteUID, phoneNumber, countryCode, statusopt) → {Visit}
Get an "open" visit by guest’s phone number.
An "open" visit is a visit that is not completed and not canceled.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
phoneNumber |
string | Phone number of the guest for the target visits. Only US numbers can be used. Accepted formats include: E.164 format, national format. Example: ‘+12223334444’, ‘(222) 333-4444’, ‘2223334444’. | |
countryCode |
sring | Country code of the phone number of the guest for the target visits. Accepted values include ISO 3166-1 alpha-2. Example: US for the United States, and GB for the United Kingdom. | |
status |
string |
<optional> |
Only "open" is currently accepted. |
- Source:
Returns:
- Visit.
- Type
- Visit
(async) getVisitByLoyalityCard(siteUID, pagerID, statusopt) → {Visit}
Get an "open" visit by guest’s pager number.
An "open" visit is a visit that is not completed and not canceled.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
pagerID |
string | The pager number associated with the visit. | |
status |
string |
<optional> |
Only "open" is currently accepted. |
- Source:
Returns:
- Visit.
- Type
- Visit
(async) getVisitUpdates(siteUID, startTime, stopTime, syncSourceopt) → {VisitPollResponse}
Get the paged list of visit updates for a specified site within a specified time range,
excluding updates made by the specified 'syncSource'.
This is ordered by last update timestamp of the visit records. Page size is 30.
If the total number of visits exceeds 30:
- The first 30 records are returned.
- 'MoreData' is "True"
- 'TimeStampCutoff' is the last update timestamp of the last record returned.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
startTime |
string | Start time of updates. | |
stopTime |
string | End time of updates. | |
syncSource |
string |
<optional> |
Exclude results made by specified 'syncSource' |
- Source:
Returns:
- Paged results for Visits.
- Type
- VisitPollResponse
(async) getVisitUpdates(siteUID, startTime, stopTime, syncSourceopt) → {VisitPollResponse}
Get the paged list of visit updates for a specified site within a specified time range,
excluding updates made by the specified 'syncSource'.
This is ordered by last update timestamp of the visit records. Page size is 30.
If the total number of visits exceeds 30:
- The first 30 records are returned.
- 'MoreData' is "True"
- 'TimeStampCutoff' is the last update timestamp of the last record returned.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
startTime |
string | Start time of updates. | |
stopTime |
string | End time of updates. | |
syncSource |
string |
<optional> |
Exclude results made by specified 'syncSource' |
- Source:
Returns:
- Paged results for Visits.
- Type
- VisitPollResponse
(async) getWaitListStatus(siteUID, partySize) → {WaitListStatus}
Get wait list status and quote for web ahead based on party size.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
partySize |
number | Party size. |
- Source:
Returns:
- WaitListStatus.
- Type
- WaitListStatus
(async) getWaitListStatus(siteUID, partySizes) → {WaitListStatus}
Get wait list status and quote for web ahead for multiple party sizes.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
partySizes |
Array.<number> | Array of party sizes. |
- Source:
Returns:
- WaitListStatus with quotes.
- Type
- WaitListStatus
(async) getWaitListStatus(siteUID, partySize) → {WaitListStatus}
Get wait list status and quote for web ahead based on party size.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
partySize |
number | Party size. |
- Source:
Returns:
- WaitListStatus.
- Type
- WaitListStatus
(async) getWaitListStatus(siteUID, partySizes) → {WaitListStatus}
Get wait list status and quote for web ahead for multiple party sizes.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
partySizes |
Array.<number> | Array of party sizes. |
- Source:
Returns:
- WaitListStatus with quotes.
- Type
- WaitListStatus
(async) getWaitListStatusMultipleSites(siteUID, partySizes) → {WaitListStatusForSites}
Get wait list status and quote for web ahead based on party size, for multiple sites.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
Array.<string> | Globally unique identifier for a site. |
partySizes |
Array.<number> | Array of party sizes. |
- Source:
Returns:
- WaitListStatusForSites.
(async) getWaitListStatusMultipleSites(siteUID, partySizes) → {WaitListStatusForSites}
Get wait list status and quote for web ahead based on party size, for multiple sites.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
Array.<string> | Globally unique identifier for a site. |
partySizes |
Array.<number> | Array of party sizes. |
- Source:
Returns:
- WaitListStatusForSites.
(async) getWebAhead(siteUID, visitID, expandopt, inclQuoteopt, allopt) → {WebAhead|Array.<WebAhead>}
Get a WebAhead. By default, only active WebAheads will be returned.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
visitID |
string | A globally unique identifier for a QSR visit record. | |
expand |
string |
<optional> |
Optional. ‘guest’ is currently the only acceptable value. If this parameter is passed, the guest record should be included in the returned WebAhead data. |
inclQuote |
boolean |
<optional> |
Optional. If True, this will return an additional object named "UpdatedQuote" which contains the most recent updated quote for the party, if it exists. |
all |
boolean |
<optional> |
Optional. If True, ignores status for current business day and returns all WebAheads created for site local business day. |
- Source:
Returns:
- The requested WebHead(s)
(async) getWebAhead(siteUID, visitID, expandopt, inclQuoteopt, allopt) → {WebAhead|Array.<WebAhead>}
Get a WebAhead. By default, only active WebAheads will be returned.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |
visitID |
string | A globally unique identifier for a QSR visit record. | |
expand |
string |
<optional> |
Optional. ‘guest’ is currently the only acceptable value. If this parameter is passed, the guest record should be included in the returned WebAhead data. |
inclQuote |
boolean |
<optional> |
Optional. If True, this will return an additional object named "UpdatedQuote" which contains the most recent updated quote for the party, if it exists. |
all |
boolean |
<optional> |
Optional. If True, ignores status for current business day and returns all WebAheads created for site local business day. |
- Source:
Returns:
- The requested WebHead(s)
(async) getWebAheadByConfirmation(confirmationNumber, allopt) → {WebAhead|Array.<WebAhead>}
Get a WebAhead. By default, only active WebAheads will be returned.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
confirmationNumber |
string | Confirmation number. | |
all |
boolean |
<optional> |
Optional. If True, eturn all WebAheads created within the current site local business day. |
- Source:
Returns:
- The requested WebHead(s)
(async) getWebAheadByConfirmation(confirmationNumber, allopt) → {WebAhead|Array.<WebAhead>}
Get a WebAhead. By default, only active WebAheads will be returned.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
confirmationNumber |
string | Confirmation number. | |
all |
boolean |
<optional> |
Optional. If True, eturn all WebAheads created within the current site local business day. |
- Source:
Returns:
- The requested WebHead(s)
(async) getWebAheadByConfirmationId(confirmationNumber, allopt) → {WebAhead|Array.<WebAhead>}
Get a WebAhead. By default, only active WebAheads will be returned.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
confirmationNumber |
number | Integer identifier of the visit confirmation number. | |
all |
boolean |
<optional> |
Optional. If True, eturn all WebAheads created within the current site local business day. |
- Source:
Returns:
- The requested WebHead(s)
(async) getWebAheadByConfirmationId(confirmationNumber, allopt) → {WebAhead|Array.<WebAhead>}
Get a WebAhead. By default, only active WebAheads will be returned.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, Partially Arrived or Notified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
confirmationNumber |
number | Integer identifier of the visit confirmation number. | |
all |
boolean |
<optional> |
Optional. If True, eturn all WebAheads created within the current site local business day. |
- Source:
Returns:
- The requested WebHead(s)
(async) removeGuest(guestId, syncSourceopt) → {boolean}
Deletes the specified guest record.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
guestId |
string | A globally unique identifier for a QSR guest record. | |
syncSource |
string |
<optional> |
Optional. Optional. QSR-defined string representing a source of records. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) removeGuest(guestId, syncSourceopt) → {boolean}
Deletes the specified guest record.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
guestId |
string | A globally unique identifier for a QSR guest record. | |
syncSource |
string |
<optional> |
Optional. Optional. QSR-defined string representing a source of records. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) removeReservation(siteUID, visitUID) → {boolean}
Cancel the specified reservation visit for the specified site.
Note: Sync bypasses thea vailability check.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) removeReservation(siteUID, visitUID) → {boolean}
Cancel the specified reservation visit for the specified site.
Note: Sync bypasses thea vailability check.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitUID |
string | Globally unique identifier for a site. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) removeTeamMember(siteUID, teamMemberId) → {boolean}
Delete team members for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
teamMemberId |
string | Globally unique identifier of the TeamMember record. |
- Source:
Returns:
- Returns true if successful.
- Type
- boolean
(async) removeTeamMember(siteUID, teamMemberId) → {boolean}
Delete team members for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
teamMemberId |
string | Globally unique identifier of the TeamMember record. |
- Source:
Returns:
- Returns true if successful.
- Type
- boolean
(async) searchGuestbook(info) → {Array.<Guest>}
Search guestbook by the specified filters.
Returns paged search results ordered by last name field,
specified by parameters: info.guestsPerPage and info.pageNumber.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
info |
Object | Search parameters
Properties
|
- Source:
Returns:
- Collection of Guest.
- Type
- Array.<Guest>
(async) searchGuestbook(info) → {Array.<Guest>}
Search guestbook by the specified filters.
Returns paged search results ordered by last name field,
specified by parameters: info.guestsPerPage and info.pageNumber.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
info |
Object | Search parameters
Properties
|
- Source:
Returns:
- Collection of Guest.
- Type
- Array.<Guest>
(async) syncExternalReservation(siteUID, externalId, info) → {boolean}
Sync a reservation record to DineTime Enterprise.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||||||||||||||
externalId |
* | External identifier of the reservation. | ||||||||||||||||||||||||||||||||||||||||
info |
Object | External reservation information.
Properties
|
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) syncExternalReservation(siteUID, externalId, info) → {boolean}
Sync a reservation record to DineTime Enterprise.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||||||||||||||
externalId |
* | External identifier of the reservation. | ||||||||||||||||||||||||||||||||||||||||
info |
Object | External reservation information.
Properties
|
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) updateGuest(guestId, dataopt, syncSourceopt) → {boolean}
Updates the specified guest record.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
guestId |
string | A globally unique identifier for a QSR guest record. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
data |
Object |
<optional> |
Optional. Guest data to add.
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
syncSource |
string |
<optional> |
Optional. Optional. QSR-defined string representing a source of records. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) updateGuest(guestId, dataopt, syncSourceopt) → {boolean}
Updates the specified guest record.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
guestId |
string | A globally unique identifier for a QSR guest record. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
data |
Object |
<optional> |
Optional. Guest data to add.
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
syncSource |
string |
<optional> |
Optional. Optional. QSR-defined string representing a source of records. |
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) updatePartyMix(siteUID, visitID, partyMix) → {PartyMix}
Update visit Party Mix.
Note: The total guest count of all party mix values must equal the party size of the visit.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitID |
string | Unique identifier of the target QSR visit record. |
partyMix |
string | Type and count of the party mixes. |
- Source:
Returns:
- Party Mix.
- Type
- PartyMix
(async) updatePartyMix(siteUID, visitID, partyMix) → {PartyMix}
Update visit Party Mix.
Note: The total guest count of all party mix values must equal the party size of the visit.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
visitID |
string | Unique identifier of the target QSR visit record. |
partyMix |
string | Type and count of the party mixes. |
- Source:
Returns:
- Party Mix.
- Type
- PartyMix
(async) updateReservation(siteUID, visitUID, info) → {boolean}
Adds a reservation to the site for the specified date and time.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||||||
visitUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||||||
info |
Object | Information for the reservation.
Properties
|
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) updateReservation(siteUID, visitUID, info) → {boolean}
Adds a reservation to the site for the specified date and time.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||||||
visitUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||||||||||||||
info |
Object | Information for the reservation.
Properties
|
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) updateTeamMember(siteUID, teamMemberId, teamMemberUpdate) → {Array.<TeamMemeber>}
Update team members for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
teamMemberId |
string | Globally unique identifier of the TeamMember record. |
teamMemberUpdate |
TeamMemeber | TeamMember object to update from. |
- Source:
Returns:
- Collection of TeamMember.
- Type
- Array.<TeamMemeber>
(async) updateTeamMember(siteUID, teamMemberId, teamMemberUpdate) → {Array.<TeamMemeber>}
Update team members for the specified site.
Parameters:
| Name | Type | Description |
|---|---|---|
siteUID |
string | Globally unique identifier for a site. |
teamMemberId |
string | Globally unique identifier of the TeamMember record. |
teamMemberUpdate |
TeamMemeber | TeamMember object to update from. |
- Source:
Returns:
- Collection of TeamMember.
- Type
- Array.<TeamMemeber>
(async) updateVisitProximity(siteUID, visitID, info) → {boolean}
This endpoint is for third party apps or services to update the distance and position that a prospective visit is from a site.
The data is stored in the SiteEventQueue.
Parameters:
| Name | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||
visitID |
string | A globally unique identifier for a QSR visit record. | ||||||||||||||||||||
info |
Object | Proximiy info.
Properties
|
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) updateVisitProximity(siteUID, visitID, info) → {boolean}
This endpoint is for third party apps or services to update the distance and position that a prospective visit is from a site.
The data is stored in the SiteEventQueue.
Parameters:
| Name | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | ||||||||||||||||||||
visitID |
string | A globally unique identifier for a QSR visit record. | ||||||||||||||||||||
info |
Object | Proximiy info.
Properties
|
- Source:
Returns:
- True if successful.
- Type
- boolean
(async) updateWebAhead(siteUID, visitID, infoopt) → {WebAhead}
Update a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, PartiallyArrived or Notified.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |||||||||||||||||||||||||||||||||||||||||||||||||
visitID |
string | A globally unique identifier for a QSR visit record. | |||||||||||||||||||||||||||||||||||||||||||||||||
info |
Object |
<optional> |
Information object for WebAhead.
Properties
|
- Source:
Returns:
- The updated WebHead.
- Type
- WebAhead
(async) updateWebAhead(siteUID, visitID, infoopt) → {WebAhead}
Update a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, PartiallyArrived or Notified.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
siteUID |
string | Globally unique identifier for a site. | |||||||||||||||||||||||||||||||||||||||||||||||||
visitID |
string | A globally unique identifier for a QSR visit record. | |||||||||||||||||||||||||||||||||||||||||||||||||
info |
Object |
<optional> |
Information object for WebAhead.
Properties
|
- Source:
Returns:
- The updated WebHead.
- Type
- WebAhead
(async) updateWebAheadByConfirmation(confirmationNumber, infoopt) → {WebAhead}
Update a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, PartiallyArrived or Notified.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
confirmationNumber |
string | Confirmation number. | |||||||||||||||||||||||||||||||||||||||||||||||||
info |
Object |
<optional> |
Information object for WebAhead.
Properties
|
- Source:
Returns:
- The updated WebHead.
- Type
- WebAhead
(async) updateWebAheadByConfirmation(confirmationNumber, infoopt) → {WebAhead}
Update a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, PartiallyArrived or Notified.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
confirmationNumber |
string | Confirmation number. | |||||||||||||||||||||||||||||||||||||||||||||||||
info |
Object |
<optional> |
Information object for WebAhead.
Properties
|
- Source:
Returns:
- The updated WebHead.
- Type
- WebAhead
(async) updateWebAheadByConfirmationId(confirmationNumberId, infoopt) → {WebAhead}
Update a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, PartiallyArrived or Notified.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
confirmationNumberId |
number | Integer identifier of the visit confirmation number. | |||||||||||||||||||||||||||||||||||||||||||||||||
info |
Object |
<optional> |
Information object for WebAhead.
Properties
|
- Source:
Returns:
- The updated WebHead.
- Type
- WebAhead
(async) updateWebAheadByConfirmationId(confirmationNumberId, infoopt) → {WebAhead}
Update a WebAhead. Call will only succeed if the target WebAhead is Active.
A WebAhead is considered Active if in one of the following states: NotYetArrived, Waiting, PartiallyArrived or Notified.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
confirmationNumberId |
number | Integer identifier of the visit confirmation number. | |||||||||||||||||||||||||||||||||||||||||||||||||
info |
Object |
<optional> |
Information object for WebAhead.
Properties
|
- Source:
Returns:
- The updated WebHead.
- Type
- WebAhead