POST v1/Loyalty/VoidRewards/{siteId}/{orderId}

This call voids any previously registered loyalty rewards for an order.
Use this call when you wish to void a loyalty transaction with us. This will remove any loyalty type rewards from the order, recalculate the order totals, and give you the updated order. Doing this will mean you will need to make another set of AvailableRewards and RedeemRewards calls in order to do any loyalty-based discount processing for this specific order (identified by siteId and orderId in the url).

URI template

v1/Loyalty/VoidRewards/{siteId}/{orderId}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId	Identifies the site where the customer has placed their order	integer	Required
orderId	Identifies the order in question	integer	Required

Body Parameters

None.

Response Information

Resource Description

Updated order and totals

VoidLoyaltyRewardsResult

Name	Description	Type	Additional information
UpdatedOrder	Represents the updated Order and totals	ExternalOrder	None.

Response Formats

application/json, text/json

Sample:

{
  "UpdatedOrder": {
    "$id": "2",
    "SiteId": 0,
    "OrderId": 0,
    "MenuId": 0,
    "PromoId": 0,
    "DesignId": 0,
    "OrderMode": 0,
    "LastModifiedTimestamp": "0001-01-01T00:00:00",
    "Status": 0,
    "PromiseDateTime": null,
    "PaymentMode": 0,
    "Customer": null,
    "CustomerAddressForOrder": null,
    "LineItems": null,
    "SubTotalAmount": 0.0,
    "TotalSurchargeAmount": 0.0,
    "TaxAmount": 0.0,
    "PaymentAmount": 0.0,
    "TotalAmount": 0.0,
    "BalanceDueAmount": 0.0,
    "LoyaltyCardNumber": null,
    "LoyaltyRewards": null,
    "OrderSource": null,
    "Destination": null,
    "NextItemLineNumber": 0,
    "SpecialInstructions": null,
    "SubmitCommandId": null,
    "SubmitOrderNumber": null,
    "HumanReadableSubmitOrderNumber": null,
    "SubmitMessage": null,
    "CreationDateTime": null,
    "CompId": 0,
    "CompValue": 0.0,
    "CompName": null,
    "DeliveryFeeAmount": 0.0,
    "TaxJurisdictionId": null,
    "SubmitOrderId": null,
    "IsFailover": false,
    "ReferenceNumber": null,
    "ExternalOrderId": null,
    "ComboItems": null,
    "Guests": null,
    "SVCAmount": 0.0,
    "Payments": null,
    "NextOrderOfProcessing": 0,
    "SiteNotes": null,
    "IsVisible": false,
    "DiscountTotal": 0.0,
    "Metadata": null,
    "ComputedDiscount": 0.0,
    "OrderDiscounts": null,
    "TipAmount": 0.0,
    "PromotionsServiceResponse": null,
    "LoyaltyStatus": null
  }
}

application/xml, text/xml

Sample:

<VoidLoyaltyRewardsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response">
  <UpdatedOrder xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
    <d2p1:AppliedComps i:nil="true" />
    <d2p1:BalanceDueAmount>0</d2p1:BalanceDueAmount>
    <d2p1:ComboItems xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound" i:nil="true" />
    <d2p1:CompId>0</d2p1:CompId>
    <d2p1:CompName i:nil="true" />
    <d2p1:CompValue>0</d2p1:CompValue>
    <d2p1:ComputedDiscount>0</d2p1:ComputedDiscount>
    <d2p1:CreationDateTime i:nil="true" />
    <d2p1:Customer i:nil="true" />
    <d2p1:CustomerAddressForOrder i:nil="true" />
    <d2p1:DeliveryFeeAmount>0</d2p1:DeliveryFeeAmount>
    <d2p1:DesignId>0</d2p1:DesignId>
    <d2p1:Destination i:nil="true" />
    <d2p1:DiscountTotal>0</d2p1:DiscountTotal>
    <d2p1:ExternalOrderId i:nil="true" />
    <d2p1:Guests i:nil="true" />
    <d2p1:HumanReadableSubmitOrderNumber i:nil="true" />
    <d2p1:IsFailover>false</d2p1:IsFailover>
    <d2p1:IsVisible>false</d2p1:IsVisible>
    <d2p1:LastModifiedTimestamp>0001-01-01T00:00:00</d2p1:LastModifiedTimestamp>
    <d2p1:LineItems i:nil="true" />
    <d2p1:LoyaltyCardNumber i:nil="true" />
    <d2p1:LoyaltyRewards xmlns:d3p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities" i:nil="true" />
    <d2p1:LoyaltyStatus i:nil="true" />
    <d2p1:MenuId>0</d2p1:MenuId>
    <d2p1:Metadata xmlns:d3p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities" i:nil="true" />
    <d2p1:NextItemLineNumber>0</d2p1:NextItemLineNumber>
    <d2p1:NextOrderOfProcessing>0</d2p1:NextOrderOfProcessing>
    <d2p1:OrderDiscounts i:nil="true" />
    <d2p1:OrderId>0</d2p1:OrderId>
    <d2p1:OrderMode />
    <d2p1:OrderSource i:nil="true" />
    <d2p1:PaymentAmount>0</d2p1:PaymentAmount>
    <d2p1:PaymentMode>Unknown</d2p1:PaymentMode>
    <d2p1:Payments i:nil="true" />
    <d2p1:PromiseDateTime i:nil="true" />
    <d2p1:PromoId>0</d2p1:PromoId>
    <d2p1:PromotionsServiceResponse xmlns:d3p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities.Entities.PesLoyalty" i:nil="true" />
    <d2p1:ReferenceNumber i:nil="true" />
    <d2p1:SVCAmount>0</d2p1:SVCAmount>
    <d2p1:SavedOrderId i:nil="true" />
    <d2p1:SiteId>0</d2p1:SiteId>
    <d2p1:SiteNotes i:nil="true" />
    <d2p1:SpecialInstructions i:nil="true" />
    <d2p1:Status>Invalid</d2p1:Status>
    <d2p1:SubTotalAmount>0</d2p1:SubTotalAmount>
    <d2p1:SubmitCommandId i:nil="true" />
    <d2p1:SubmitMessage i:nil="true" />
    <d2p1:SubmitOrderId i:nil="true" />
    <d2p1:SubmitOrderNumber i:nil="true" />
    <d2p1:TaxAmount>0</d2p1:TaxAmount>
    <d2p1:TaxJurisdictionId i:nil="true" />
    <d2p1:TipAmount>0</d2p1:TipAmount>
    <d2p1:TotalAmount>0</d2p1:TotalAmount>
    <d2p1:TotalSurchargeAmount>0</d2p1:TotalSurchargeAmount>
  </UpdatedOrder>
</VoidLoyaltyRewardsResult>