POST posSupportAPI/promotion/update
The Update Promotion method. The Update Promotion request initiates an update for a previously committed redemption, applying the final check number to the successful transaction. The API will validate the transaction and update as appropriate.
Request Information
URI Parameters
None.
Body Parameters
The Update Promotion request object.
UpdatePromotionRequestName | Description | Type | Additional information |
---|---|---|---|
redemption |
The Redemption object. |
Redemption |
None. |
bill |
The Bill object. |
UpdateBill |
Required |
transactionDateTime |
The TransactionDateTime object. |
date |
None. |
businessDate |
The BusinessDate object. |
date |
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" }, "bill": { "checkNumber": 1 }, "transactionDateTime": "2024-05-18T04:27:14.3488871-04:00", "businessDate": "2024-05-18T04:27:14.3488871-04:00" }
application/xml, text/xml
Sample:
<UpdatePromotionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models"> <Bill> <CheckNumber>1</CheckNumber> </Bill> <BusinessDate>2024-05-18T04:27:14.3488871-04:00</BusinessDate> <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-18T04:27:14.3488871-04:00</TransactionDateTime> </UpdatePromotionRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
The Update Promotion response object.
UpdatePromotionResponseName | Description | Type | Additional 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:
<UpdatePromotionResponse 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> </UpdatePromotionResponse>