GetDiscounts

Retrieve the Discounts configured at this location.

Request Parameters

accessToken string — Your access token (passed in SOAP body, not headers).
locationToken string — Your location token (passed in SOAP body, not headers).

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
- 3 — Server Unavailable
- 4 — Access Denied
Discounts Array of Discount — Array of Discount objects for this location.
Discount Properties
- Active bool — True if this Discount is active, False if inactive
- AllowLaterDiscounts bool — True if this Discount can be applied to orders that have already been sent, False if not
- AllowPriorDiscounts bool — True if this Discount can be applied before items are populated on the order, False if not
- Amount decimal — New amount for the item this Discount is applied to
- DiscountedItemsEligible bool — True if already discounted items will be eligible for this Discount, False if not
- EligibleItemGroupIds IdList — Maps to the Id(s) of the Item Group(s) eligible for this Discount
- EligibleItemId int — Maps to the Id of the Item eligible for this Discount, 0 if null
- EndDate DateTime — End date after which this Discount will be discontinued
- EndTime DateTime — End time after which this Discount will be discontinued
- EnforceMaximumAmount bool — True if this Discount amount will not exceed MaximumAmount value, False if not enforced
- EnforceMaximumItems bool — True if this Discount will not be applied to items exceeding MaximumItems value, False if not enforced
- EnforceMaximumPerOrder bool — True if this Discount per order will not exceed MaximumPerOrder value, False if not enforced
- ExcludeItemsFromProductMix bool — True if items will be excluded from product mix, False if not
- ExternalId string — Stores the external identifier of a loyalty reward created via a loyalty provider
- Friday bool — True if this Discount can be applied on Fridays, False if not
- Granularity DiscountGranularity — Returns one of the following:
  - Order
  - Items
- Id int — Unique Id of this Discount
- IsEmployeeDiscount bool — True if this Discount is an employee discount, False if not
- IsLoyaltyDiscount bool — True if this Discount can only be applied via the redemption of a loyalty reward, False if not
- ManagerNeeded bool — True if this Discount requires manager approval, False if not
- MaximumAmount decimal — Maximum amount allowed for this Discount, 0 if null
- MaximumItems int — Maximum number of items this Discount can be applied to, 0 if null
- MaximumPerOrder int — Maximum amount per order this Discount can be applied for, 0 if null
- Monday bool — True if this Discount can be applied on Mondays, False if not
- MustEnterAmount bool — True if entering an amount for this Discount is required, False if not
- MustEnterName bool — True if entering a name for this Discount is required, False if not
- MustEnterPercent bool — True if entering a percentage for this Discount is required, False if not
- Name string — Name of this Discount
- OpenDrawer bool — True if the drawer will open when this Discount is applied, False if not
- PrintedName string — Name of this Discount printed on the receipt
- PrintOrder bool — True if the order will be printed when this Discount is applied, False if not
- Rate decimal — Percentage of this Discount to be applied
- Saturday bool — True if this Discount can be applied on Saturdays, False if not
- StartDate DateTime — Start date of when this Discount can be applied
- StartTime DateTime — Start time of when this Discount can be applied
- Sunday bool — True if this Discount can be applied on Sundays, False if not
- Thursday bool — True if this Discount can be applied on Thursdays, False if not
- Tuesday bool — True if this Discount can be applied on Tuesdays, False if not
- Type DiscountType — Returns one of the following:
  - None
  - Comp
  - New Price
  - Max
- UseDateRangeFilter bool — True if this Discount can only be applied between StartDate and EndDate, False if not enforced
- UseDayFilter bool — True if this Discount can only be applied on specific days, False if not enforced
- UseItemFilter bool — True if this Discount can only be applied to the designated item with EligibleItemId, False if not enforced
- UseItemGroupFilter bool — True if this Discount can only be applied to designated items within EligibleItemGroupIds, False if not enforced
- UseTimeRangeFilter bool — True if this Discount can only be applied between StartTime and EndTime, False if not enforced
- Wednesday bool — True if this Discount can be applied on Wednesdays, False if not

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetDiscounts request with accessToken and locationToken in body.

Responses

text/xml; charset=utf-8

post/GetDiscounts

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings.svc?Settings_GetDiscounts' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'SOAPAction: "http://tempuri.org/ISettingsWebService/GetDiscounts"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:tem="http://tempuri.org/">
    <soapenv:Header/>
    <soapenv:Body>
      <tem:GetDiscounts>
        <tem:accessToken>AccessToken</tem:accessToken>
        <tem:locationToken>LocationToken</tem:locationToken>
      </tem:GetDiscounts>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetDiscountsResponse xmlns="http://tempuri.org/">
      <Settings_GetDiscountsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Discounts>
          <Discount>
            <Active>true</Active>
            <AllowLaterDiscounts>true</AllowLaterDiscounts>
            <AllowPriorDiscounts>true</AllowPriorDiscounts>
            <Amount>0.00</Amount>
            <ApprovalNeeded>false</ApprovalNeeded>
            <DiscountedItemsEligible>false</DiscountedItemsEligible>
            <EligibleItemGroupIds>
              <Id>1</Id>
              <Id>2</Id>
            </EligibleItemGroupIds>
            <EligibleItemId>0</EligibleItemId>
            <EndDate>2025-12-31T00:00:00</EndDate>
            <EndTime>1899-12-30T23:59:59</EndTime>
            <EnforceMaximumAmount>false</EnforceMaximumAmount>
            <EnforceMaximumItems>false</EnforceMaximumItems>
            <EnforceMaximumPerOrder>false</EnforceMaximumPerOrder>
            <ExcludeItemsFromProductMix>false</ExcludeItemsFromProductMix>
            <ExternalId>DISC-001</ExternalId>
            <Friday>true</Friday>
            <Granularity>Order</Granularity>
            <Id>3</Id>
            <IsEmployeeDiscount>false</IsEmployeeDiscount>
            <IsLoyaltyDiscount>false</IsLoyaltyDiscount>
            <MaximumAmount>100.00</MaximumAmount>
            <MaximumItems>10</MaximumItems>
            <MaximumPerOrder>1</MaximumPerOrder>
            <Monday>true</Monday>
            <MustEnterAmount>false</MustEnterAmount>
            <MustEnterName>false</MustEnterName>
            <MustEnterPercent>false</MustEnterPercent>
            <Name>10% Off</Name>
            <OpenDrawer>false</OpenDrawer>
            <PrintedName>10% Discount</PrintedName>
            <PrintOrder>false</PrintOrder>
            <Rate>10.00</Rate>
            <Saturday>true</Saturday>
            <StartDate>2024-01-01T00:00:00</StartDate>
            <StartTime>1899-12-30T00:00:00</StartTime>
            <Sunday>true</Sunday>
            <Thursday>true</Thursday>
            <Tuesday>true</Tuesday>
            <Type>Percent</Type>
            <UseDateRangeFilter>false</UseDateRangeFilter>
            <UseDayFilter>false</UseDayFilter>
            <UseItemFilter>false</UseItemFilter>
            <UseItemGroupFilter>false</UseItemGroupFilter>
            <UseTimeRangeFilter>false</UseTimeRangeFilter>
            <Wednesday>true</Wednesday>
          </Discount>
        </Discounts>
      </Settings_GetDiscountsResult>
    </Settings_GetDiscountsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Discount objects.