SaveDestinations

Create new destination or update the existing destination details. Please do not keep batch size of more than 100.

Request Parameters

BusinessDate DateTime? — The BusinessDate from when the change should apply. Default is the current BusinessDate of the location.
IsImmediatePublish bool — Whether or not the change should be applied immediately (will restart all registers at the location).
ChangesetName string — Optionally provide a custom "changeset" name. If the value is not passed, a default "changeset" name is created.
Destinations Array of Destination — Specify one or more Destination objects you would like to create.
Destination Properties
- 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

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 — Success
- 1 — Unknown Error
- 2 — Invalid Request
- 3 — Server Unavailable
- 4 — Access Denied
SaveResults Array of SaveDestinationsResult — Contains details on whether or not the request has succeeded.
SaveDestinationsResult Properties
- Id int — The new generated Id of a specific entity in the SaveDestination request
- OriginalId int — The original Id of a specific entity passed into the SaveDestination request
- ValidationMessages List<string> — Details if the request was unsuccessful

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for SaveDestinations request containing destination details.

Responses

text/xml; charset=utf-8

post/SaveDestinations

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?SaveDestinations' \
  --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/SaveDestinations"' \
  --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:SaveDestinations>
        <v2:request>
          <v2:Destinations>
            <v2:Destination>
              <v2:Id>-1</v2:Id>
              <v2:Name>Drive Thru</v2:Name>
              <v2:IsActive>true</v2:IsActive>
            </v2:Destination>
          </v2:Destinations>
        </v2:request>
      </v2:SaveDestinations>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <SaveDestinationsResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <SaveDestinationsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <SaveResults>
          <SaveDestinationsResult>
            <Id>12345</Id>
            <OriginalId>-1</OriginalId>
            <ValidationMessages/>
          </SaveDestinationsResult>
        </SaveResults>
      </SaveDestinationsResult>
    </SaveDestinationsResponse>
  </s:Body>
</s:Envelope>

SOAP response with Message and ResultCode (0 = success).