GetPriceChanges

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

Response Parameters

Days byte? — Returns a byte describing the days for this PriceChange:
- 0 = None
- 1 = Sunday
- 2 = Monday
- 4 = Tuesday
- 8 = Wednesday
- 16 = Thursday
- 32 = Friday
- 64 = Saturday
If multiple days are selected, binary addition is used in determining this value.
EndDate DateTime? — End date of this PriceChange
EndTime TimeSpan? — End time of this PriceChange
EnforceDateRanges bool — True if StartDate and EndDate are enforced, False if not
EnforceDays bool — True if Days are enforced, False if not
EnforceTimeRanges bool — True if StartTime and EndTime are enforced, False if not
Id int — Unique Id of this PriceChange
IsActive bool — True if this PriceChange is active, False if not
ItemPriceChanges Array of ItemPriceChange — Item price changes in this PriceChange
ItemPriceChange Properties
- ComponentPriceChanges Array of ComponentPriceChange — Component price changes for this ItemPriceChange (used for combo items)
  ComponentPriceChange Properties
  - ComponentId int — Maps to the Id of the ItemCompositeComponent for this ComponentPriceChange
  - ComponentItemPriceChanges Array of ComponentItemPriceChange — Component item price changes for this ComponentPriceChange
    
    ComponentItemPriceChange Properties
    
    Id int — Unique Id of this ComponentItemPriceChange
    
    ItemId int — Maps to the Id of the Item for this ComponentItemPriceChange
    
    Price decimal? — New price for this Item within the component
  - Id int — Unique Id of this ComponentPriceChange
  - Price decimal? — New price for this component
- Id int — Unique Id of this ItemPriceChange
- ItemId int — Maps to the Id of the Item for this ItemPriceChange
- Name string — Name of this ItemPriceChange
- OriginalPrice decimal? — Original price of the Item before this PriceChange
- Price decimal? — New price for this Item under this PriceChange
ModifierGroupPriceChanges[5.16r2+] Array of ModifierGroupPriceChange — Modifier group price changes in this PriceChange
ModifierGroupPriceChange Properties
- Id int — Unique Id of this ModifierGroupPriceChange
- ModifierGroupId int — Maps to the Id of the ModifierGroup of this ModifierGroupPriceChange
- ModifierGroupItemPriceChanges Array of ModifierGroupItemPriceChange — Modifier group item price changes of this ModifierGroupPriceChange
  ModifierGroupItemPriceChange Properties
  - Id int — Unique Id of this ModifierGroupItemPriceChange
  - ModifierGroupItemId int — Maps to the Id of the ModifierGroupItem for this ModifierGroupItemPriceChange
  - Price decimal? — Price of this ModifierGroupItemPriceChange
Name string — Name of this PriceChange
PriceChangeDestinations Array of PriceChangeDestination — Destinations in this PriceChange
PriceChangeDestination Properties
- DestinationId int — Maps to the Id of the Destination this PriceChange applies to
- DestinationName string — Name of the Destination this PriceChange applies to
- Id int — Unique Id of this PriceChangeDestination
StartDate DateTime? — Start date of this PriceChange
StartTime TimeSpan? — Start time of this PriceChange

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for GetPriceChanges request. No parameters required.

Responses

text/xml; charset=utf-8

post/GetPriceChanges

cURL

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

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetPriceChangesResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <GetPriceChangesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <PriceChanges>
          <PriceChange>
            <Days>62</Days>
            <EndDate>2025-12-31T00:00:00</EndDate>
            <EndTime>PT17H0M0S</EndTime>
            <EnforceDateRanges>true</EnforceDateRanges>
            <EnforceDays>true</EnforceDays>
            <EnforceTimeRanges>true</EnforceTimeRanges>
            <Id>10</Id>
            <IsActive>true</IsActive>
            <ItemPriceChanges>
              <ItemPriceChange>
                <ComponentPriceChanges>
                  <ComponentPriceChange>
                    <ComponentId>1</ComponentId>
                    <ComponentItemPriceChanges>
                      <ComponentItemPriceChange>
                        <ItemId>102</ItemId>
                        <Price>2.99</Price>
                      </ComponentItemPriceChange>
                    </ComponentItemPriceChanges>
                    <Price>3.99</Price>
                  </ComponentPriceChange>
                </ComponentPriceChanges>
                <ItemId>101</ItemId>
                <Name>Classic Burger</Name>
                <OriginalPrice>9.99</OriginalPrice>
                <Price>8.99</Price>
              </ItemPriceChange>
            </ItemPriceChanges>
            <Name>Happy Hour Pricing</Name>
            <PriceChangeDestinations>
              <PriceChangeDestination>
                <DestinationId>1</DestinationId>
                <DestinationName>Dine In</DestinationName>
              </PriceChangeDestination>
            </PriceChangeDestinations>
            <StartDate>2024-01-01T00:00:00</StartDate>
            <StartTime>PT15H0M0S</StartTime>
          </PriceChange>
        </PriceChanges>
      </GetPriceChangesResult>
    </GetPriceChangesResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of PriceChange objects.