DeletePriceChanges

This call is to remove a price change at a location based on existing PriceChangeIds. Please do not keep batch requests, i.e. single operation should be performed in a single request.

Request Parameters

BusinessDate DateTime? — The BusinessDate from when the change should apply. Default is the current BusinessDate of the location
ChangesetName string — Optionally provide a custom "changeset" name. If the value is not passed, a default "changeset" name is created.
IsImmediatePublish bool — Whether or not the change should be applied immediately (will restart all registers at the location)
PriceChangeIds Array of int — A Collection of Price Change Ids to delete

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
Errors Array of string — Contains error messages if the request failed

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for DeletePriceChanges request containing price change IDs to delete.

Responses

text/xml; charset=utf-8

post/DeletePriceChanges

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?DeletePriceChanges' \
  --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/DeletePriceChanges"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/settings/v2"
    xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:DeletePriceChanges>
        <v2:request>
          <v2:PriceChangeIds>
            <arr:int>100001</arr:int>
          </v2:PriceChangeIds>
        </v2:request>
      </v2:DeletePriceChanges>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <DeletePriceChangesResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <DeletePriceChangesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Errors/>
      </DeletePriceChangesResult>
    </DeletePriceChangesResponse>
  </s:Body>
</s:Envelope>

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