GET api/Stores?restoId={restoId}

Request Information

URI Parameters

Name	Description	Type	Additional information
restoId		string	Required

Body Parameters

None.

Response Information

Resource Description

Store

Name	Type	Additional information
LocationHash	string	None.
StreetAddress	string	None.
FriendlyStoreName	string	None.
RegionHash	string	None.
RegionName	string	None.
Address	Address	None.
Geolocation	Geolocation	None.
PosRestoId	string	None.
CellId	string	None.
DistanceFromUser	decimal number	None.
StoreOpenTimes	string	None.
IsOpenNow	boolean	None.
IsPeetsStore	boolean	None.
IsDineInEnabled	boolean	None.
DineInDistance	decimal number	None.
HasValidatedParking	boolean	None.
RegionGroupId	integer	None.
RegionGroupName	string	None.
IsCurbsideEnabled	boolean	None.
StoreHolidayTimes	Collection of StoreHolidayTime	None.
OpeningDate	date	None.
RegionId	integer	None.
LocationId	integer	None.
MarketingRegionId	integer	None.
IsComingSoon	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "LocationHash": "sample string 1",
  "StreetAddress": "sample string 2",
  "FriendlyStoreName": "sample string 3",
  "RegionHash": "sample string 4",
  "RegionName": "sample string 5",
  "Address": {
    "AddressId": 1,
    "CrossStreetInstructions": "sample string 2",
    "IsVirtualCafe": true,
    "AddressHash": "sample string 4",
    "BuildingHash": "sample string 5",
    "TypeName": "sample string 6",
    "TypeValue": 1,
    "CellId": "sample string 7",
    "IsEcafe": true,
    "ParkingFlag": 9,
    "ContactFirstName": "sample string 10",
    "FriendlyAddress": "sample string 11",
    "FriendlyAddressHtml": "sample string 12",
    "FriendlyContactDisplay": "sample string 13",
    "ContactLastName": "sample string 14",
    "ContactPhone": "sample string 15",
    "ContactPhoneExt": "sample string 16",
    "ContactEmail": "sample string 17",
    "ContactCompany": "sample string 18",
    "StreetAddress": "sample string 19",
    "City": "sample string 20",
    "State": "sample string 21",
    "Zip": "sample string 22",
    "ZipExtendedFour": "sample string 23",
    "Suite": "sample string 24",
    "Floor": "sample string 25",
    "Telephone": "sample string 26",
    "TelephoneExt": "sample string 27",
    "LinkedCC": true,
    "LinkedTermAccount": true,
    "Favorite": true,
    "BuildingActive": true,
    "AddressActive": true,
    "PriorityPickupStatus": 33,
    "ValidationResponse": true,
    "ValidationResponseMessage": "sample string 35",
    "IsLunchStop": true,
    "LunchStopId": 37,
    "LunchStopName": "sample string 38",
    "LunchStopStatus": 39,
    "IsLocked": true,
    "IsPickupLocation": true,
    "IsCustomerDefaultLocation": true
  },
  "Geolocation": {
    "Latitude": 1.1,
    "Longitude": 2.1
  },
  "PosRestoId": "sample string 6",
  "CellId": "sample string 7",
  "DistanceFromUser": 8.1,
  "StoreOpenTimes": "sample string 9",
  "IsOpenNow": true,
  "IsPeetsStore": true,
  "IsDineInEnabled": true,
  "DineInDistance": 13.1,
  "HasValidatedParking": true,
  "RegionGroupId": 15,
  "RegionGroupName": "sample string 16",
  "IsCurbsideEnabled": true,
  "StoreHolidayTimes": [
    {
      "RerouteDelivery": true,
      "RerouteCellId": "sample string 2",
      "HolidayId": 3,
      "CellId": "sample string 4",
      "HolidayStart": "2024-11-20T00:27:51.9822745-08:00",
      "HolidayEnd": "2024-11-20T00:27:51.9822745-08:00",
      "Description": "sample string 7",
      "HolidayTimeSpan": "00:00:00.1234567",
      "FriendlyTimeSpan": "sample string 9",
      "DisplayShortHoursOpen": "sample string 10"
    },
    {
      "RerouteDelivery": true,
      "RerouteCellId": "sample string 2",
      "HolidayId": 3,
      "CellId": "sample string 4",
      "HolidayStart": "2024-11-20T00:27:51.9822745-08:00",
      "HolidayEnd": "2024-11-20T00:27:51.9822745-08:00",
      "Description": "sample string 7",
      "HolidayTimeSpan": "00:00:00.1234567",
      "FriendlyTimeSpan": "sample string 9",
      "DisplayShortHoursOpen": "sample string 10"
    }
  ],
  "OpeningDate": "2024-11-20T00:27:51.9822745-08:00",
  "RegionId": 19,
  "LocationId": 20,
  "MarketingRegionId": 1,
  "IsComingSoon": true
}

text/html

Sample:

{"LocationHash":"sample string 1","StreetAddress":"sample string 2","FriendlyStoreName":"sample string 3","RegionHash":"sample string 4","RegionName":"sample string 5","Address":{"AddressId":1,"CrossStreetInstructions":"sample string 2","IsVirtualCafe":true,"AddressHash":"sample string 4","BuildingHash":"sample string 5","TypeName":"sample string 6","TypeValue":1,"CellId":"sample string 7","IsEcafe":true,"ParkingFlag":9,"ContactFirstName":"sample string 10","FriendlyAddress":"sample string 11","FriendlyAddressHtml":"sample string 12","FriendlyContactDisplay":"sample string 13","ContactLastName":"sample string 14","ContactPhone":"sample string 15","ContactPhoneExt":"sample string 16","ContactEmail":"sample string 17","ContactCompany":"sample string 18","StreetAddress":"sample string 19","City":"sample string 20","State":"sample string 21","Zip":"sample string 22","ZipExtendedFour":"sample string 23","Suite":"sample string 24","Floor":"sample string 25","Telephone":"sample string 26","TelephoneExt":"sample string 27","LinkedCC":true,"LinkedTermAccount":true,"Favorite":true,"BuildingActive":true,"AddressActive":true,"PriorityPickupStatus":33,"ValidationResponse":true,"ValidationResponseMessage":"sample string 35","IsLunchStop":true,"LunchStopId":37,"LunchStopName":"sample string 38","LunchStopStatus":39,"IsLocked":true,"IsPickupLocation":true,"IsCustomerDefaultLocation":true},"Geolocation":{"Latitude":1.1,"Longitude":2.1},"PosRestoId":"sample string 6","CellId":"sample string 7","DistanceFromUser":8.1,"StoreOpenTimes":"sample string 9","IsOpenNow":true,"IsPeetsStore":true,"IsDineInEnabled":true,"DineInDistance":13.1,"HasValidatedParking":true,"RegionGroupId":15,"RegionGroupName":"sample string 16","IsCurbsideEnabled":true,"StoreHolidayTimes":[{"RerouteDelivery":true,"RerouteCellId":"sample string 2","HolidayId":3,"CellId":"sample string 4","HolidayStart":"2024-11-20T00:27:51.9822745-08:00","HolidayEnd":"2024-11-20T00:27:51.9822745-08:00","Description":"sample string 7","HolidayTimeSpan":"00:00:00.1234567","FriendlyTimeSpan":"sample string 9","DisplayShortHoursOpen":"sample string 10"},{"RerouteDelivery":true,"RerouteCellId":"sample string 2","HolidayId":3,"CellId":"sample string 4","HolidayStart":"2024-11-20T00:27:51.9822745-08:00","HolidayEnd":"2024-11-20T00:27:51.9822745-08:00","Description":"sample string 7","HolidayTimeSpan":"00:00:00.1234567","FriendlyTimeSpan":"sample string 9","DisplayShortHoursOpen":"sample string 10"}],"OpeningDate":"2024-11-20T00:27:51.9822745-08:00","RegionId":19,"LocationId":20,"MarketingRegionId":1,"IsComingSoon":true}

application/xml, text/xml

Sample:

<Store xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Specialtys.DTO">
  <Address>
    <AddressActive>true</AddressActive>
    <AddressHash>sample string 4</AddressHash>
    <AddressId>1</AddressId>
    <BuildingActive>true</BuildingActive>
    <BuildingHash>sample string 5</BuildingHash>
    <CellId>sample string 7</CellId>
    <City>sample string 20</City>
    <ContactCompany>sample string 18</ContactCompany>
    <ContactEmail>sample string 17</ContactEmail>
    <ContactFirstName>sample string 10</ContactFirstName>
    <ContactLastName>sample string 14</ContactLastName>
    <ContactPhone>sample string 15</ContactPhone>
    <ContactPhoneExt>sample string 16</ContactPhoneExt>
    <CrossStreetInstructions>sample string 2</CrossStreetInstructions>
    <Favorite>true</Favorite>
    <Floor>sample string 25</Floor>
    <FriendlyAddress>sample string 11</FriendlyAddress>
    <FriendlyAddressHtml>sample string 12</FriendlyAddressHtml>
    <FriendlyContactDisplay>sample string 13</FriendlyContactDisplay>
    <IsCustomerDefaultLocation>true</IsCustomerDefaultLocation>
    <IsEcafe>true</IsEcafe>
    <IsLocked>true</IsLocked>
    <IsLunchStop>true</IsLunchStop>
    <IsPickupLocation>true</IsPickupLocation>
    <IsVirtualCafe>true</IsVirtualCafe>
    <LinkedCC>true</LinkedCC>
    <LinkedTermAccount>true</LinkedTermAccount>
    <LunchStopId>37</LunchStopId>
    <LunchStopName>sample string 38</LunchStopName>
    <LunchStopStatus>39</LunchStopStatus>
    <ParkingFlag>9</ParkingFlag>
    <PriorityPickupStatus>33</PriorityPickupStatus>
    <State>sample string 21</State>
    <StreetAddress>sample string 19</StreetAddress>
    <Suite>sample string 24</Suite>
    <Telephone>sample string 26</Telephone>
    <TelephoneExt>sample string 27</TelephoneExt>
    <TypeName>sample string 6</TypeName>
    <TypeValue>1</TypeValue>
    <ValidationResponse>true</ValidationResponse>
    <ValidationResponseMessage>sample string 35</ValidationResponseMessage>
    <Zip>sample string 22</Zip>
    <ZipExtendedFour>sample string 23</ZipExtendedFour>
  </Address>
  <CellId>sample string 7</CellId>
  <DineInDistance>13.1</DineInDistance>
  <DistanceFromUser>8.1</DistanceFromUser>
  <FriendlyStoreName>sample string 3</FriendlyStoreName>
  <Geolocation>
    <Latitude>1.1</Latitude>
    <Longitude>2.1</Longitude>
  </Geolocation>
  <HasValidatedParking>true</HasValidatedParking>
  <IsComingSoon>true</IsComingSoon>
  <IsCurbsideEnabled>true</IsCurbsideEnabled>
  <IsDineInEnabled>true</IsDineInEnabled>
  <IsOpenNow>true</IsOpenNow>
  <IsPeetsStore>true</IsPeetsStore>
  <LocationHash>sample string 1</LocationHash>
  <LocationId>20</LocationId>
  <MarketingRegionId>1</MarketingRegionId>
  <OpeningDate>2024-11-20T00:27:51.9822745-08:00</OpeningDate>
  <PosRestoId>sample string 6</PosRestoId>
  <RegionGroupId>15</RegionGroupId>
  <RegionGroupName>sample string 16</RegionGroupName>
  <RegionHash>sample string 4</RegionHash>
  <RegionId>19</RegionId>
  <RegionName>sample string 5</RegionName>
  <StoreHolidayTimes>
    <StoreHolidayTime>
      <CellId>sample string 4</CellId>
      <Description>sample string 7</Description>
      <DisplayShortHoursOpen>sample string 10</DisplayShortHoursOpen>
      <FriendlyTimeSpan>sample string 9</FriendlyTimeSpan>
      <HolidayEnd>2024-11-20T00:27:51.9822745-08:00</HolidayEnd>
      <HolidayId>3</HolidayId>
      <HolidayStart>2024-11-20T00:27:51.9822745-08:00</HolidayStart>
      <HolidayTimeSpan>PT0.1234567S</HolidayTimeSpan>
      <RerouteCellId>sample string 2</RerouteCellId>
      <RerouteDelivery>true</RerouteDelivery>
    </StoreHolidayTime>
    <StoreHolidayTime>
      <CellId>sample string 4</CellId>
      <Description>sample string 7</Description>
      <DisplayShortHoursOpen>sample string 10</DisplayShortHoursOpen>
      <FriendlyTimeSpan>sample string 9</FriendlyTimeSpan>
      <HolidayEnd>2024-11-20T00:27:51.9822745-08:00</HolidayEnd>
      <HolidayId>3</HolidayId>
      <HolidayStart>2024-11-20T00:27:51.9822745-08:00</HolidayStart>
      <HolidayTimeSpan>PT0.1234567S</HolidayTimeSpan>
      <RerouteCellId>sample string 2</RerouteCellId>
      <RerouteDelivery>true</RerouteDelivery>
    </StoreHolidayTime>
  </StoreHolidayTimes>
  <StoreOpenTimes>sample string 9</StoreOpenTimes>
  <StreetAddress>sample string 2</StreetAddress>
</Store>