GET v1/Sites/Search/{searchTerm}
URI template
v1/Sites/Search/{searchTerm}?offset={offset}&limit={limit}&lastTimeRetrieved={lastTimeRetrieved}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
searchTerm |
String that will be matched against: Name, State, City, Postal Code, Address and External ID |
string |
Required |
offset |
Index of the page to display |
integer |
Default value is 0 |
limit |
Number of sites per-page |
integer |
Default value is 5 |
lastTimeRetrieved |
Optional parameter used to limit results to those modified after this time |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
A list of sites. Known internal errors are BadRequest and NotFound
Collection of SiteName | Description | Type | Additional information |
---|---|---|---|
SiteId |
The Aloha Online Site Id |
integer |
None. |
ExternalId |
The Aloha Online External Site Id |
string |
None. |
EnterpriseUnitId |
ODSP Enterprise Unit Id |
string |
None. |
SiteName |
The name of the site |
string |
None. |
Description |
A short description of the site to give the customer more context |
string |
None. |
AddressLine1 |
The first address line for the site |
string |
None. |
AddressLine2 |
The second address line for the site |
string |
None. |
City |
The city of the site |
string |
None. |
State |
The state of the site |
string |
None. |
Postal |
The postal code of the site |
string |
None. |
VoicePhone |
The phone number of the site |
string |
None. |
FAXPhone |
The fax number of the site |
string |
None. |
WebDesignId |
The design id for the site, used in conjuction with Menu retrieval and CalcTaxAndTotal |
integer |
None. |
IsEnabled |
Is the site currently enabled |
boolean |
None. |
IsLoyaltyEnabled |
Does the site currently support Loyalty |
boolean |
None. |
IsStoredValueCardEnabled |
Does the site currently support StoredValueCard |
boolean |
None. |
TimeOffsetHours |
OBSOLETE: use TimeOffsetMinutes. The time zone difference between the site and the server. |
integer |
None. |
TimeOffsetMinutes |
The time zone difference between the site and UTC in minutes |
integer |
None. |
Latitude |
The latitude of the site |
decimal number |
None. |
Longitude |
The longitude of the site |
decimal number |
None. |
LastModifiedTimestamp |
The last time the site was updated via the Admin screen |
date |
None. |
CateringBCCEmailList |
BCC Email List for Catering Orders. |
string |
None. |
RetailBCCEmailList |
BCC Email List for Retail Orders. |
string |
None. |
IsMobileEnabled |
Is mobile enabled for this site |
boolean |
None. |
CreditProcessingMode |
The credit processing mode that this site uses
|
CreditProcessingMode |
None. |
SiteStatus |
If Site is emergency closed, status is:
|
SiteStatus |
None. |
SupportedOrderModes |
The supported order modes for the site |
OrderModeType |
None. |
SupportedDeliveryModes |
The supported delivery modes for the site This field is valid only if Company Setting UseDeliveryService is available AND set to true. In all other cases this field, although populated SHOULD be ignored. Please refer to the implementation guide for those details |
DeliveryModeType |
None. |
DeliveryRange |
The DeliveryRange of the site |
decimal number |
None. |
Hours |
The store hours |
Collection of SiteHours |
None. |
SpecialEvents |
The store special events for next 3 months |
Collection of SiteSpecialEvent |
None. |
StoreIdentifier |
Get or set the StoreIdentifier property |
integer |
None. |
AvailableProducts |
Indicates which NCR Voyix products are available on site |
Collection of ProductType |
None. |
OrderingState |
Determines order acceptance state of the site. |
SiteOrderingState |
None. |
Locator |
Describes whether the user can browse site menu. |
SiteBrowsableState |
None. |
RequireTableNumber |
Get or set the RequireTableNumber flag |
boolean |
None. |
OpenCheckEnabled |
Get or set the OpenCheckEnabled flag |
boolean |
None. |
StartTabEnabled |
Get or set the StartTabEnabled flag |
boolean |
None. |
OpenCheckAutoCloseEnabled |
Get or set the OpenCheckAutoCloseEnabled flag |
boolean |
None. |
Response Formats
application/json, text/json
[ { "$id": "1", "SiteId": 1, "ExternalId": "sample string 2", "EnterpriseUnitId": "sample string 3", "SiteName": "sample string 4", "Description": "sample string 5", "AddressLine1": "sample string 6", "AddressLine2": "sample string 7", "City": "sample string 8", "State": "sample string 9", "Postal": "sample string 10", "VoicePhone": "sample string 11", "FAXPhone": "sample string 12", "WebDesignId": 13, "IsEnabled": true, "IsLoyaltyEnabled": true, "IsStoredValueCardEnabled": true, "TimeOffsetHours": 17, "TimeOffsetMinutes": 18, "Latitude": 19.1, "Longitude": 20.1, "LastModifiedTimestamp": "2025-04-24T20:16:29.9791791", "CateringBCCEmailList": "sample string 22", "RetailBCCEmailList": "sample string 23", "IsMobileEnabled": true, "CreditProcessingMode": 0, "SiteStatus": 0, "SupportedOrderModes": 1, "SupportedDeliveryModes": 0, "DeliveryRange": 25.1, "Hours": [ { "$id": "2", "DayOfWeek": 0, "OpeningTime": "00:00:00.1234567", "ClosingTime": "00:00:00.1234567", "IsClosed": true, "IsClosedForDelivery": true, "Delivery1Start": "2025-04-24T20:16:29.9791791", "Delivery1End": "2025-04-24T20:16:29.9791791", "Delivery2Start": "2025-04-24T20:16:29.9791791", "Delivery2End": "2025-04-24T20:16:29.9791791" }, { "$id": "3", "DayOfWeek": 0, "OpeningTime": "00:00:00.1234567", "ClosingTime": "00:00:00.1234567", "IsClosed": true, "IsClosedForDelivery": true, "Delivery1Start": "2025-04-24T20:16:29.9791791", "Delivery1End": "2025-04-24T20:16:29.9791791", "Delivery2Start": "2025-04-24T20:16:29.9791791", "Delivery2End": "2025-04-24T20:16:29.9791791" } ], "SpecialEvents": [ { "$id": "4", "SpecialEventId": 42, "SpecialEventStartDate": "2025-04-24T20:16:29.9791791", "Name": "sample string 44", "OpeningTime": "2025-04-24T20:16:29.9791791", "ClosingTime": "2025-04-24T20:16:29.9791791", "IsClosed": true, "IsClosedDelivery": true, "SpecialEventEndDate": "2025-04-24T20:16:29.9791791", "IsCompanyWide": true, "Delivery1Start": "2025-04-24T20:16:29.9791791", "Delivery1End": "2025-04-24T20:16:29.9791791", "Delivery2Start": "2025-04-24T20:16:29.9791791", "Delivery2End": "2025-04-24T20:16:29.9791791", "SpecialEventPurpose": "sample string 55" }, { "$id": "5", "SpecialEventId": 56, "SpecialEventStartDate": "2025-04-24T20:16:29.9791791", "Name": "sample string 58", "OpeningTime": "2025-04-24T20:16:29.9791791", "ClosingTime": "2025-04-24T20:16:29.9791791", "IsClosed": true, "IsClosedDelivery": true, "SpecialEventEndDate": "2025-04-24T20:16:29.9791791", "IsCompanyWide": true, "Delivery1Start": "2025-04-24T20:16:29.9791791", "Delivery1End": "2025-04-24T20:16:29.9791791", "Delivery2Start": "2025-04-24T20:16:29.9791791", "Delivery2End": "2025-04-24T20:16:29.9791791", "SpecialEventPurpose": "sample string 69" } ], "StoreIdentifier": 70, "AvailableProducts": [ 0, 0 ], "OrderingState": 0, "Locator": 0, "RequireTableNumber": true, "OpenCheckEnabled": true, "StartTabEnabled": true, "OpenCheckAutoCloseEnabled": true }, { "$id": "6", "SiteId": 75, "ExternalId": "sample string 76", "EnterpriseUnitId": "sample string 77", "SiteName": "sample string 78", "Description": "sample string 79", "AddressLine1": "sample string 80", "AddressLine2": "sample string 81", "City": "sample string 82", "State": "sample string 83", "Postal": "sample string 84", "VoicePhone": "sample string 85", "FAXPhone": "sample string 86", "WebDesignId": 87, "IsEnabled": true, "IsLoyaltyEnabled": true, "IsStoredValueCardEnabled": true, "TimeOffsetHours": 91, "TimeOffsetMinutes": 92, "Latitude": 93.1, "Longitude": 94.1, "LastModifiedTimestamp": "2025-04-24T20:16:29.9791791", "CateringBCCEmailList": "sample string 96", "RetailBCCEmailList": "sample string 97", "IsMobileEnabled": true, "CreditProcessingMode": 0, "SiteStatus": 0, "SupportedOrderModes": 1, "SupportedDeliveryModes": 0, "DeliveryRange": 99.1, "Hours": [ { "$id": "7", "DayOfWeek": 0, "OpeningTime": "00:00:00.1234567", "ClosingTime": "00:00:00.1234567", "IsClosed": true, "IsClosedForDelivery": true, "Delivery1Start": "2025-04-24T20:16:29.9797058", "Delivery1End": "2025-04-24T20:16:29.9797058", "Delivery2Start": "2025-04-24T20:16:29.9797058", "Delivery2End": "2025-04-24T20:16:29.9797058" }, { "$id": "8", "DayOfWeek": 0, "OpeningTime": "00:00:00.1234567", "ClosingTime": "00:00:00.1234567", "IsClosed": true, "IsClosedForDelivery": true, "Delivery1Start": "2025-04-24T20:16:29.9797058", "Delivery1End": "2025-04-24T20:16:29.9797058", "Delivery2Start": "2025-04-24T20:16:29.9797058", "Delivery2End": "2025-04-24T20:16:29.9797058" } ], "SpecialEvents": [ { "$id": "9", "SpecialEventId": 116, "SpecialEventStartDate": "2025-04-24T20:16:29.979744", "Name": "sample string 118", "OpeningTime": "2025-04-24T20:16:29.979744", "ClosingTime": "2025-04-24T20:16:29.979744", "IsClosed": true, "IsClosedDelivery": true, "SpecialEventEndDate": "2025-04-24T20:16:29.979744", "IsCompanyWide": true, "Delivery1Start": "2025-04-24T20:16:29.979744", "Delivery1End": "2025-04-24T20:16:29.979744", "Delivery2Start": "2025-04-24T20:16:29.979744", "Delivery2End": "2025-04-24T20:16:29.979744", "SpecialEventPurpose": "sample string 129" }, { "$id": "10", "SpecialEventId": 130, "SpecialEventStartDate": "2025-04-24T20:16:29.979744", "Name": "sample string 132", "OpeningTime": "2025-04-24T20:16:29.979744", "ClosingTime": "2025-04-24T20:16:29.979744", "IsClosed": true, "IsClosedDelivery": true, "SpecialEventEndDate": "2025-04-24T20:16:29.9797774", "IsCompanyWide": true, "Delivery1Start": "2025-04-24T20:16:29.9797774", "Delivery1End": "2025-04-24T20:16:29.9797774", "Delivery2Start": "2025-04-24T20:16:29.9797774", "Delivery2End": "2025-04-24T20:16:29.9797774", "SpecialEventPurpose": "sample string 143" } ], "StoreIdentifier": 144, "AvailableProducts": [ 0, 0 ], "OrderingState": 0, "Locator": 0, "RequireTableNumber": true, "OpenCheckEnabled": true, "StartTabEnabled": true, "OpenCheckAutoCloseEnabled": true } ]
application/xml, text/xml
<ArrayOfSite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <Site> <AddressLine1>sample string 6</AddressLine1> <AddressLine2>sample string 7</AddressLine2> <AvailableProducts> <ProductType>Invalid</ProductType> <ProductType>Invalid</ProductType> </AvailableProducts> <CateringBCCEmailList>sample string 22</CateringBCCEmailList> <City>sample string 8</City> <CreditProcessingMode>NotSupported</CreditProcessingMode> <DeliveryRange>25.1</DeliveryRange> <Description>sample string 5</Description> <EnterpriseUnitId>sample string 3</EnterpriseUnitId> <ExternalId>sample string 2</ExternalId> <FAXPhone>sample string 12</FAXPhone> <Hours> <SiteHours> <ClosingTime>PT0.1234567S</ClosingTime> <DayOfWeek>Sunday</DayOfWeek> <Delivery1End>2025-04-24T20:16:29.9791791</Delivery1End> <Delivery1Start>2025-04-24T20:16:29.9791791</Delivery1Start> <Delivery2End>2025-04-24T20:16:29.9791791</Delivery2End> <Delivery2Start>2025-04-24T20:16:29.9791791</Delivery2Start> <IsClosed>true</IsClosed> <IsClosedForDelivery>true</IsClosedForDelivery> <OpeningTime>PT0.1234567S</OpeningTime> </SiteHours> <SiteHours> <ClosingTime>PT0.1234567S</ClosingTime> <DayOfWeek>Sunday</DayOfWeek> <Delivery1End>2025-04-24T20:16:29.9791791</Delivery1End> <Delivery1Start>2025-04-24T20:16:29.9791791</Delivery1Start> <Delivery2End>2025-04-24T20:16:29.9791791</Delivery2End> <Delivery2Start>2025-04-24T20:16:29.9791791</Delivery2Start> <IsClosed>true</IsClosed> <IsClosedForDelivery>true</IsClosedForDelivery> <OpeningTime>PT0.1234567S</OpeningTime> </SiteHours> </Hours> <IsEnabled>true</IsEnabled> <IsLoyaltyEnabled>true</IsLoyaltyEnabled> <IsMobileEnabled>true</IsMobileEnabled> <IsStoredValueCardEnabled>true</IsStoredValueCardEnabled> <LastModifiedTimestamp>2025-04-24T20:16:29.9791791</LastModifiedTimestamp> <Latitude>19.1</Latitude> <Locator>NotBrowsable</Locator> <Longitude>20.1</Longitude> <OpenCheckAutoCloseEnabled>true</OpenCheckAutoCloseEnabled> <OpenCheckEnabled>true</OpenCheckEnabled> <OrderingState>NotAcceptingOrders</OrderingState> <Postal>sample string 10</Postal> <RequireTableNumber>true</RequireTableNumber> <RetailBCCEmailList>sample string 23</RetailBCCEmailList> <SiteId>1</SiteId> <SiteName>sample string 4</SiteName> <SiteStatus>SiteIsUp</SiteStatus> <SpecialEvents> <SiteSpecialEvent> <ClosingTime>2025-04-24T20:16:29.9791791</ClosingTime> <Delivery1End>2025-04-24T20:16:29.9791791</Delivery1End> <Delivery1Start>2025-04-24T20:16:29.9791791</Delivery1Start> <Delivery2End>2025-04-24T20:16:29.9791791</Delivery2End> <Delivery2Start>2025-04-24T20:16:29.9791791</Delivery2Start> <IsClosed>true</IsClosed> <IsClosedDelivery>true</IsClosedDelivery> <IsCompanyWide>true</IsCompanyWide> <Name>sample string 44</Name> <OpeningTime>2025-04-24T20:16:29.9791791</OpeningTime> <SpecialEventEndDate>2025-04-24T20:16:29.9791791</SpecialEventEndDate> <SpecialEventId>42</SpecialEventId> <SpecialEventPurpose>sample string 55</SpecialEventPurpose> <SpecialEventStartDate>2025-04-24T20:16:29.9791791</SpecialEventStartDate> </SiteSpecialEvent> <SiteSpecialEvent> <ClosingTime>2025-04-24T20:16:29.9791791</ClosingTime> <Delivery1End>2025-04-24T20:16:29.9791791</Delivery1End> <Delivery1Start>2025-04-24T20:16:29.9791791</Delivery1Start> <Delivery2End>2025-04-24T20:16:29.9791791</Delivery2End> <Delivery2Start>2025-04-24T20:16:29.9791791</Delivery2Start> <IsClosed>true</IsClosed> <IsClosedDelivery>true</IsClosedDelivery> <IsCompanyWide>true</IsCompanyWide> <Name>sample string 58</Name> <OpeningTime>2025-04-24T20:16:29.9791791</OpeningTime> <SpecialEventEndDate>2025-04-24T20:16:29.9791791</SpecialEventEndDate> <SpecialEventId>56</SpecialEventId> <SpecialEventPurpose>sample string 69</SpecialEventPurpose> <SpecialEventStartDate>2025-04-24T20:16:29.9791791</SpecialEventStartDate> </SiteSpecialEvent> </SpecialEvents> <StartTabEnabled>true</StartTabEnabled> <State>sample string 9</State> <StoreIdentifier>70</StoreIdentifier> <SupportedDeliveryModes>None</SupportedDeliveryModes> <SupportedOrderModes>Pickup</SupportedOrderModes> <TimeOffsetHours>17</TimeOffsetHours> <TimeOffsetMinutes>18</TimeOffsetMinutes> <VoicePhone>sample string 11</VoicePhone> <WebDesignId>13</WebDesignId> </Site> <Site> <AddressLine1>sample string 80</AddressLine1> <AddressLine2>sample string 81</AddressLine2> <AvailableProducts> <ProductType>Invalid</ProductType> <ProductType>Invalid</ProductType> </AvailableProducts> <CateringBCCEmailList>sample string 96</CateringBCCEmailList> <City>sample string 82</City> <CreditProcessingMode>NotSupported</CreditProcessingMode> <DeliveryRange>99.1</DeliveryRange> <Description>sample string 79</Description> <EnterpriseUnitId>sample string 77</EnterpriseUnitId> <ExternalId>sample string 76</ExternalId> <FAXPhone>sample string 86</FAXPhone> <Hours> <SiteHours> <ClosingTime>PT0.1234567S</ClosingTime> <DayOfWeek>Sunday</DayOfWeek> <Delivery1End>2025-04-24T20:16:29.9797058</Delivery1End> <Delivery1Start>2025-04-24T20:16:29.9797058</Delivery1Start> <Delivery2End>2025-04-24T20:16:29.9797058</Delivery2End> <Delivery2Start>2025-04-24T20:16:29.9797058</Delivery2Start> <IsClosed>true</IsClosed> <IsClosedForDelivery>true</IsClosedForDelivery> <OpeningTime>PT0.1234567S</OpeningTime> </SiteHours> <SiteHours> <ClosingTime>PT0.1234567S</ClosingTime> <DayOfWeek>Sunday</DayOfWeek> <Delivery1End>2025-04-24T20:16:29.9797058</Delivery1End> <Delivery1Start>2025-04-24T20:16:29.9797058</Delivery1Start> <Delivery2End>2025-04-24T20:16:29.9797058</Delivery2End> <Delivery2Start>2025-04-24T20:16:29.9797058</Delivery2Start> <IsClosed>true</IsClosed> <IsClosedForDelivery>true</IsClosedForDelivery> <OpeningTime>PT0.1234567S</OpeningTime> </SiteHours> </Hours> <IsEnabled>true</IsEnabled> <IsLoyaltyEnabled>true</IsLoyaltyEnabled> <IsMobileEnabled>true</IsMobileEnabled> <IsStoredValueCardEnabled>true</IsStoredValueCardEnabled> <LastModifiedTimestamp>2025-04-24T20:16:29.9791791</LastModifiedTimestamp> <Latitude>93.1</Latitude> <Locator>NotBrowsable</Locator> <Longitude>94.1</Longitude> <OpenCheckAutoCloseEnabled>true</OpenCheckAutoCloseEnabled> <OpenCheckEnabled>true</OpenCheckEnabled> <OrderingState>NotAcceptingOrders</OrderingState> <Postal>sample string 84</Postal> <RequireTableNumber>true</RequireTableNumber> <RetailBCCEmailList>sample string 97</RetailBCCEmailList> <SiteId>75</SiteId> <SiteName>sample string 78</SiteName> <SiteStatus>SiteIsUp</SiteStatus> <SpecialEvents> <SiteSpecialEvent> <ClosingTime>2025-04-24T20:16:29.979744</ClosingTime> <Delivery1End>2025-04-24T20:16:29.979744</Delivery1End> <Delivery1Start>2025-04-24T20:16:29.979744</Delivery1Start> <Delivery2End>2025-04-24T20:16:29.979744</Delivery2End> <Delivery2Start>2025-04-24T20:16:29.979744</Delivery2Start> <IsClosed>true</IsClosed> <IsClosedDelivery>true</IsClosedDelivery> <IsCompanyWide>true</IsCompanyWide> <Name>sample string 118</Name> <OpeningTime>2025-04-24T20:16:29.979744</OpeningTime> <SpecialEventEndDate>2025-04-24T20:16:29.979744</SpecialEventEndDate> <SpecialEventId>116</SpecialEventId> <SpecialEventPurpose>sample string 129</SpecialEventPurpose> <SpecialEventStartDate>2025-04-24T20:16:29.979744</SpecialEventStartDate> </SiteSpecialEvent> <SiteSpecialEvent> <ClosingTime>2025-04-24T20:16:29.979744</ClosingTime> <Delivery1End>2025-04-24T20:16:29.9797774</Delivery1End> <Delivery1Start>2025-04-24T20:16:29.9797774</Delivery1Start> <Delivery2End>2025-04-24T20:16:29.9797774</Delivery2End> <Delivery2Start>2025-04-24T20:16:29.9797774</Delivery2Start> <IsClosed>true</IsClosed> <IsClosedDelivery>true</IsClosedDelivery> <IsCompanyWide>true</IsCompanyWide> <Name>sample string 132</Name> <OpeningTime>2025-04-24T20:16:29.979744</OpeningTime> <SpecialEventEndDate>2025-04-24T20:16:29.9797774</SpecialEventEndDate> <SpecialEventId>130</SpecialEventId> <SpecialEventPurpose>sample string 143</SpecialEventPurpose> <SpecialEventStartDate>2025-04-24T20:16:29.979744</SpecialEventStartDate> </SiteSpecialEvent> </SpecialEvents> <StartTabEnabled>true</StartTabEnabled> <State>sample string 83</State> <StoreIdentifier>144</StoreIdentifier> <SupportedDeliveryModes>None</SupportedDeliveryModes> <SupportedOrderModes>Pickup</SupportedOrderModes> <TimeOffsetHours>91</TimeOffsetHours> <TimeOffsetMinutes>92</TimeOffsetMinutes> <VoicePhone>sample string 85</VoicePhone> <WebDesignId>87</WebDesignId> </Site> </ArrayOfSite>