POST posSupportAPI/promotion/void
The Void Promtion method. This request initiates a void for a previously successful redemption. The API will validate the redemption discount and void as appropriate.
Request Information
URI Parameters
None.
Body Parameters
The Void Promotion request context.
VoidPromotionRequestName | Description | Type | Additional information |
---|---|---|---|
redemption |
The Redemption object Id value for the redemption that is being voided. |
Redemption |
Required |
transactionDateTime |
The transaction date/time – local system time when the transaction took place. ISO 8601 UTC Date Format (YYYY-MM-DDThh:mm:ss.sTZD) |
date |
Required |
businessDate |
The transaction Business Date. ISO 8601 UTC Date Format (YYYY-MM-DD) |
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" }, "transactionDateTime": "2024-05-18T03:34:51.8018241-04:00", "businessDate": "2024-05-18T03:34:51.8018241-04:00" }
application/xml, text/xml
Sample:
<VoidPromotionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models"> <BusinessDate>2024-05-18T03:34:51.8018241-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-18T03:34:51.8018241-04:00</TransactionDateTime> </VoidPromotionRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
A Void Promotion response object.
VoidPromotionResponseName | 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:
<VoidPromotionResponse 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> </VoidPromotionResponse>