POST quSupportAPI/v4/rewards/validators

Request Information

URI Parameters

None.

Body Parameters

QuValidateRedemptionRequest
NameDescriptionTypeAdditional information
guestIdentifier

QuGuestIdentifierRequest

None.

order

QuOrder

None.

reward

QuReward

None.

Request Formats

application/json, text/json

Sample:
{
  "guestIdentifier": {
    "guestId": "sample string 1",
    "scannedCode": "sample string 2",
    "phone": "sample string 3",
    "email": "sample string 4"
  },
  "order": {
    "orderId": "sample string 1",
    "orderTypeId": 2,
    "orderChannelId": 3,
    "orderDetail": {
      "checkDateTime": "sample string 1",
      "itemTotal": 2.1,
      "preDiscountSubtotal": 3.1,
      "tax": 4.1,
      "totalDiscountApplied": 5.1,
      "total": 6.1,
      "items": [
        {
          "orderItemId": 1,
          "menuItemPath": [
            1,
            2
          ],
          "itemGroupId": 2,
          "title": "sample string 3",
          "quantity": 4,
          "basePrice": 5.1,
          "cost": 6.1,
          "portionId": 7,
          "appliedDiscounts": [
            {
              "instanceId": "sample string 1",
              "discountId": 2,
              "title": "sample string 3",
              "appliedAmount": 4.1,
              "selectionType": 5
            },
            {
              "instanceId": "sample string 1",
              "discountId": 2,
              "title": "sample string 3",
              "appliedAmount": 4.1,
              "selectionType": 5
            }
          ],
          "orderItemInstanceId": "sample string 8",
          "items": [
            {
              "orderItemId": 1,
              "menuItemPath": [
                1,
                2
              ],
              "itemGroupId": 2,
              "title": "sample string 3",
              "quantity": 4,
              "basePrice": 5.1,
              "cost": 6.1,
              "portionId": 7,
              "appliedDiscounts": [
                {
                  "instanceId": "sample string 1",
                  "discountId": 2,
                  "title": "sample string 3",
                  "appliedAmount": 4.1,
                  "selectionType": 5
                },
                {
                  "instanceId": "sample string 1",
                  "discountId": 2,
                  "title": "sample string 3",
                  "appliedAmount": 4.1,
                  "selectionType": 5
                }
              ]
            },
            {
              "orderItemId": 1,
              "menuItemPath": [
                1,
                2
              ],
              "itemGroupId": 2,
              "title": "sample string 3",
              "quantity": 4,
              "basePrice": 5.1,
              "cost": 6.1,
              "portionId": 7,
              "appliedDiscounts": [
                {
                  "instanceId": "sample string 1",
                  "discountId": 2,
                  "title": "sample string 3",
                  "appliedAmount": 4.1,
                  "selectionType": 5
                },
                {
                  "instanceId": "sample string 1",
                  "discountId": 2,
                  "title": "sample string 3",
                  "appliedAmount": 4.1,
                  "selectionType": 5
                }
              ]
            }
          ]
        },
        {
          "orderItemId": 1,
          "menuItemPath": [
            1,
            2
          ],
          "itemGroupId": 2,
          "title": "sample string 3",
          "quantity": 4,
          "basePrice": 5.1,
          "cost": 6.1,
          "portionId": 7,
          "appliedDiscounts": [
            {
              "instanceId": "sample string 1",
              "discountId": 2,
              "title": "sample string 3",
              "appliedAmount": 4.1,
              "selectionType": 5
            },
            {
              "instanceId": "sample string 1",
              "discountId": 2,
              "title": "sample string 3",
              "appliedAmount": 4.1,
              "selectionType": 5
            }
          ],
          "orderItemInstanceId": "sample string 8",
          "items": [
            {
              "orderItemId": 1,
              "menuItemPath": [
                1,
                2
              ],
              "itemGroupId": 2,
              "title": "sample string 3",
              "quantity": 4,
              "basePrice": 5.1,
              "cost": 6.1,
              "portionId": 7,
              "appliedDiscounts": [
                {
                  "instanceId": "sample string 1",
                  "discountId": 2,
                  "title": "sample string 3",
                  "appliedAmount": 4.1,
                  "selectionType": 5
                },
                {
                  "instanceId": "sample string 1",
                  "discountId": 2,
                  "title": "sample string 3",
                  "appliedAmount": 4.1,
                  "selectionType": 5
                }
              ]
            },
            {
              "orderItemId": 1,
              "menuItemPath": [
                1,
                2
              ],
              "itemGroupId": 2,
              "title": "sample string 3",
              "quantity": 4,
              "basePrice": 5.1,
              "cost": 6.1,
              "portionId": 7,
              "appliedDiscounts": [
                {
                  "instanceId": "sample string 1",
                  "discountId": 2,
                  "title": "sample string 3",
                  "appliedAmount": 4.1,
                  "selectionType": 5
                },
                {
                  "instanceId": "sample string 1",
                  "discountId": 2,
                  "title": "sample string 3",
                  "appliedAmount": 4.1,
                  "selectionType": 5
                }
              ]
            }
          ]
        }
      ],
      "appliedDiscounts": [
        {
          "instanceId": "sample string 1",
          "discountId": 2,
          "title": "sample string 3",
          "appliedAmount": 4.1,
          "selectionType": 5
        },
        {
          "instanceId": "sample string 1",
          "discountId": 2,
          "title": "sample string 3",
          "appliedAmount": 4.1,
          "selectionType": 5
        }
      ],
      "appliedRewards": [
        {
          "instanceId": "sample string 1",
          "discountInstanceId": "sample string 2",
          "rewardId": "sample string 3",
          "name": "sample string 4",
          "description": "sample string 5",
          "rewardType": "sample string 6",
          "discountAmount": 7.1,
          "pointsCost": 8,
          "qualifiedOrderItems": [
            {
              "orderItemInstanceId": "sample string 1",
              "title": "sample string 2",
              "quantity": "sample string 3"
            },
            {
              "orderItemInstanceId": "sample string 1",
              "title": "sample string 2",
              "quantity": "sample string 3"
            }
          ],
          "redeemed": true
        },
        {
          "instanceId": "sample string 1",
          "discountInstanceId": "sample string 2",
          "rewardId": "sample string 3",
          "name": "sample string 4",
          "description": "sample string 5",
          "rewardType": "sample string 6",
          "discountAmount": 7.1,
          "pointsCost": 8,
          "qualifiedOrderItems": [
            {
              "orderItemInstanceId": "sample string 1",
              "title": "sample string 2",
              "quantity": "sample string 3"
            },
            {
              "orderItemInstanceId": "sample string 1",
              "title": "sample string 2",
              "quantity": "sample string 3"
            }
          ],
          "redeemed": true
        }
      ]
    },
    "posLocationId": 4,
    "providerLocationId": "sample string 5"
  },
  "reward": {
    "rewardId": "sample string 1",
    "name": "sample string 2",
    "description": "sample string 3",
    "rewardType": "sample string 4",
    "validFrom": "2026-03-23T19:53:43.2171939-04:00",
    "validTo": "2026-03-23T19:53:43.2171939-04:00",
    "minimumDiscountAmount": 7.1,
    "discountAmount": 8.1,
    "discountPercentage": 9.1,
    "pointsCost": 10,
    "valuePerPoint": 11.1,
    "voucherCode": "sample string 12",
    "posReference": "sample string 13"
  }
}

application/xml, text/xml

Sample:
<QuValidateRedemptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <GuestIdentifier>
    <Email>sample string 4</Email>
    <GuestId>sample string 1</GuestId>
    <Phone>sample string 3</Phone>
    <ScannedCode>sample string 2</ScannedCode>
  </GuestIdentifier>
  <Order>
    <OrderChannelId>3</OrderChannelId>
    <OrderDetail>
      <AppliedDiscounts>
        <QuAppliedDiscount>
          <AppliedAmount>4.1</AppliedAmount>
          <DiscountId>2</DiscountId>
          <InstanceId>sample string 1</InstanceId>
          <SelectionType>5</SelectionType>
          <Title>sample string 3</Title>
        </QuAppliedDiscount>
        <QuAppliedDiscount>
          <AppliedAmount>4.1</AppliedAmount>
          <DiscountId>2</DiscountId>
          <InstanceId>sample string 1</InstanceId>
          <SelectionType>5</SelectionType>
          <Title>sample string 3</Title>
        </QuAppliedDiscount>
      </AppliedDiscounts>
      <AppliedRewards>
        <QuAppliedReward>
          <Description>sample string 5</Description>
          <DiscountAmount>7.1</DiscountAmount>
          <DiscountInstanceId>sample string 2</DiscountInstanceId>
          <InstanceId>sample string 1</InstanceId>
          <Name>sample string 4</Name>
          <PointsCost>8</PointsCost>
          <QualifiedOrderItems>
            <QuQualifiedOrderItem>
              <OrderItemInstanceId>sample string 1</OrderItemInstanceId>
              <Quantity>sample string 3</Quantity>
              <Title>sample string 2</Title>
            </QuQualifiedOrderItem>
            <QuQualifiedOrderItem>
              <OrderItemInstanceId>sample string 1</OrderItemInstanceId>
              <Quantity>sample string 3</Quantity>
              <Title>sample string 2</Title>
            </QuQualifiedOrderItem>
          </QualifiedOrderItems>
          <Redeemed>true</Redeemed>
          <RewardId>sample string 3</RewardId>
          <RewardType>sample string 6</RewardType>
        </QuAppliedReward>
        <QuAppliedReward>
          <Description>sample string 5</Description>
          <DiscountAmount>7.1</DiscountAmount>
          <DiscountInstanceId>sample string 2</DiscountInstanceId>
          <InstanceId>sample string 1</InstanceId>
          <Name>sample string 4</Name>
          <PointsCost>8</PointsCost>
          <QualifiedOrderItems>
            <QuQualifiedOrderItem>
              <OrderItemInstanceId>sample string 1</OrderItemInstanceId>
              <Quantity>sample string 3</Quantity>
              <Title>sample string 2</Title>
            </QuQualifiedOrderItem>
            <QuQualifiedOrderItem>
              <OrderItemInstanceId>sample string 1</OrderItemInstanceId>
              <Quantity>sample string 3</Quantity>
              <Title>sample string 2</Title>
            </QuQualifiedOrderItem>
          </QualifiedOrderItems>
          <Redeemed>true</Redeemed>
          <RewardId>sample string 3</RewardId>
          <RewardType>sample string 6</RewardType>
        </QuAppliedReward>
      </AppliedRewards>
      <CheckDateTime>sample string 1</CheckDateTime>
      <ItemTotal>2.1</ItemTotal>
      <Items>
        <QuOrderItem>
          <AppliedDiscounts>
            <QuAppliedDiscount>
              <AppliedAmount>4.1</AppliedAmount>
              <DiscountId>2</DiscountId>
              <InstanceId>sample string 1</InstanceId>
              <SelectionType>5</SelectionType>
              <Title>sample string 3</Title>
            </QuAppliedDiscount>
            <QuAppliedDiscount>
              <AppliedAmount>4.1</AppliedAmount>
              <DiscountId>2</DiscountId>
              <InstanceId>sample string 1</InstanceId>
              <SelectionType>5</SelectionType>
              <Title>sample string 3</Title>
            </QuAppliedDiscount>
          </AppliedDiscounts>
          <BasePrice>5.1</BasePrice>
          <Cost>6.1</Cost>
          <ItemGroupId>2</ItemGroupId>
          <Items>
            <QuOrderItemModifier>
              <AppliedDiscounts>
                <QuAppliedDiscount>
                  <AppliedAmount>4.1</AppliedAmount>
                  <DiscountId>2</DiscountId>
                  <InstanceId>sample string 1</InstanceId>
                  <SelectionType>5</SelectionType>
                  <Title>sample string 3</Title>
                </QuAppliedDiscount>
                <QuAppliedDiscount>
                  <AppliedAmount>4.1</AppliedAmount>
                  <DiscountId>2</DiscountId>
                  <InstanceId>sample string 1</InstanceId>
                  <SelectionType>5</SelectionType>
                  <Title>sample string 3</Title>
                </QuAppliedDiscount>
              </AppliedDiscounts>
              <BasePrice>5.1</BasePrice>
              <Cost>6.1</Cost>
              <ItemGroupId>2</ItemGroupId>
              <MenuItemPath xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </MenuItemPath>
              <OrderItemId>1</OrderItemId>
              <PortionId>7</PortionId>
              <Quantity>4</Quantity>
              <Title>sample string 3</Title>
            </QuOrderItemModifier>
            <QuOrderItemModifier>
              <AppliedDiscounts>
                <QuAppliedDiscount>
                  <AppliedAmount>4.1</AppliedAmount>
                  <DiscountId>2</DiscountId>
                  <InstanceId>sample string 1</InstanceId>
                  <SelectionType>5</SelectionType>
                  <Title>sample string 3</Title>
                </QuAppliedDiscount>
                <QuAppliedDiscount>
                  <AppliedAmount>4.1</AppliedAmount>
                  <DiscountId>2</DiscountId>
                  <InstanceId>sample string 1</InstanceId>
                  <SelectionType>5</SelectionType>
                  <Title>sample string 3</Title>
                </QuAppliedDiscount>
              </AppliedDiscounts>
              <BasePrice>5.1</BasePrice>
              <Cost>6.1</Cost>
              <ItemGroupId>2</ItemGroupId>
              <MenuItemPath xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </MenuItemPath>
              <OrderItemId>1</OrderItemId>
              <PortionId>7</PortionId>
              <Quantity>4</Quantity>
              <Title>sample string 3</Title>
            </QuOrderItemModifier>
          </Items>
          <MenuItemPath xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </MenuItemPath>
          <OrderItemId>1</OrderItemId>
          <OrderItemInstanceId>sample string 8</OrderItemInstanceId>
          <PortionId>7</PortionId>
          <Quantity>4</Quantity>
          <Title>sample string 3</Title>
        </QuOrderItem>
        <QuOrderItem>
          <AppliedDiscounts>
            <QuAppliedDiscount>
              <AppliedAmount>4.1</AppliedAmount>
              <DiscountId>2</DiscountId>
              <InstanceId>sample string 1</InstanceId>
              <SelectionType>5</SelectionType>
              <Title>sample string 3</Title>
            </QuAppliedDiscount>
            <QuAppliedDiscount>
              <AppliedAmount>4.1</AppliedAmount>
              <DiscountId>2</DiscountId>
              <InstanceId>sample string 1</InstanceId>
              <SelectionType>5</SelectionType>
              <Title>sample string 3</Title>
            </QuAppliedDiscount>
          </AppliedDiscounts>
          <BasePrice>5.1</BasePrice>
          <Cost>6.1</Cost>
          <ItemGroupId>2</ItemGroupId>
          <Items>
            <QuOrderItemModifier>
              <AppliedDiscounts>
                <QuAppliedDiscount>
                  <AppliedAmount>4.1</AppliedAmount>
                  <DiscountId>2</DiscountId>
                  <InstanceId>sample string 1</InstanceId>
                  <SelectionType>5</SelectionType>
                  <Title>sample string 3</Title>
                </QuAppliedDiscount>
                <QuAppliedDiscount>
                  <AppliedAmount>4.1</AppliedAmount>
                  <DiscountId>2</DiscountId>
                  <InstanceId>sample string 1</InstanceId>
                  <SelectionType>5</SelectionType>
                  <Title>sample string 3</Title>
                </QuAppliedDiscount>
              </AppliedDiscounts>
              <BasePrice>5.1</BasePrice>
              <Cost>6.1</Cost>
              <ItemGroupId>2</ItemGroupId>
              <MenuItemPath xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </MenuItemPath>
              <OrderItemId>1</OrderItemId>
              <PortionId>7</PortionId>
              <Quantity>4</Quantity>
              <Title>sample string 3</Title>
            </QuOrderItemModifier>
            <QuOrderItemModifier>
              <AppliedDiscounts>
                <QuAppliedDiscount>
                  <AppliedAmount>4.1</AppliedAmount>
                  <DiscountId>2</DiscountId>
                  <InstanceId>sample string 1</InstanceId>
                  <SelectionType>5</SelectionType>
                  <Title>sample string 3</Title>
                </QuAppliedDiscount>
                <QuAppliedDiscount>
                  <AppliedAmount>4.1</AppliedAmount>
                  <DiscountId>2</DiscountId>
                  <InstanceId>sample string 1</InstanceId>
                  <SelectionType>5</SelectionType>
                  <Title>sample string 3</Title>
                </QuAppliedDiscount>
              </AppliedDiscounts>
              <BasePrice>5.1</BasePrice>
              <Cost>6.1</Cost>
              <ItemGroupId>2</ItemGroupId>
              <MenuItemPath xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </MenuItemPath>
              <OrderItemId>1</OrderItemId>
              <PortionId>7</PortionId>
              <Quantity>4</Quantity>
              <Title>sample string 3</Title>
            </QuOrderItemModifier>
          </Items>
          <MenuItemPath xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </MenuItemPath>
          <OrderItemId>1</OrderItemId>
          <OrderItemInstanceId>sample string 8</OrderItemInstanceId>
          <PortionId>7</PortionId>
          <Quantity>4</Quantity>
          <Title>sample string 3</Title>
        </QuOrderItem>
      </Items>
      <PreDiscountSubtotal>3.1</PreDiscountSubtotal>
      <Tax>4.1</Tax>
      <Total>6.1</Total>
      <TotalDiscountApplied>5.1</TotalDiscountApplied>
    </OrderDetail>
    <OrderId>sample string 1</OrderId>
    <OrderTypeId>2</OrderTypeId>
    <PosLocationId>4</PosLocationId>
    <ProviderLocationId>sample string 5</ProviderLocationId>
  </Order>
  <Reward>
    <Description>sample string 3</Description>
    <DiscountAmount>8.1</DiscountAmount>
    <DiscountPercentage>9.1</DiscountPercentage>
    <MinimumDiscountAmount>7.1</MinimumDiscountAmount>
    <Name>sample string 2</Name>
    <PointsCost>10</PointsCost>
    <PosReference>sample string 13</PosReference>
    <RewardId>sample string 1</RewardId>
    <RewardType>sample string 4</RewardType>
    <ValidFrom>2026-03-23T19:53:43.2171939-04:00</ValidFrom>
    <ValidTo>2026-03-23T19:53:43.2171939-04:00</ValidTo>
    <ValuePerPoint>11.1</ValuePerPoint>
    <VoucherCode>sample string 12</VoucherCode>
  </Reward>
</QuValidateRedemptionRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'QuValidateRedemptionRequest'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.