POST posSupportAPI/promotion/redeemOfferConnect

The Offer Connect Redeem method. This request applies Fishbowl promotions for the specified promotions code. The API will validate and apply the discount based on the Promotions code.

Request Information

URI Parameters

None.

Body Parameters

RedeemOfferConnectRequest

Name	Description	Type	Additional information
couponCode	The CouponCode.	string	Required
checkTotal	The CheckTotal.	decimal number	None.
transactionDateTime	The TransactionDateTime.	date	Required
businessDate	The BusinessDate.	date	Required
loyaltyMember	The loyalty member details associated with the transaction.	LoyaltyMember	None.

Request Formats

application/json, text/json

Sample:

{
  "couponCode": "sample string 1",
  "checkTotal": 2.0,
  "transactionDateTime": "2024-05-18T01:45:04.6919269-04:00",
  "businessDate": "2024-05-18T01:45:04.6919269-04:00",
  "loyaltyMember": {
    "loyaltyNumber": "sample string 1"
  }
}

application/xml, text/xml

Sample:

<RedeemOfferConnectRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <BusinessDate>2024-05-18T01:45:04.6919269-04:00</BusinessDate>
  <CheckTotal>2</CheckTotal>
  <CouponCode>sample string 1</CouponCode>
  <LoyaltyMember>
    <LoyaltyNumber>sample string 1</LoyaltyNumber>
  </LoyaltyMember>
  <TransactionDateTime>2024-05-18T01:45:04.6919269-04:00</TransactionDateTime>
</RedeemOfferConnectRequest>

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

Response Information

Resource Description

RedeemOfferConnectResponse

RedeemPromotionResponse

Name	Description	Type	Additional information
redemption	The redemption details.	Redemption	Required
promotion	The promotion details.	Promotion	Required
selectablePromotion	Selectable Promotion Details (only returned if promotion is determined to be “Selectable Promotion” type).	SelectablePromotion	None.
result	The result object.	Result	Required

Response Formats

application/json, text/json

Sample:

{
  "redemption": {
    "id": "sample string 1",
    "discountAmount": 2.0,
    "discountId": 3,
    "receiptText": "sample string 4",
    "outcome": {
      "id": 1,
      "name": "sample string 2",
      "message": "sample string 3"
    },
    "discountUniqueIdentifier": "sample string 5"
  },
  "promotion": {
    "id": 1
  },
  "selectablePromotion": {
    "eligibleBillLineItems": [
      {
        "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
      }
    ],
    "quantity": 1
  },
  "result": {
    "statusCode": 1,
    "description": "sample string 2",
    "exceptionTrackingMoniker": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<RedeemPromotionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <Promotion>
    <Id>1</Id>
  </Promotion>
  <Redemption>
    <DiscountId>3</DiscountId>
    <DiscountUniqueIdentifier>sample string 5</DiscountUniqueIdentifier>
    <DisountAmount>2</DisountAmount>
    <Id>sample string 1</Id>
    <Outcome>
      <Id>1</Id>
      <Message>sample string 3</Message>
      <Name>sample string 2</Name>
    </Outcome>
    <ReceiptText>sample string 4</ReceiptText>
  </Redemption>
  <Result>
    <Description>sample string 2</Description>
    <ExceptionTrackingMoniker>sample string 3</ExceptionTrackingMoniker>
    <StatusCode>1</StatusCode>
  </Result>
  <SelectablePromotion>
    <EligibleBillLineItems>
      <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>
    </EligibleBillLineItems>
    <Quantity>1</Quantity>
  </SelectablePromotion>
</RedeemPromotionResponse>