UCO API (ver. 2.16)

GET api/v1/Store/Stores?SiteId={SiteId}

Query store information for a specific site

Request Information

URI Parameters

Name	Description	Type	Additional information
SiteId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

List of Stores

Collection of Store

Name	Type	Additional information
StoreId	globally unique identifier	None.
StoreNumber	integer	None.
StoreTypeId	globally unique identifier	None.
StoreTypeName	string	None.
SiteId	globally unique identifier	None.
StateId	globally unique identifier	None.
CountryId	integer	None.
StoreName	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
AddressLine3	string	None.
AddressLine4	string	None.
PostalCode	string	None.
OfficeTelephone	string	None.
CityName	string	None.
ManagerName	string	None.
ManagerCellPhone	string	None.
DistributionCentreId	globally unique identifier	None.
IsActive	boolean	None.
EmailAddress	string	None.
McDonaldsStoreNumber	string	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
ExternalId	string	None.
CustomerId	globally unique identifier	None.
CustomerName	string	None.
DCCode	string	None.
StoreGroupId	globally unique identifier	None.
StoreGroupName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "StoreId": "6bf12305-8665-413f-b21f-e7a4f622eb9b",
    "StoreNumber": 1,
    "StoreTypeId": "ef53ba93-23ba-4c4d-a52b-1c27f01044bd",
    "StoreTypeName": "sample string 2",
    "SiteId": "9ee3bfd7-8382-43f7-b39b-0bbecf04d87a",
    "StateId": "531752ed-a98f-469c-8193-e4386e7903a3",
    "CountryId": 1,
    "StoreName": "sample string 3",
    "AddressLine1": "sample string 4",
    "AddressLine2": "sample string 5",
    "AddressLine3": "sample string 6",
    "AddressLine4": "sample string 7",
    "PostalCode": "sample string 8",
    "OfficeTelephone": "sample string 9",
    "CityName": "sample string 10",
    "ManagerName": "sample string 11",
    "ManagerCellPhone": "sample string 12",
    "DistributionCentreId": "1a11c859-db39-44b0-8716-bf9a01c17818",
    "IsActive": true,
    "EmailAddress": "sample string 13",
    "McDonaldsStoreNumber": "sample string 14",
    "Latitude": 1.0,
    "Longitude": 1.0,
    "ExternalId": "sample string 15",
    "CustomerId": "4c574558-4e69-4a1a-89d0-8d2d1822e293",
    "CustomerName": "sample string 16",
    "DCCode": "sample string 17",
    "StoreGroupId": "f5af3212-8d47-4c22-b7f9-2b249301713d",
    "StoreGroupName": "sample string 18"
  },
  {
    "StoreId": "6bf12305-8665-413f-b21f-e7a4f622eb9b",
    "StoreNumber": 1,
    "StoreTypeId": "ef53ba93-23ba-4c4d-a52b-1c27f01044bd",
    "StoreTypeName": "sample string 2",
    "SiteId": "9ee3bfd7-8382-43f7-b39b-0bbecf04d87a",
    "StateId": "531752ed-a98f-469c-8193-e4386e7903a3",
    "CountryId": 1,
    "StoreName": "sample string 3",
    "AddressLine1": "sample string 4",
    "AddressLine2": "sample string 5",
    "AddressLine3": "sample string 6",
    "AddressLine4": "sample string 7",
    "PostalCode": "sample string 8",
    "OfficeTelephone": "sample string 9",
    "CityName": "sample string 10",
    "ManagerName": "sample string 11",
    "ManagerCellPhone": "sample string 12",
    "DistributionCentreId": "1a11c859-db39-44b0-8716-bf9a01c17818",
    "IsActive": true,
    "EmailAddress": "sample string 13",
    "McDonaldsStoreNumber": "sample string 14",
    "Latitude": 1.0,
    "Longitude": 1.0,
    "ExternalId": "sample string 15",
    "CustomerId": "4c574558-4e69-4a1a-89d0-8d2d1822e293",
    "CustomerName": "sample string 16",
    "DCCode": "sample string 17",
    "StoreGroupId": "f5af3212-8d47-4c22-b7f9-2b249301713d",
    "StoreGroupName": "sample string 18"
  }
]

application/xml, text/xml

Sample:

<ArrayOfStore xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Store">
  <Store>
    <AddressLine1>sample string 4</AddressLine1>
    <AddressLine2>sample string 5</AddressLine2>
    <AddressLine3>sample string 6</AddressLine3>
    <AddressLine4>sample string 7</AddressLine4>
    <CityName>sample string 10</CityName>
    <CountryId>1</CountryId>
    <CustomerId>4c574558-4e69-4a1a-89d0-8d2d1822e293</CustomerId>
    <CustomerName>sample string 16</CustomerName>
    <DCCode>sample string 17</DCCode>
    <DistributionCentreId>1a11c859-db39-44b0-8716-bf9a01c17818</DistributionCentreId>
    <EmailAddress>sample string 13</EmailAddress>
    <ExternalId>sample string 15</ExternalId>
    <IsActive>true</IsActive>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <ManagerCellPhone>sample string 12</ManagerCellPhone>
    <ManagerName>sample string 11</ManagerName>
    <McDonaldsStoreNumber>sample string 14</McDonaldsStoreNumber>
    <OfficeTelephone>sample string 9</OfficeTelephone>
    <PostalCode>sample string 8</PostalCode>
    <SiteId>9ee3bfd7-8382-43f7-b39b-0bbecf04d87a</SiteId>
    <StateId>531752ed-a98f-469c-8193-e4386e7903a3</StateId>
    <StoreGroupId>f5af3212-8d47-4c22-b7f9-2b249301713d</StoreGroupId>
    <StoreGroupName>sample string 18</StoreGroupName>
    <StoreId>6bf12305-8665-413f-b21f-e7a4f622eb9b</StoreId>
    <StoreName>sample string 3</StoreName>
    <StoreNumber>1</StoreNumber>
    <StoreTypeId>ef53ba93-23ba-4c4d-a52b-1c27f01044bd</StoreTypeId>
    <StoreTypeName>sample string 2</StoreTypeName>
  </Store>
  <Store>
    <AddressLine1>sample string 4</AddressLine1>
    <AddressLine2>sample string 5</AddressLine2>
    <AddressLine3>sample string 6</AddressLine3>
    <AddressLine4>sample string 7</AddressLine4>
    <CityName>sample string 10</CityName>
    <CountryId>1</CountryId>
    <CustomerId>4c574558-4e69-4a1a-89d0-8d2d1822e293</CustomerId>
    <CustomerName>sample string 16</CustomerName>
    <DCCode>sample string 17</DCCode>
    <DistributionCentreId>1a11c859-db39-44b0-8716-bf9a01c17818</DistributionCentreId>
    <EmailAddress>sample string 13</EmailAddress>
    <ExternalId>sample string 15</ExternalId>
    <IsActive>true</IsActive>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <ManagerCellPhone>sample string 12</ManagerCellPhone>
    <ManagerName>sample string 11</ManagerName>
    <McDonaldsStoreNumber>sample string 14</McDonaldsStoreNumber>
    <OfficeTelephone>sample string 9</OfficeTelephone>
    <PostalCode>sample string 8</PostalCode>
    <SiteId>9ee3bfd7-8382-43f7-b39b-0bbecf04d87a</SiteId>
    <StateId>531752ed-a98f-469c-8193-e4386e7903a3</StateId>
    <StoreGroupId>f5af3212-8d47-4c22-b7f9-2b249301713d</StoreGroupId>
    <StoreGroupName>sample string 18</StoreGroupName>
    <StoreId>6bf12305-8665-413f-b21f-e7a4f622eb9b</StoreId>
    <StoreName>sample string 3</StoreName>
    <StoreNumber>1</StoreNumber>
    <StoreTypeId>ef53ba93-23ba-4c4d-a52b-1c27f01044bd</StoreTypeId>
    <StoreTypeName>sample string 2</StoreTypeName>
  </Store>
</ArrayOfStore>