GET v1/Site/{siteId}?includeAttributes={includeAttributes}&isIncludeConfidentialValues={isIncludeConfidentialValues}

Retrieves a site with the given internal id

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId	The internal id of the site	integer	Required
includeAttributes	Optional paramter used to request SiteAttributes in response	boolean	Default value is False
isIncludeConfidentialValues		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Information about the requested site. Known internal error is NotFound

SiteResult

Name	Description	Type	Additional information
Site	Get or set the Site		None.

Response Formats

application/json, text/json

Sample:

{
  "Site": {
    "SiteId": 1,
    "ExternalId": "sample string 2",
    "SiteName": "sample string 3",
    "Description": "sample string 4",
    "AddressLine1": "sample string 5",
    "AddressLine2": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "Postal": "sample string 9",
    "VoicePhone": "sample string 10",
    "FAXPhone": "sample string 11",
    "WebDesignId": 1,
    "IsEnabled": true,
    "IsLoyaltyEnabled": true,
    "IsStoredValueCardEnabled": true,
    "TimeOffsetHours": 1,
    "TimeOffsetMinutes": 1,
    "Latitude": 1.1,
    "Longitude": 1.1,
    "LastModifiedTimestamp": "2024-09-29T08:12:37.8116938+08:00",
    "IsMobileEnabled": true,
    "CreditProcessingMode": 0,
    "SiteStatus": 0,
    "SupportedOrderModes": 1,
    "PickupEnabled": true,
    "DeliveryEnabled": true,
    "DineInEnabled": true,
    "Hours": [
      {
        "DayOfWeek": 0,
        "OpeningTime": "00:00:00.1234567",
        "ClosingTime": "00:00:00.1234567",
        "IsClosed": true,
        "IsClosedForDelivery": true,
        "Delivery1Start": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery1End": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery2Start": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery2End": "2024-09-29T08:12:37.8116938+08:00"
      },
      {
        "DayOfWeek": 0,
        "OpeningTime": "00:00:00.1234567",
        "ClosingTime": "00:00:00.1234567",
        "IsClosed": true,
        "IsClosedForDelivery": true,
        "Delivery1Start": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery1End": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery2Start": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery2End": "2024-09-29T08:12:37.8116938+08:00"
      }
    ],
    "SpecialEvents": [
      {
        "SpecialEventId": 1,
        "SpecialEventStartDate": "2024-09-29T08:12:37.8116938+08:00",
        "Name": "sample string 3",
        "OpeningTime": "2024-09-29T08:12:37.8116938+08:00",
        "ClosingTime": "2024-09-29T08:12:37.8116938+08:00",
        "IsClosed": true,
        "IsClosedDelivery": true,
        "SpecialEventEndDate": "2024-09-29T08:12:37.8116938+08:00",
        "IsCompanyWide": true,
        "Delivery1Start": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery1End": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery2Start": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery2End": "2024-09-29T08:12:37.8116938+08:00",
        "SpecialEventPurpose": "sample string 8"
      },
      {
        "SpecialEventId": 1,
        "SpecialEventStartDate": "2024-09-29T08:12:37.8116938+08:00",
        "Name": "sample string 3",
        "OpeningTime": "2024-09-29T08:12:37.8116938+08:00",
        "ClosingTime": "2024-09-29T08:12:37.8116938+08:00",
        "IsClosed": true,
        "IsClosedDelivery": true,
        "SpecialEventEndDate": "2024-09-29T08:12:37.8116938+08:00",
        "IsCompanyWide": true,
        "Delivery1Start": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery1End": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery2Start": "2024-09-29T08:12:37.8116938+08:00",
        "Delivery2End": "2024-09-29T08:12:37.8116938+08:00",
        "SpecialEventPurpose": "sample string 8"
      }
    ],
    "StoreIdentifier": 1,
    "AvailableProducts": [
      0,
      0
    ],
    "OrderSubmissionEmailList": [
      "sample string 1",
      "sample string 2"
    ],
    "OrderingState": 0,
    "Locator": 0,
    "DeliveryRange": 20.1,
    "PrepLeadTimePickup": 1,
    "PrepLeadTimeDelivery": 1,
    "LastImportTimestamp": "2024-09-29T08:12:37.8116938+08:00",
    "CateringBCCEmailList": "sample string 21",
    "RetailBCCEmailList": "sample string 22",
    "TimeZoneId": "sample string 23",
    "DeliveryOrderMode": 0,
    "EnterpriseUnitId": "sample string 24",
    "ConfigurationSetId": 25,
    "RequireTableNumber": true,
    "OpenCheckEnabled": true,
    "StartTabEnabled": true,
    "OpenCheckAutoCloseEnabled": true,
    "CurbSideEnabled": true,
    "FreedomPayStoreId": "sample string 31",
    "FreedomPayTerminalId": "sample string 32",
    "CreditSiteId": "sample string 33"
  },
  "SiteSettings": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "SiteMenus": [
    {
      "MenuId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "MenuType": 0,
      "ExternalId": "sample string 4",
      "SupportedOrderModes": 1,
      "IsVisible": true,
      "MenuAttribute": 0,
      "DisplayName": "sample string 6",
      "SubMenus": [
        1,
        2
      ]
    },
    {
      "MenuId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "MenuType": 0,
      "ExternalId": "sample string 4",
      "SupportedOrderModes": 1,
      "IsVisible": true,
      "MenuAttribute": 0,
      "DisplayName": "sample string 6",
      "SubMenus": [
        1,
        2
      ]
    }
  ],
  "SiteAttributes": [
    {
      "AttributeId": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "IsVisibleOnSiteLocator": true,
      "Ranking": 5,
      "ImageId": 6
    },
    {
      "AttributeId": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "IsVisibleOnSiteLocator": true,
      "Ranking": 5,
      "ImageId": 6
    }
  ]
}

application/xml, text/xml

Sample:

<SiteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Admin.Models">
  <Site>
    <AddressLine1>sample string 5</AddressLine1>
    <AddressLine2>sample string 6</AddressLine2>
    <AvailableProducts>
      <ProductType>Invalid</ProductType>
      <ProductType>Invalid</ProductType>
    </AvailableProducts>
    <CateringBCCEmailList>sample string 21</CateringBCCEmailList>
    <City>sample string 7</City>
    <ConfigurationSetId>25</ConfigurationSetId>
    <CreditProcessingMode>NotSupported</CreditProcessingMode>
    <CreditSiteId>sample string 33</CreditSiteId>
    <CurbSideEnabled>true</CurbSideEnabled>
    <DeliveryEnabled>true</DeliveryEnabled>
    <DeliveryOrderMode>Fleet</DeliveryOrderMode>
    <DeliveryRange>20.1</DeliveryRange>
    <Description>sample string 4</Description>
    <DineInEnabled>true</DineInEnabled>
    <EnterpriseUnitId>sample string 24</EnterpriseUnitId>
    <ExternalId>sample string 2</ExternalId>
    <FAXPhone>sample string 11</FAXPhone>
    <FreedomPayStoreId>sample string 31</FreedomPayStoreId>
    <FreedomPayTerminalId>sample string 32</FreedomPayTerminalId>
    <Hours>
      <SiteHours>
        <ClosingTime>PT0.1234567S</ClosingTime>
        <DayOfWeek>Sunday</DayOfWeek>
        <Delivery1End>2024-09-29T08:12:37.8116938+08:00</Delivery1End>
        <Delivery1Start>2024-09-29T08:12:37.8116938+08:00</Delivery1Start>
        <Delivery2End>2024-09-29T08:12:37.8116938+08:00</Delivery2End>
        <Delivery2Start>2024-09-29T08:12:37.8116938+08:00</Delivery2Start>
        <IsClosed>true</IsClosed>
        <IsClosedForDelivery>true</IsClosedForDelivery>
        <OpeningTime>PT0.1234567S</OpeningTime>
      </SiteHours>
      <SiteHours>
        <ClosingTime>PT0.1234567S</ClosingTime>
        <DayOfWeek>Sunday</DayOfWeek>
        <Delivery1End>2024-09-29T08:12:37.8116938+08:00</Delivery1End>
        <Delivery1Start>2024-09-29T08:12:37.8116938+08:00</Delivery1Start>
        <Delivery2End>2024-09-29T08:12:37.8116938+08:00</Delivery2End>
        <Delivery2Start>2024-09-29T08:12:37.8116938+08:00</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>
    <LastImportTimestamp>2024-09-29T08:12:37.8116938+08:00</LastImportTimestamp>
    <LastModifiedTimestamp>2024-09-29T08:12:37.8116938+08:00</LastModifiedTimestamp>
    <Latitude>1.1</Latitude>
    <Locator>NotBrowsable</Locator>
    <Longitude>1.1</Longitude>
    <OpenCheckAutoCloseEnabled>true</OpenCheckAutoCloseEnabled>
    <OpenCheckEnabled>true</OpenCheckEnabled>
    <OrderSubmissionEmailList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </OrderSubmissionEmailList>
    <OrderingState>NotAcceptingOrders</OrderingState>
    <PickupEnabled>true</PickupEnabled>
    <Postal>sample string 9</Postal>
    <PrepLeadTimeDelivery>1</PrepLeadTimeDelivery>
    <PrepLeadTimePickup>1</PrepLeadTimePickup>
    <RequireTableNumber>true</RequireTableNumber>
    <RetailBCCEmailList>sample string 22</RetailBCCEmailList>
    <SiteId>1</SiteId>
    <SiteName>sample string 3</SiteName>
    <SiteStatus>SiteIsUp</SiteStatus>
    <SpecialEvents>
      <SiteSpecialEvent>
        <ClosingTime>2024-09-29T08:12:37.8116938+08:00</ClosingTime>
        <Delivery1End>2024-09-29T08:12:37.8116938+08:00</Delivery1End>
        <Delivery1Start>2024-09-29T08:12:37.8116938+08:00</Delivery1Start>
        <Delivery2End>2024-09-29T08:12:37.8116938+08:00</Delivery2End>
        <Delivery2Start>2024-09-29T08:12:37.8116938+08:00</Delivery2Start>
        <IsClosed>true</IsClosed>
        <IsClosedDelivery>true</IsClosedDelivery>
        <IsCompanyWide>true</IsCompanyWide>
        <Name>sample string 3</Name>
        <OpeningTime>2024-09-29T08:12:37.8116938+08:00</OpeningTime>
        <SpecialEventEndDate>2024-09-29T08:12:37.8116938+08:00</SpecialEventEndDate>
        <SpecialEventId>1</SpecialEventId>
        <SpecialEventPurpose>sample string 8</SpecialEventPurpose>
        <SpecialEventStartDate>2024-09-29T08:12:37.8116938+08:00</SpecialEventStartDate>
      </SiteSpecialEvent>
      <SiteSpecialEvent>
        <ClosingTime>2024-09-29T08:12:37.8116938+08:00</ClosingTime>
        <Delivery1End>2024-09-29T08:12:37.8116938+08:00</Delivery1End>
        <Delivery1Start>2024-09-29T08:12:37.8116938+08:00</Delivery1Start>
        <Delivery2End>2024-09-29T08:12:37.8116938+08:00</Delivery2End>
        <Delivery2Start>2024-09-29T08:12:37.8116938+08:00</Delivery2Start>
        <IsClosed>true</IsClosed>
        <IsClosedDelivery>true</IsClosedDelivery>
        <IsCompanyWide>true</IsCompanyWide>
        <Name>sample string 3</Name>
        <OpeningTime>2024-09-29T08:12:37.8116938+08:00</OpeningTime>
        <SpecialEventEndDate>2024-09-29T08:12:37.8116938+08:00</SpecialEventEndDate>
        <SpecialEventId>1</SpecialEventId>
        <SpecialEventPurpose>sample string 8</SpecialEventPurpose>
        <SpecialEventStartDate>2024-09-29T08:12:37.8116938+08:00</SpecialEventStartDate>
      </SiteSpecialEvent>
    </SpecialEvents>
    <StartTabEnabled>true</StartTabEnabled>
    <State>sample string 8</State>
    <StoreIdentifier>1</StoreIdentifier>
    <SupportedOrderModes>Pickup</SupportedOrderModes>
    <TimeOffsetHours>1</TimeOffsetHours>
    <TimeOffsetMinutes>1</TimeOffsetMinutes>
    <TimeZoneId>sample string 23</TimeZoneId>
    <VoicePhone>sample string 10</VoicePhone>
    <WebDesignId>1</WebDesignId>
  </Site>
  <SiteAttributes>
    <SiteAttribute>
      <AttributeId>sample string 1</AttributeId>
      <Description>sample string 3</Description>
      <ImageId>6</ImageId>
      <IsVisibleOnSiteLocator>true</IsVisibleOnSiteLocator>
      <Name>sample string 2</Name>
      <Ranking>5</Ranking>
    </SiteAttribute>
    <SiteAttribute>
      <AttributeId>sample string 1</AttributeId>
      <Description>sample string 3</Description>
      <ImageId>6</ImageId>
      <IsVisibleOnSiteLocator>true</IsVisibleOnSiteLocator>
      <Name>sample string 2</Name>
      <Ranking>5</Ranking>
    </SiteAttribute>
  </SiteAttributes>
  <SiteMenus>
    <Menu>
      <Description>sample string 3</Description>
      <DisplayName>sample string 6</DisplayName>
      <ExternalId>sample string 4</ExternalId>
      <IsVisible>true</IsVisible>
      <MenuAttribute>None</MenuAttribute>
      <MenuId>1</MenuId>
      <MenuType>Retail</MenuType>
      <Name>sample string 2</Name>
      <SubMenus xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </SubMenus>
      <SupportedOrderModes>Pickup</SupportedOrderModes>
    </Menu>
    <Menu>
      <Description>sample string 3</Description>
      <DisplayName>sample string 6</DisplayName>
      <ExternalId>sample string 4</ExternalId>
      <IsVisible>true</IsVisible>
      <MenuAttribute>None</MenuAttribute>
      <MenuId>1</MenuId>
      <MenuType>Retail</MenuType>
      <Name>sample string 2</Name>
      <SubMenus xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </SubMenus>
      <SupportedOrderModes>Pickup</SupportedOrderModes>
    </Menu>
  </SiteMenus>
  <SiteSettings>
    <Setting>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Setting>
    <Setting>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Setting>
  </SiteSettings>
</SiteResult>