GetDestinations

This call is to retrieve an array of Destination objects for the location.

Response Parameters

AllItems bool — Not used anymore. Default value is false.
AutoCloseFutureOrders bool — True if order is sent to the kitchen and there is no balance due, False if not
AutoPrintType AutoPrintType — Automatically print order receipt.
- Never : Do not auto print.
- Immediate : Print when future order is received.
- On Send to Kitchen : Print when order is sent to kitchen.
AutoPrintCreditVouchers bool — True if credit drafts are to be printed, False if not
AutoPrintPrinterId int? — ID of the printer
DeliveryMinutes byte? — Average delivery time in minutes, used to calculate approximate delivery driver arrival time.
Description string — When entered, replaces the destination name in Customer Portal.
Id int — Unique Id of this Destination
Indicator string — Prints in front of the item name on the kitchen chit
IsActive bool — Whether destination is active or not
IsDelivery bool — True if Delivery Specific, False if not
KitchenChitHeader string — The header that is printed at the top of each kitchen chit.
KitchenDescription string — When entered, replaces the destination name displayed on kitchen chit and kitchen video display.
KitchenVideoColor Color — Color of the destination name displayed on kitchen video display.
LimitByDeliveryZone bool — True if delivery address is to be limited to specific delivery zones, False if not
LimitByPostalCode bool — True if delivery address is to be limited to specific postal codes, False if not
Name string — Name of the destination.
OrderMinimum decimal? — Minimum order sub-total required
PartyLabelOverride string — When entered, changes the Table caption to the entered text in the Pivot Seat control, on the Order list, and on the kitchen chit.
SeatLabelOverride string — When entered, changes the Seat caption to the entered text in the Pivot Seat control, on the Order list, and on the kitchen chit.
SuppressBarcode bool — Prevents a loyalty redemption barcode from printing on the customer receipt to prevent earning double loyalty rewards on 3rd party orders.
TipAndSignatureDialogEnabled bool — Not used anymore. Default value is false.
ValidDeliveryZones Array of DestinationDeliveryZone — List of valid Delivery Zones where delivery can be done
DestinationDeliveryZone Properties
- Coordinates Array of DestinationDeliveryZoneCoordinate — Coordinates of the delivery zone.
  DestinationDeliveryZoneCoordinate Properties
  - Latitude double — Gets or sets the latitude.
  - Longitude double — Gets or sets the longitude.
- Id int — Unique identifier of the object.
- Name string — Name of the object.
- SurchargeId int? — Gets or sets the surcharge identifier.
ValidPostalCodes Array of string — List of valid Postal codes where delivery can be done

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for GetDestinations request. No parameters required.

Responses

text/xml; charset=utf-8

post/GetDestinations

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?GetDestinations' \
  --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/GetDestinations"' \
  --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:GetDestinations/>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings2_GetDestinationsResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <Settings2_GetDestinationsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Destinations>
          <Destination>
            <AllItems>true</AllItems>
            <AutoCloseFutureOrders>false</AutoCloseFutureOrders>
            <AutoPrintType>0</AutoPrintType>
            <AutoPrintCreditVouchers>false</AutoPrintCreditVouchers>
            <AutoPrintPrinterId i:nil="true"/>
            <DeliveryMinutes i:nil="true"/>
            <Description>Dine In</Description>
            <Id>1</Id>
            <Indicator>DI</Indicator>
            <IsActive>true</IsActive>
            <IsDelivery>false</IsDelivery>
            <KitchenChitHeader/>
            <KitchenDescription>DI</KitchenDescription>
            <KitchenVideoColor>0</KitchenVideoColor>
            <LimitByDeliveryZone>false</LimitByDeliveryZone>
            <LimitByPostalCode>false</LimitByPostalCode>
            <Name>Dine In</Name>
            <OrderMinimum i:nil="true"/>
            <PartyLabelOverride/>
            <SeatLabelOverride/>
            <SuppressBarcode>false</SuppressBarcode>
            <TipAndSignatureDialogEnabled>true</TipAndSignatureDialogEnabled>
            <ValidDeliveryZones/>
            <ValidPostalCodes/>
          </Destination>
        </Destinations>
      </Settings2_GetDestinationsResult>
    </Settings2_GetDestinationsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Destination objects.