POST posSupportAPI/promotion/commit

The Commit Promotion method. The Commit Promotion request initiates a commit for a previously successful authorized redemption. The API will validate the transaction and commit as appropriate.

Request Information

URI Parameters

None.

Body Parameters

The Commit Promotion request object.

CommitPromotionRequest
NameDescriptionTypeAdditional information
redemption

The Redemption object.

Redemption

None.

transactionDateTime

The TransactionDateTime object.

date

None.

businessDate

The BusinessDate object.

date

None.

loyaltyMember

The loyalty member details associated with the transaction.

LoyaltyMember

None.

Request 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"
  },
  "transactionDateTime": "2024-05-18T03:34:52.0777417-04:00",
  "businessDate": "2024-05-18T03:34:52.0777417-04:00",
  "loyaltyMember": {
    "loyaltyNumber": "sample string 1"
  }
}

application/xml, text/xml

Sample:
<CommitPromotionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <BusinessDate>2024-05-18T03:34:52.0777417-04:00</BusinessDate>
  <LoyaltyMember>
    <LoyaltyNumber>sample string 1</LoyaltyNumber>
  </LoyaltyMember>
  <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>
  <TransactionDateTime>2024-05-18T03:34:52.0777417-04:00</TransactionDateTime>
</CommitPromotionRequest>

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

Response Information

Resource Description

The Commit Promotion response object.

CommitPromotionResponse
NameDescriptionTypeAdditional information
result

The Result object.

Result

Required

Response Formats

application/json, text/json

Sample:
{
  "result": {
    "statusCode": 1,
    "description": "sample string 2",
    "exceptionTrackingMoniker": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<CommitPromotionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <Result>
    <Description>sample string 2</Description>
    <ExceptionTrackingMoniker>sample string 3</ExceptionTrackingMoniker>
    <StatusCode>1</StatusCode>
  </Result>
</CommitPromotionResponse>