POST v1/Site/AddSite

Creates a site.

Request Information

URI Parameters

None.

Body Parameters

Inboud object that contains information of a site information to be created

Name	Description	Type	Additional information
Name	The name of the site	string	Required Max length: 100
Postal	The postal code of the site	string	Required Max length: 20
WebDesignId	WebDesignId of the site	integer	Required Range: inclusive between 1 and 9.22337203685478E+18
TimeZoneId	The time zone of the site	string	None.
EnterpriseUnitId	The enterprise unit of the site	string	None.
AddressLine1	The first address line of the site	string	Max length: 300
AddressLine2	The second address line of the site	string	Max length: 300
City	The city of the site	string	Max length: 30
State	The state of the site	string	Max length: 30
Latitude	The latitude of the site	decimal number	Range: inclusive between -90 and 90
Longitude	The longitude of the site	decimal number	Range: inclusive between -180 and 180
Description	A short description of the site to give customer more context	string	Max length: 100
VoicePhone	The phone number of the site	string	Max length: 30
FAXPhone	The fax number of the site	string	Max length: 30
OrderSubmitEmailList	One or more email recipients when an order is submitted to this site. Separate with ';'.	string	Max length: 1024
DeliveryRange	Range in miles surrounding the site's location where delivery is supported	decimal number	Range: inclusive between 0 and 1.79769313486232E+308
StoreIdentifier	The StoreIdentifier (CMC Id, SITE HASP) to set for this site (if present)	integer	Range: inclusive between 0 and 9.22337203685478E+18
PrepLeadTimePickup	Determine the lead time for pickup orders for this site in minutes	integer	Range: inclusive between 0 and 2147483647
PrepLeadTimeDelivery	Determine the lead time for delivery orders for this site in minutes	integer	Range: inclusive between 0 and 2147483647
BrowsableState	The browsable state of the site	SiteBrowsableState	None.
OrderingState	The ordering state of the site	ApiSiteOrderingState	None.
IsEnabled	True if the site is enabled and accessible to the public	boolean	None.
IsEmergencyClosed	Determine if the site is closed beyond regular hours	boolean	None.
IsMobileEnabled	True if the site allows mobile orders	boolean	None.
SupportsPickup	True if the site allows pickup orders	boolean	None.
SupportsCurbSidePickup	Defines if the site supports CurbSide pickup	boolean	None.
SupportsDelivery	True if the site allows delivery orders	boolean	None.
SupportsDineIn	Is dine-in order mode enabled for this site	boolean	None.
ConfigurationSetId	ConfigurationSet Id of the store	integer	None.
OpenCheckEnabled	Does site support OpenCheck	boolean	None.
StartTabEnabled	Does site support StartTab	boolean	None.
OpenCheckAutoCloseEnabled	Does site support OpenCheckAutoClose	boolean	None.
RequireTableNumber	Does site Require table number	boolean	None.
ExternalId	ExternalId of the site	string	None.
SiteSettings	The site settings for this site	Collection of Setting	None.
SiteHours	List of site hours	Collection of ApiSiteHours	None.
FreedomPayStoreId	The StoreId for FreedomPay	string	Max length: 50
FreedomPayTerminalId	The TerminalId for FreedomPay	string	Max length: 50
CreditProcessingMode	The Credit Processing Mode for the site	CreditProcessingMode	None.
CreditSiteId	The CreditSiteId for Connected Payments	string	Max length: 20

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Postal": "sample string 2",
  "WebDesignId": 1,
  "TimeZoneId": "sample string 3",
  "EnterpriseUnitId": "sample string 4",
  "AddressLine1": "sample string 5",
  "AddressLine2": "sample string 6",
  "City": "sample string 7",
  "State": "sample string 8",
  "Latitude": 1.1,
  "Longitude": 1.1,
  "Description": "sample string 9",
  "VoicePhone": "sample string 10",
  "FAXPhone": "sample string 11",
  "OrderSubmitEmailList": "sample string 12",
  "DeliveryRange": 1.1,
  "StoreIdentifier": 1,
  "PrepLeadTimePickup": 1,
  "PrepLeadTimeDelivery": 1,
  "BrowsableState": 0,
  "OrderingState": 0,
  "IsEnabled": true,
  "IsEmergencyClosed": true,
  "IsMobileEnabled": true,
  "SupportsPickup": true,
  "SupportsCurbSidePickup": true,
  "SupportsDelivery": true,
  "SupportsDineIn": true,
  "ConfigurationSetId": 1,
  "OpenCheckEnabled": true,
  "StartTabEnabled": true,
  "OpenCheckAutoCloseEnabled": true,
  "RequireTableNumber": true,
  "ExternalId": "sample string 13",
  "SiteSettings": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "SiteHours": [
    {
      "DayOfWeek": 0,
      "OpeningTime": "00:00:00.1234567",
      "ClosingTime": "00:00:00.1234567",
      "IsClosed": true,
      "IsClosedForDelivery": true,
      "Delivery1Start": "2024-11-21T00:36:40.1656689-06:00",
      "Delivery1End": "2024-11-21T00:36:40.1656689-06:00",
      "Delivery2Start": "2024-11-21T00:36:40.1656689-06:00",
      "Delivery2End": "2024-11-21T00:36:40.1656689-06:00"
    },
    {
      "DayOfWeek": 0,
      "OpeningTime": "00:00:00.1234567",
      "ClosingTime": "00:00:00.1234567",
      "IsClosed": true,
      "IsClosedForDelivery": true,
      "Delivery1Start": "2024-11-21T00:36:40.1656689-06:00",
      "Delivery1End": "2024-11-21T00:36:40.1656689-06:00",
      "Delivery2Start": "2024-11-21T00:36:40.1656689-06:00",
      "Delivery2End": "2024-11-21T00:36:40.1656689-06:00"
    }
  ],
  "FreedomPayStoreId": "sample string 14",
  "FreedomPayTerminalId": "sample string 15",
  "CreditProcessingMode": 0,
  "CreditSiteId": "sample string 16"
}

application/xml, text/xml

Sample:

<InSiteAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Admin.Inbound">
  <AddressLine1>sample string 5</AddressLine1>
  <AddressLine2>sample string 6</AddressLine2>
  <BrowsableState>NotBrowsable</BrowsableState>
  <City>sample string 7</City>
  <ConfigurationSetId>1</ConfigurationSetId>
  <CreditProcessingMode>NotSupported</CreditProcessingMode>
  <CreditSiteId>sample string 16</CreditSiteId>
  <DeliveryRange>1.1</DeliveryRange>
  <Description>sample string 9</Description>
  <ExternalId>sample string 13</ExternalId>
  <FAXPhone>sample string 11</FAXPhone>
  <FreedomPayStoreId>sample string 14</FreedomPayStoreId>
  <FreedomPayTerminalId>sample string 15</FreedomPayTerminalId>
  <IsEmergencyClosed>true</IsEmergencyClosed>
  <IsEnabled>true</IsEnabled>
  <IsMobileEnabled>true</IsMobileEnabled>
  <Latitude>1.1</Latitude>
  <Longitude>1.1</Longitude>
  <OpenCheckAutoCloseEnabled>true</OpenCheckAutoCloseEnabled>
  <OpenCheckEnabled>true</OpenCheckEnabled>
  <OrderSubmitEmailList>sample string 12</OrderSubmitEmailList>
  <OrderingState>NotAcceptingOrders</OrderingState>
  <PrepLeadTimeDelivery>1</PrepLeadTimeDelivery>
  <PrepLeadTimePickup>1</PrepLeadTimePickup>
  <RequireTableNumber>true</RequireTableNumber>
  <SiteHours xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Admin.Models">
    <d2p1:SiteHours>
      <d2p1:ClosingTime>PT0.1234567S</d2p1:ClosingTime>
      <d2p1:DayOfWeek>Sunday</d2p1:DayOfWeek>
      <d2p1:Delivery1End>2024-11-21T00:36:40.1656689-06:00</d2p1:Delivery1End>
      <d2p1:Delivery1Start>2024-11-21T00:36:40.1656689-06:00</d2p1:Delivery1Start>
      <d2p1:Delivery2End>2024-11-21T00:36:40.1656689-06:00</d2p1:Delivery2End>
      <d2p1:Delivery2Start>2024-11-21T00:36:40.1656689-06:00</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>2024-11-21T00:36:40.1656689-06:00</d2p1:Delivery1End>
      <d2p1:Delivery1Start>2024-11-21T00:36:40.1656689-06:00</d2p1:Delivery1Start>
      <d2p1:Delivery2End>2024-11-21T00:36:40.1656689-06:00</d2p1:Delivery2End>
      <d2p1:Delivery2Start>2024-11-21T00:36:40.1656689-06:00</d2p1:Delivery2Start>
      <d2p1:IsClosed>true</d2p1:IsClosed>
      <d2p1:IsClosedForDelivery>true</d2p1:IsClosedForDelivery>
      <d2p1:OpeningTime>PT0.1234567S</d2p1:OpeningTime>
    </d2p1:SiteHours>
  </SiteHours>
  <SiteSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Admin.Models">
    <d2p1:Setting>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:Setting>
    <d2p1:Setting>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:Setting>
  </SiteSettings>
  <StartTabEnabled>true</StartTabEnabled>
  <State>sample string 8</State>
  <StoreIdentifier>1</StoreIdentifier>
  <SupportsCurbSidePickup>true</SupportsCurbSidePickup>
  <SupportsDelivery>true</SupportsDelivery>
  <SupportsDineIn>true</SupportsDineIn>
  <SupportsPickup>true</SupportsPickup>
  <VoicePhone>sample string 10</VoicePhone>
  <EnterpriseUnitId>sample string 4</EnterpriseUnitId>
  <Name>sample string 1</Name>
  <Postal>sample string 2</Postal>
  <TimeZoneId>sample string 3</TimeZoneId>
  <WebDesignId>1</WebDesignId>
</InSiteAdd>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A revised version of the site

ResponseOfExternalSite

Name	Type	Additional information
Verbose	string	None.
Message	string	None.
ErrorCode	integer	None.
Result		None.

Response Formats

application/json, text/json

Sample:

{
  "Verbose": "sample string 1",
  "Message": "sample string 2",
  "ErrorCode": 3,
  "Result": {
    "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,
    "Latitude": 1.1,
    "Longitude": 1.1,
    "IsMobileEnabled": true,
    "CreditProcessingMode": 0,
    "SiteStatus": 0,
    "SupportedOrderModes": 7,
    "Hours": [
      {
        "DayOfWeek": 0,
        "OpeningTime": "00:00:00.1234567",
        "ClosingTime": "00:00:00.1234567",
        "IsClosed": true,
        "IsClosedForDelivery": true,
        "Delivery1Start": "2024-11-21T00:36:40.1858702-06:00",
        "Delivery1End": "2024-11-21T00:36:40.1858702-06:00",
        "Delivery2Start": "2024-11-21T00:36:40.1858702-06:00",
        "Delivery2End": "2024-11-21T00:36:40.1858702-06:00"
      },
      {
        "DayOfWeek": 0,
        "OpeningTime": "00:00:00.1234567",
        "ClosingTime": "00:00:00.1234567",
        "IsClosed": true,
        "IsClosedForDelivery": true,
        "Delivery1Start": "2024-11-21T00:36:40.1858702-06:00",
        "Delivery1End": "2024-11-21T00:36:40.1858702-06:00",
        "Delivery2Start": "2024-11-21T00:36:40.1858702-06:00",
        "Delivery2End": "2024-11-21T00:36:40.1858702-06:00"
      }
    ],
    "StoreIdentifier": 1,
    "NextOrderNumber": 16,
    "BrowsableState": 0,
    "OrderingState": 0,
    "OrderSubmitMode": 0,
    "PrepTimeMinutes": 17,
    "PrepTimeDeliveryMinutes": 18,
    "OrderSubmitEmailList": "sample string 19",
    "MobileOrderSubmitEmailList": "sample string 20",
    "OrderBCCEmailList": "sample string 21",
    "RetailBCCEmailList": "sample string 22",
    "CateringBCCEmailList": "sample string 23",
    "IsFaxFailoverEnabled": true,
    "IsMobileFaxFailoverEnabled": true,
    "DeliveryRange": 26.1,
    "BillingType": 1,
    "PrepLeadTimePickup": 1,
    "PrepLeadTimeDelivery": 1,
    "SupportsPickup": true,
    "SupportsDelivery": true,
    "SupportsCurbSidePickup": true,
    "IsEmergencyClosed": true,
    "CurrentSiteStatus": 0,
    "LastModifiedTimestamp": "2024-11-21T00:36:40.1858702-06:00",
    "DeliveryOrderMode": 0,
    "TimeZoneId": "sample string 32",
    "ConfigurationSetId": 33,
    "RequireTableNumber": true,
    "OpenCheckEnabled": true,
    "StartTabEnabled": true,
    "OpenCheckAutoCloseEnabled": true,
    "FreedomPayStoreId": "sample string 38",
    "FreedomPayTerminalId": "sample string 39",
    "CreditSiteId": "sample string 40"
  }
}

application/xml, text/xml

Sample:

<ResponseOfExternalSitemHMPg1WY xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Admin.Models">
  <ErrorCode>3</ErrorCode>
  <Message>sample string 2</Message>
  <Result>
    <AddressLine1>sample string 5</AddressLine1>
    <AddressLine2>sample string 6</AddressLine2>
    <BillingType>NotBillable</BillingType>
    <BrowsableState>NotBrowsable</BrowsableState>
    <CateringBCCEmailList>sample string 23</CateringBCCEmailList>
    <City>sample string 7</City>
    <ConfigurationSetId>33</ConfigurationSetId>
    <CreditProcessingMode>NotSupported</CreditProcessingMode>
    <CreditSiteId>sample string 40</CreditSiteId>
    <CurrentSiteStatus>SiteIsUp</CurrentSiteStatus>
    <DeliveryOrderMode>Fleet</DeliveryOrderMode>
    <DeliveryRange>26.1</DeliveryRange>
    <Description>sample string 4</Description>
    <ExternalId>sample string 2</ExternalId>
    <FAXPhone>sample string 11</FAXPhone>
    <FreedomPayStoreId>sample string 38</FreedomPayStoreId>
    <FreedomPayTerminalId>sample string 39</FreedomPayTerminalId>
    <Hours>
      <SiteHours>
        <ClosingTime>PT0.1234567S</ClosingTime>
        <DayOfWeek>Sunday</DayOfWeek>
        <Delivery1End>2024-11-21T00:36:40.1858702-06:00</Delivery1End>
        <Delivery1Start>2024-11-21T00:36:40.1858702-06:00</Delivery1Start>
        <Delivery2End>2024-11-21T00:36:40.1858702-06:00</Delivery2End>
        <Delivery2Start>2024-11-21T00:36:40.1858702-06:00</Delivery2Start>
        <IsClosed>true</IsClosed>
        <IsClosedForDelivery>true</IsClosedForDelivery>
        <OpeningTime>PT0.1234567S</OpeningTime>
      </SiteHours>
      <SiteHours>
        <ClosingTime>PT0.1234567S</ClosingTime>
        <DayOfWeek>Sunday</DayOfWeek>
        <Delivery1End>2024-11-21T00:36:40.1858702-06:00</Delivery1End>
        <Delivery1Start>2024-11-21T00:36:40.1858702-06:00</Delivery1Start>
        <Delivery2End>2024-11-21T00:36:40.1858702-06:00</Delivery2End>
        <Delivery2Start>2024-11-21T00:36:40.1858702-06:00</Delivery2Start>
        <IsClosed>true</IsClosed>
        <IsClosedForDelivery>true</IsClosedForDelivery>
        <OpeningTime>PT0.1234567S</OpeningTime>
      </SiteHours>
    </Hours>
    <IsEmergencyClosed>true</IsEmergencyClosed>
    <IsEnabled>true</IsEnabled>
    <IsFaxFailoverEnabled>true</IsFaxFailoverEnabled>
    <IsLoyaltyEnabled>true</IsLoyaltyEnabled>
    <IsMobileEnabled>true</IsMobileEnabled>
    <IsMobileFaxFailoverEnabled>true</IsMobileFaxFailoverEnabled>
    <IsStoredValueCardEnabled>true</IsStoredValueCardEnabled>
    <LastModifiedTimestamp>2024-11-21T00:36:40.1858702-06:00</LastModifiedTimestamp>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <MobileOrderSubmitEmailList>sample string 20</MobileOrderSubmitEmailList>
    <NextOrderNumber>16</NextOrderNumber>
    <OpenCheckAutoCloseEnabled>true</OpenCheckAutoCloseEnabled>
    <OpenCheckEnabled>true</OpenCheckEnabled>
    <OrderBCCEmailList>sample string 21</OrderBCCEmailList>
    <OrderSubmitEmailList>sample string 19</OrderSubmitEmailList>
    <OrderSubmitMode>NotSupported</OrderSubmitMode>
    <OrderingState>NotAcceptingOrders</OrderingState>
    <Postal>sample string 9</Postal>
    <PrepLeadTimeDelivery>1</PrepLeadTimeDelivery>
    <PrepLeadTimePickup>1</PrepLeadTimePickup>
    <PrepTimeDeliveryMinutes>18</PrepTimeDeliveryMinutes>
    <PrepTimeMinutes>17</PrepTimeMinutes>
    <RequireTableNumber>true</RequireTableNumber>
    <RetailBCCEmailList>sample string 22</RetailBCCEmailList>
    <SiteId>1</SiteId>
    <SiteName>sample string 3</SiteName>
    <SiteStatus>SiteIsUp</SiteStatus>
    <StartTabEnabled>true</StartTabEnabled>
    <State>sample string 8</State>
    <StoreIdentifier>1</StoreIdentifier>
    <SupportedOrderModes>Pickup Delivery CurbSide</SupportedOrderModes>
    <SupportsCurbSidePickup>true</SupportsCurbSidePickup>
    <SupportsDelivery>true</SupportsDelivery>
    <SupportsPickup>true</SupportsPickup>
    <TimeOffsetHours>1</TimeOffsetHours>
    <TimeZoneId>sample string 32</TimeZoneId>
    <VoicePhone>sample string 10</VoicePhone>
    <WebDesignId>1</WebDesignId>
  </Result>
  <Verbose>sample string 1</Verbose>
</ResponseOfExternalSitemHMPg1WY>