GetFutureOrderingOptions

This call is to retrieve a FutureOrderingOptions object for the location.

Response Parameters

Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.
ResultCode int — Returns one of the following:
- 0 = Request went through successfully
- 1 = Request returned an unknown error
- 2 = Request was not valid
- 3 = Server is currently unavailable and unable to receive the request
- 4 = Access Denied
FutureOrderingOptions FutureOrderingOptions — Options for future ordering
FutureOrderingOptions Properties
- AllowFutureDateOrdering bool — True if future ordering is allowed at this location, False if not
- Destinations Array of OnlineOrderingDestination — Destinations that future ordering can be directed to
  OnlineOrderingDestination Properties
  - DestinationId int — Maps to the Id of the Destination available for online ordering
  - Instructions string — Instructions for this OnlineOrderingDestination
  - IsDefault bool — True if this is the default destination for online ordering, False if not
- IsEnabled bool — True if future ordering is enabled, False if not
- LeadTimeThresholds Array of LeadTimeThreshold — Lead time thresholds
  LeadTimeThreshold Properties
  - LeadMinutes int — Lead time in minutes for this threshold
- MaximumDaysInAdvance short — Maximum days in advance a future order can be placed
- MinimumLeadMinutes short — Minimum amount of time that the order pickup time needs to be from placement time
- MinimumPrepMinutes short — Minimum amount of time before the order pickup time allocated at which the order is open on the register and sent to the kitchen
- PrepTimeThresholds Array of PrepTimeThreshold — Prep time thresholds
  PrepTimeThreshold Properties
  - PrepMinutes int — Prep time in minutes for this threshold
- RequiredDepositPercent byte — Percent amount of deposit required for a future order

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for GetFutureOrderingOptions request. No parameters required.

Responses

text/xml; charset=utf-8

post/GetFutureOrderingOptions

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?GetFutureOrderingOptions' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/settings/v2/ISettingsWebService2/GetFutureOrderingOptions"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/settings/v2">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:GetFutureOrderingOptions/>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetFutureOrderingOptionsResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <GetFutureOrderingOptionsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <FutureOrderingOptions>
          <AllowFutureDateOrdering>true</AllowFutureDateOrdering>
          <Destinations/>
          <IsEnabled>true</IsEnabled>
          <LeadTimeThresholds/>
          <MaximumDaysInAdvance>7</MaximumDaysInAdvance>
          <MinimumLeadMinutes>60</MinimumLeadMinutes>
          <MinimumPrepMinutes>30</MinimumPrepMinutes>
          <PrepTimeThresholds/>
          <RequiredDepositPercent>0</RequiredDepositPercent>
        </FutureOrderingOptions>
      </GetFutureOrderingOptionsResult>
    </GetFutureOrderingOptionsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing FutureOrderingOptions object.