POST posSupportAPI/loyalty/posevent

The Loyalty POS Event method. This request initiates a Loyalty POS Event. Clients should make this request to initiate a Loyalty visit or spend transaction.

Request Information

URI Parameters

None.

Body Parameters

The Loyalty POS Event request context.

LoyaltyPOSEventRequest
NameDescriptionTypeAdditional information
loyalty

The loyalty details for the transaction (POS Event).

Loyalty

Required

bill

The loyalty transaction (check) details.

LoyaltyBill

Required

nativeDiscounts

The list of promotions applied to the check.

Collection of LoyaltyPromotion

None.

Request Formats

application/json, text/json

Sample:
{
  "loyalty": {
    "loyaltyNumber": "sample string 1",
    "tenantId": 2
  },
  "bill": {
    "checkNumber": 1,
    "server": {
      "id": "sample string 1",
      "fullName": "sample string 2"
    },
    "manager": {
      "id": "sample string 1",
      "fullName": "sample string 2"
    },
    "orderModeId": 1,
    "transactionDateTime": "2024-05-18T04:27:14.4549155-04:00",
    "businessDate": "2024-05-18T04:27:14.4549155-04:00",
    "businessDateTime": "2024-05-18T04:27:14.4549155-04:00",
    "total": 1.0,
    "billLineItems": [
      {
        "itemId": 1,
        "quantity": 1.0,
        "amount": 1.0,
        "itemName": "sample string 1",
        "selected": true,
        "matchedPOS": true,
        "isCombo": true,
        "parentItemId": "sample string 2",
        "sizeId": 1
      },
      {
        "itemId": 1,
        "quantity": 1.0,
        "amount": 1.0,
        "itemName": "sample string 1",
        "selected": true,
        "matchedPOS": true,
        "isCombo": true,
        "parentItemId": "sample string 2",
        "sizeId": 1
      }
    ]
  },
  "nativeDiscounts": [
    {
      "couponSourceCode": "sample string 1"
    },
    {
      "couponSourceCode": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:
<LoyaltyPOSEventRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <Bill>
    <BillLineItems>
      <BillLineItem>
        <Amount>1</Amount>
        <IsCombo>true</IsCombo>
        <ItemId>1</ItemId>
        <ItemName>sample string 1</ItemName>
        <MatchedPOS>true</MatchedPOS>
        <ParentItemId>sample string 2</ParentItemId>
        <Quantity>1</Quantity>
        <Selected>true</Selected>
        <SizeId>1</SizeId>
      </BillLineItem>
      <BillLineItem>
        <Amount>1</Amount>
        <IsCombo>true</IsCombo>
        <ItemId>1</ItemId>
        <ItemName>sample string 1</ItemName>
        <MatchedPOS>true</MatchedPOS>
        <ParentItemId>sample string 2</ParentItemId>
        <Quantity>1</Quantity>
        <Selected>true</Selected>
        <SizeId>1</SizeId>
      </BillLineItem>
    </BillLineItems>
    <BusinessDate>2024-05-18T04:27:14.4549155-04:00</BusinessDate>
    <BusinessDateTime>2024-05-18T04:27:14.4549155-04:00</BusinessDateTime>
    <CheckNumber>1</CheckNumber>
    <Manager>
      <FullName>sample string 2</FullName>
      <Id>sample string 1</Id>
    </Manager>
    <OrderModeId>1</OrderModeId>
    <Server>
      <FullName>sample string 2</FullName>
      <Id>sample string 1</Id>
    </Server>
    <Total>1</Total>
    <TransactionDateTime>2024-05-18T04:27:14.4549155-04:00</TransactionDateTime>
  </Bill>
  <Loyalty>
    <LoyaltyNumber>sample string 1</LoyaltyNumber>
    <TenantId>2</TenantId>
  </Loyalty>
  <Promotion>
    <LoyaltyPromotion>
      <PromotionCode>sample string 1</PromotionCode>
    </LoyaltyPromotion>
    <LoyaltyPromotion>
      <PromotionCode>sample string 1</PromotionCode>
    </LoyaltyPromotion>
  </Promotion>
</LoyaltyPOSEventRequest>

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 'LoyaltyPOSEventRequest'.

Response Information

Resource Description

A Loyalty POS Event response object.

LoyaltyPOSEventResponse
NameDescriptionTypeAdditional information
pointsEarned

The number of loyalty points earned for the event.

integer

Required

totalPoints

The total points accumulated for the loyalty member.

integer

Required

rewards

The loyalty member's available rewards list.

Collection of Reward

Required

result

The result object.

Result

Required

nativeDiscountResults

The results of processing any native discounts for the loyalty event.

Collection of LoyaltyPromotionResult

None.

Response Formats

application/json, text/json

Sample:
{
  "pointsEarned": 1,
  "totalPoints": 2,
  "rewards": [
    {
      "promotionId": 1,
      "promotionCode": "sample string 2",
      "promotionPublicName": "sample string 3",
      "promotionPublicDescription": "sample string 4",
      "promotionExpiration": "sample string 5"
    },
    {
      "promotionId": 1,
      "promotionCode": "sample string 2",
      "promotionPublicName": "sample string 3",
      "promotionPublicDescription": "sample string 4",
      "promotionExpiration": "sample string 5"
    }
  ],
  "result": {
    "statusCode": 1,
    "description": "sample string 2",
    "exceptionTrackingMoniker": "sample string 3"
  },
  "nativeDiscountResults": [
    {
      "nativeDiscount": {
        "couponSourceCode": "sample string 1"
      },
      "result": {
        "statusCode": 1,
        "description": "sample string 2",
        "exceptionTrackingMoniker": "sample string 3"
      }
    },
    {
      "nativeDiscount": {
        "couponSourceCode": "sample string 1"
      },
      "result": {
        "statusCode": 1,
        "description": "sample string 2",
        "exceptionTrackingMoniker": "sample string 3"
      }
    }
  ]
}

application/xml, text/xml

Sample:
<LoyaltyPOSEventResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <PointsEarned>1</PointsEarned>
  <PromotionResults>
    <LoyaltyPromotionResult>
      <LoyaltyPromotion>
        <PromotionCode>sample string 1</PromotionCode>
      </LoyaltyPromotion>
      <Result>
        <Description>sample string 2</Description>
        <ExceptionTrackingMoniker>sample string 3</ExceptionTrackingMoniker>
        <StatusCode>1</StatusCode>
      </Result>
    </LoyaltyPromotionResult>
    <LoyaltyPromotionResult>
      <LoyaltyPromotion>
        <PromotionCode>sample string 1</PromotionCode>
      </LoyaltyPromotion>
      <Result>
        <Description>sample string 2</Description>
        <ExceptionTrackingMoniker>sample string 3</ExceptionTrackingMoniker>
        <StatusCode>1</StatusCode>
      </Result>
    </LoyaltyPromotionResult>
  </PromotionResults>
  <Result>
    <Description>sample string 2</Description>
    <ExceptionTrackingMoniker>sample string 3</ExceptionTrackingMoniker>
    <StatusCode>1</StatusCode>
  </Result>
  <Rewards>
    <Reward>
      <PromotionCode>sample string 2</PromotionCode>
      <PromotionExpiration>sample string 5</PromotionExpiration>
      <PromotionId>1</PromotionId>
      <PromotionPublicDescription>sample string 4</PromotionPublicDescription>
      <PromotionPublicName>sample string 3</PromotionPublicName>
    </Reward>
    <Reward>
      <PromotionCode>sample string 2</PromotionCode>
      <PromotionExpiration>sample string 5</PromotionExpiration>
      <PromotionId>1</PromotionId>
      <PromotionPublicDescription>sample string 4</PromotionPublicDescription>
      <PromotionPublicName>sample string 3</PromotionPublicName>
    </Reward>
  </Rewards>
  <TotalPoints>2</TotalPoints>
</LoyaltyPOSEventResponse>