GET v1/Sites
Retrieves a site with the given external id
URI template
v1/Sites?externalId={externalId}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
externalId |
The external id of the site |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Information about the requested site. Known internal error is NotFound.
SiteResultName | Description | Type | Additional information |
---|---|---|---|
Site |
Get or set the Site |
Site |
None. |
SiteSettings |
Get or set SiteSettings |
Collection of Setting |
None. |
SiteMenus |
Get or set the SiteMenus property |
Collection of Menu |
None. |
SiteAttributes |
Get or set SiteAttributes |
Collection of SiteAttribute |
None. |
Dayparts |
Dayparts list |
Collection of Daypart |
None. |
ManualDayparts |
ManualDayparts list |
Collection of ManualDaypart |
None. |
Response Formats
application/json, text/json
Sample:
{ "Site": { "$id": "2", "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-25T09:34:28.3601592", "CateringBCCEmailList": "sample string 22", "RetailBCCEmailList": "sample string 23", "IsMobileEnabled": true, "CreditProcessingMode": 0, "SiteStatus": 0, "SupportedOrderModes": 1, "SupportedDeliveryModes": 0, "DeliveryRange": 25.1, "Hours": [ { "$id": "3", "DayOfWeek": 0, "OpeningTime": "00:00:00.1234567", "ClosingTime": "00:00:00.1234567", "IsClosed": true, "IsClosedForDelivery": true, "Delivery1Start": "2025-04-25T09:34:28.3601592", "Delivery1End": "2025-04-25T09:34:28.3601592", "Delivery2Start": "2025-04-25T09:34:28.3601592", "Delivery2End": "2025-04-25T09:34:28.3601592" }, { "$id": "4", "DayOfWeek": 0, "OpeningTime": "00:00:00.1234567", "ClosingTime": "00:00:00.1234567", "IsClosed": true, "IsClosedForDelivery": true, "Delivery1Start": "2025-04-25T09:34:28.3601592", "Delivery1End": "2025-04-25T09:34:28.3601592", "Delivery2Start": "2025-04-25T09:34:28.3601592", "Delivery2End": "2025-04-25T09:34:28.3601592" } ], "SpecialEvents": [ { "$id": "5", "SpecialEventId": 42, "SpecialEventStartDate": "2025-04-25T09:34:28.3601592", "Name": "sample string 44", "OpeningTime": "2025-04-25T09:34:28.3601592", "ClosingTime": "2025-04-25T09:34:28.3601592", "IsClosed": true, "IsClosedDelivery": true, "SpecialEventEndDate": "2025-04-25T09:34:28.3601592", "IsCompanyWide": true, "Delivery1Start": "2025-04-25T09:34:28.3601592", "Delivery1End": "2025-04-25T09:34:28.3601592", "Delivery2Start": "2025-04-25T09:34:28.3601592", "Delivery2End": "2025-04-25T09:34:28.3601592", "SpecialEventPurpose": "sample string 55" }, { "$id": "6", "SpecialEventId": 56, "SpecialEventStartDate": "2025-04-25T09:34:28.3601592", "Name": "sample string 58", "OpeningTime": "2025-04-25T09:34:28.3601592", "ClosingTime": "2025-04-25T09:34:28.3601592", "IsClosed": true, "IsClosedDelivery": true, "SpecialEventEndDate": "2025-04-25T09:34:28.3601592", "IsCompanyWide": true, "Delivery1Start": "2025-04-25T09:34:28.3601592", "Delivery1End": "2025-04-25T09:34:28.3601592", "Delivery2Start": "2025-04-25T09:34:28.3601592", "Delivery2End": "2025-04-25T09:34:28.3601592", "SpecialEventPurpose": "sample string 69" } ], "StoreIdentifier": 70, "AvailableProducts": [ 0, 0 ], "OrderingState": 0, "Locator": 0, "RequireTableNumber": true, "OpenCheckEnabled": true, "StartTabEnabled": true, "OpenCheckAutoCloseEnabled": true }, "SiteSettings": [ { "$id": "7", "Name": "sample string 75", "Value": "sample string 76" }, { "$id": "8", "Name": "sample string 77", "Value": "sample string 78" } ], "SiteMenus": [ { "$id": "9", "MenuId": 79, "Name": "sample string 80", "Description": "sample string 81", "MenuType": 0, "ExternalId": "sample string 82", "SupportedOrderModes": 1, "IsVisible": true, "MenuAttribute": 0, "DisplayName": "sample string 84", "SubMenus": [ 85, 86 ] }, { "$id": "10", "MenuId": 87, "Name": "sample string 88", "Description": "sample string 89", "MenuType": 0, "ExternalId": "sample string 90", "SupportedOrderModes": 1, "IsVisible": true, "MenuAttribute": 0, "DisplayName": "sample string 92", "SubMenus": [ 93, 94 ] } ], "SiteAttributes": [ { "$id": "11", "AttributeId": "sample string 95", "Name": "sample string 96", "Description": "sample string 97", "IsVisibleOnSiteLocator": true, "Ranking": 99, "ImageId": 100 }, { "$id": "12", "AttributeId": "sample string 101", "Name": "sample string 102", "Description": "sample string 103", "IsVisibleOnSiteLocator": true, "Ranking": 105, "ImageId": 106 } ], "Dayparts": [ { "$id": "13", "DaypartPosId": 107, "DesignId": 108, "Name": "sample string 110", "StartTime": "00:00:00.1234567", "EndTime": "00:00:00.1234567" }, { "$id": "14", "DaypartPosId": 113, "DesignId": 114, "Name": "sample string 116", "StartTime": "00:00:00.1234567", "EndTime": "00:00:00.1234567" } ], "ManualDayparts": [ { "$id": "15", "DesignId": 120, "DaypartId": 64, "Name": "sample string 122", "MonStart": "00:00:00.1234567", "MonEnd": "00:00:00.1234567", "TueStart": "00:00:00.1234567", "TueEnd": "00:00:00.1234567", "WedStart": "00:00:00.1234567", "WedEnd": "00:00:00.1234567", "ThuStart": "00:00:00.1234567", "ThuEnd": "00:00:00.1234567", "FriStart": "00:00:00.1234567", "FriEnd": "00:00:00.1234567", "SatStart": "00:00:00.1234567", "SatEnd": "00:00:00.1234567", "SunStart": "00:00:00.1234567", "SunEnd": "00:00:00.1234567" }, { "$id": "16", "DesignId": 138, "DaypartId": 64, "Name": "sample string 140", "MonStart": "00:00:00.1234567", "MonEnd": "00:00:00.1234567", "TueStart": "00:00:00.1234567", "TueEnd": "00:00:00.1234567", "WedStart": "00:00:00.1234567", "WedEnd": "00:00:00.1234567", "ThuStart": "00:00:00.1234567", "ThuEnd": "00:00:00.1234567", "FriStart": "00:00:00.1234567", "FriEnd": "00:00:00.1234567", "SatStart": "00:00:00.1234567", "SatEnd": "00:00:00.1234567", "SunStart": "00:00:00.1234567", "SunEnd": "00:00:00.1234567" } ] }
application/xml, text/xml
Sample:
<SiteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response"> <Dayparts xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <d2p1:Daypart> <d2p1:DaypartPosId>107</d2p1:DaypartPosId> <d2p1:DesignId>108</d2p1:DesignId> <d2p1:EndTime>PT0.1234567S</d2p1:EndTime> <d2p1:Name>sample string 110</d2p1:Name> <d2p1:SiteId>109</d2p1:SiteId> <d2p1:StartTime>PT0.1234567S</d2p1:StartTime> </d2p1:Daypart> <d2p1:Daypart> <d2p1:DaypartPosId>113</d2p1:DaypartPosId> <d2p1:DesignId>114</d2p1:DesignId> <d2p1:EndTime>PT0.1234567S</d2p1:EndTime> <d2p1:Name>sample string 116</d2p1:Name> <d2p1:SiteId>115</d2p1:SiteId> <d2p1:StartTime>PT0.1234567S</d2p1:StartTime> </d2p1:Daypart> </Dayparts> <ManualDayparts xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <d2p1:ManualDaypart> <d2p1:DaypartId>64</d2p1:DaypartId> <d2p1:DesignId>120</d2p1:DesignId> <d2p1:FriEnd>PT0.1234567S</d2p1:FriEnd> <d2p1:FriStart>PT0.1234567S</d2p1:FriStart> <d2p1:MonEnd>PT0.1234567S</d2p1:MonEnd> <d2p1:MonStart>PT0.1234567S</d2p1:MonStart> <d2p1:Name>sample string 122</d2p1:Name> <d2p1:SatEnd>PT0.1234567S</d2p1:SatEnd> <d2p1:SatStart>PT0.1234567S</d2p1:SatStart> <d2p1:SiteId>119</d2p1:SiteId> <d2p1:SunEnd>PT0.1234567S</d2p1:SunEnd> <d2p1:SunStart>PT0.1234567S</d2p1:SunStart> <d2p1:ThuEnd>PT0.1234567S</d2p1:ThuEnd> <d2p1:ThuStart>PT0.1234567S</d2p1:ThuStart> <d2p1:TueEnd>PT0.1234567S</d2p1:TueEnd> <d2p1:TueStart>PT0.1234567S</d2p1:TueStart> <d2p1:WedEnd>PT0.1234567S</d2p1:WedEnd> <d2p1:WedStart>PT0.1234567S</d2p1:WedStart> </d2p1:ManualDaypart> <d2p1:ManualDaypart> <d2p1:DaypartId>64</d2p1:DaypartId> <d2p1:DesignId>138</d2p1:DesignId> <d2p1:FriEnd>PT0.1234567S</d2p1:FriEnd> <d2p1:FriStart>PT0.1234567S</d2p1:FriStart> <d2p1:MonEnd>PT0.1234567S</d2p1:MonEnd> <d2p1:MonStart>PT0.1234567S</d2p1:MonStart> <d2p1:Name>sample string 140</d2p1:Name> <d2p1:SatEnd>PT0.1234567S</d2p1:SatEnd> <d2p1:SatStart>PT0.1234567S</d2p1:SatStart> <d2p1:SiteId>137</d2p1:SiteId> <d2p1:SunEnd>PT0.1234567S</d2p1:SunEnd> <d2p1:SunStart>PT0.1234567S</d2p1:SunStart> <d2p1:ThuEnd>PT0.1234567S</d2p1:ThuEnd> <d2p1:ThuStart>PT0.1234567S</d2p1:ThuStart> <d2p1:TueEnd>PT0.1234567S</d2p1:TueEnd> <d2p1:TueStart>PT0.1234567S</d2p1:TueStart> <d2p1:WedEnd>PT0.1234567S</d2p1:WedEnd> <d2p1:WedStart>PT0.1234567S</d2p1:WedStart> </d2p1:ManualDaypart> </ManualDayparts> <Site xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <d2p1:AddressLine1>sample string 6</d2p1:AddressLine1> <d2p1:AddressLine2>sample string 7</d2p1:AddressLine2> <d2p1:AvailableProducts> <d2p1:ProductType>Invalid</d2p1:ProductType> <d2p1:ProductType>Invalid</d2p1:ProductType> </d2p1:AvailableProducts> <d2p1:CateringBCCEmailList>sample string 22</d2p1:CateringBCCEmailList> <d2p1:City>sample string 8</d2p1:City> <d2p1:CreditProcessingMode>NotSupported</d2p1:CreditProcessingMode> <d2p1:DeliveryRange>25.1</d2p1:DeliveryRange> <d2p1:Description>sample string 5</d2p1:Description> <d2p1:EnterpriseUnitId>sample string 3</d2p1:EnterpriseUnitId> <d2p1:ExternalId>sample string 2</d2p1:ExternalId> <d2p1:FAXPhone>sample string 12</d2p1:FAXPhone> <d2p1:Hours> <d2p1:SiteHours> <d2p1:ClosingTime>PT0.1234567S</d2p1:ClosingTime> <d2p1:DayOfWeek>Sunday</d2p1:DayOfWeek> <d2p1:Delivery1End>2025-04-25T09:34:28.3601592</d2p1:Delivery1End> <d2p1:Delivery1Start>2025-04-25T09:34:28.3601592</d2p1:Delivery1Start> <d2p1:Delivery2End>2025-04-25T09:34:28.3601592</d2p1:Delivery2End> <d2p1:Delivery2Start>2025-04-25T09:34:28.3601592</d2p1:Delivery2Start> <d2p1:IsClosed>true</d2p1:IsClosed> <d2p1:IsClosedForDelivery>true</d2p1:IsClosedForDelivery> <d2p1:OpeningTime>PT0.1234567S</d2p1:OpeningTime> </d2p1:SiteHours> <d2p1:SiteHours> <d2p1:ClosingTime>PT0.1234567S</d2p1:ClosingTime> <d2p1:DayOfWeek>Sunday</d2p1:DayOfWeek> <d2p1:Delivery1End>2025-04-25T09:34:28.3601592</d2p1:Delivery1End> <d2p1:Delivery1Start>2025-04-25T09:34:28.3601592</d2p1:Delivery1Start> <d2p1:Delivery2End>2025-04-25T09:34:28.3601592</d2p1:Delivery2End> <d2p1:Delivery2Start>2025-04-25T09:34:28.3601592</d2p1:Delivery2Start> <d2p1:IsClosed>true</d2p1:IsClosed> <d2p1:IsClosedForDelivery>true</d2p1:IsClosedForDelivery> <d2p1:OpeningTime>PT0.1234567S</d2p1:OpeningTime> </d2p1:SiteHours> </d2p1:Hours> <d2p1:IsEnabled>true</d2p1:IsEnabled> <d2p1:IsLoyaltyEnabled>true</d2p1:IsLoyaltyEnabled> <d2p1:IsMobileEnabled>true</d2p1:IsMobileEnabled> <d2p1:IsStoredValueCardEnabled>true</d2p1:IsStoredValueCardEnabled> <d2p1:LastModifiedTimestamp>2025-04-25T09:34:28.3601592</d2p1:LastModifiedTimestamp> <d2p1:Latitude>19.1</d2p1:Latitude> <d2p1:Locator>NotBrowsable</d2p1:Locator> <d2p1:Longitude>20.1</d2p1:Longitude> <d2p1:OpenCheckAutoCloseEnabled>true</d2p1:OpenCheckAutoCloseEnabled> <d2p1:OpenCheckEnabled>true</d2p1:OpenCheckEnabled> <d2p1:OrderingState>NotAcceptingOrders</d2p1:OrderingState> <d2p1:Postal>sample string 10</d2p1:Postal> <d2p1:RequireTableNumber>true</d2p1:RequireTableNumber> <d2p1:RetailBCCEmailList>sample string 23</d2p1:RetailBCCEmailList> <d2p1:SiteId>1</d2p1:SiteId> <d2p1:SiteName>sample string 4</d2p1:SiteName> <d2p1:SiteStatus>SiteIsUp</d2p1:SiteStatus> <d2p1:SpecialEvents> <d2p1:SiteSpecialEvent> <d2p1:ClosingTime>2025-04-25T09:34:28.3601592</d2p1:ClosingTime> <d2p1:Delivery1End>2025-04-25T09:34:28.3601592</d2p1:Delivery1End> <d2p1:Delivery1Start>2025-04-25T09:34:28.3601592</d2p1:Delivery1Start> <d2p1:Delivery2End>2025-04-25T09:34:28.3601592</d2p1:Delivery2End> <d2p1:Delivery2Start>2025-04-25T09:34:28.3601592</d2p1:Delivery2Start> <d2p1:IsClosed>true</d2p1:IsClosed> <d2p1:IsClosedDelivery>true</d2p1:IsClosedDelivery> <d2p1:IsCompanyWide>true</d2p1:IsCompanyWide> <d2p1:Name>sample string 44</d2p1:Name> <d2p1:OpeningTime>2025-04-25T09:34:28.3601592</d2p1:OpeningTime> <d2p1:SpecialEventEndDate>2025-04-25T09:34:28.3601592</d2p1:SpecialEventEndDate> <d2p1:SpecialEventId>42</d2p1:SpecialEventId> <d2p1:SpecialEventPurpose>sample string 55</d2p1:SpecialEventPurpose> <d2p1:SpecialEventStartDate>2025-04-25T09:34:28.3601592</d2p1:SpecialEventStartDate> </d2p1:SiteSpecialEvent> <d2p1:SiteSpecialEvent> <d2p1:ClosingTime>2025-04-25T09:34:28.3601592</d2p1:ClosingTime> <d2p1:Delivery1End>2025-04-25T09:34:28.3601592</d2p1:Delivery1End> <d2p1:Delivery1Start>2025-04-25T09:34:28.3601592</d2p1:Delivery1Start> <d2p1:Delivery2End>2025-04-25T09:34:28.3601592</d2p1:Delivery2End> <d2p1:Delivery2Start>2025-04-25T09:34:28.3601592</d2p1:Delivery2Start> <d2p1:IsClosed>true</d2p1:IsClosed> <d2p1:IsClosedDelivery>true</d2p1:IsClosedDelivery> <d2p1:IsCompanyWide>true</d2p1:IsCompanyWide> <d2p1:Name>sample string 58</d2p1:Name> <d2p1:OpeningTime>2025-04-25T09:34:28.3601592</d2p1:OpeningTime> <d2p1:SpecialEventEndDate>2025-04-25T09:34:28.3601592</d2p1:SpecialEventEndDate> <d2p1:SpecialEventId>56</d2p1:SpecialEventId> <d2p1:SpecialEventPurpose>sample string 69</d2p1:SpecialEventPurpose> <d2p1:SpecialEventStartDate>2025-04-25T09:34:28.3601592</d2p1:SpecialEventStartDate> </d2p1:SiteSpecialEvent> </d2p1:SpecialEvents> <d2p1:StartTabEnabled>true</d2p1:StartTabEnabled> <d2p1:State>sample string 9</d2p1:State> <d2p1:StoreIdentifier>70</d2p1:StoreIdentifier> <d2p1:SupportedDeliveryModes>None</d2p1:SupportedDeliveryModes> <d2p1:SupportedOrderModes>Pickup</d2p1:SupportedOrderModes> <d2p1:TimeOffsetHours>17</d2p1:TimeOffsetHours> <d2p1:TimeOffsetMinutes>18</d2p1:TimeOffsetMinutes> <d2p1:VoicePhone>sample string 11</d2p1:VoicePhone> <d2p1:WebDesignId>13</d2p1:WebDesignId> </Site> <SiteAttributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <d2p1:SiteAttribute> <d2p1:AttributeId>sample string 95</d2p1:AttributeId> <d2p1:Description>sample string 97</d2p1:Description> <d2p1:ImageId>100</d2p1:ImageId> <d2p1:IsVisibleOnSiteLocator>true</d2p1:IsVisibleOnSiteLocator> <d2p1:Name>sample string 96</d2p1:Name> <d2p1:Ranking>99</d2p1:Ranking> </d2p1:SiteAttribute> <d2p1:SiteAttribute> <d2p1:AttributeId>sample string 101</d2p1:AttributeId> <d2p1:Description>sample string 103</d2p1:Description> <d2p1:ImageId>106</d2p1:ImageId> <d2p1:IsVisibleOnSiteLocator>true</d2p1:IsVisibleOnSiteLocator> <d2p1:Name>sample string 102</d2p1:Name> <d2p1:Ranking>105</d2p1:Ranking> </d2p1:SiteAttribute> </SiteAttributes> <SiteMenus xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <d2p1:Menu> <d2p1:Description>sample string 81</d2p1:Description> <d2p1:DisplayName>sample string 84</d2p1:DisplayName> <d2p1:ExternalId>sample string 82</d2p1:ExternalId> <d2p1:IsVisible>true</d2p1:IsVisible> <d2p1:MenuAttribute>None</d2p1:MenuAttribute> <d2p1:MenuId>79</d2p1:MenuId> <d2p1:MenuType>Retail</d2p1:MenuType> <d2p1:Name>sample string 80</d2p1:Name> <d2p1:SubMenus xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:long>85</d4p1:long> <d4p1:long>86</d4p1:long> </d2p1:SubMenus> <d2p1:SupportedOrderModes>Pickup</d2p1:SupportedOrderModes> </d2p1:Menu> <d2p1:Menu> <d2p1:Description>sample string 89</d2p1:Description> <d2p1:DisplayName>sample string 92</d2p1:DisplayName> <d2p1:ExternalId>sample string 90</d2p1:ExternalId> <d2p1:IsVisible>true</d2p1:IsVisible> <d2p1:MenuAttribute>None</d2p1:MenuAttribute> <d2p1:MenuId>87</d2p1:MenuId> <d2p1:MenuType>Retail</d2p1:MenuType> <d2p1:Name>sample string 88</d2p1:Name> <d2p1:SubMenus xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:long>93</d4p1:long> <d4p1:long>94</d4p1:long> </d2p1:SubMenus> <d2p1:SupportedOrderModes>Pickup</d2p1:SupportedOrderModes> </d2p1:Menu> </SiteMenus> <SiteSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <d2p1:Setting> <d2p1:Name>sample string 75</d2p1:Name> <d2p1:Value>sample string 76</d2p1:Value> </d2p1:Setting> <d2p1:Setting> <d2p1:Name>sample string 77</d2p1:Name> <d2p1:Value>sample string 78</d2p1:Value> </d2p1:Setting> </SiteSettings> </SiteResult>