POST xpientSupportAPI/voidOrder

The VoidOrder method.

This request is initiated when a manager voids (Over Ring) an order that has a loyalty discount applied.

The API will validate the order discount and void as appropriate.

Request Information

URI Parameters

None.

Body Parameters

The VoidOrderRequestModel object.

VoidOrderRequestModel

Name	Description	Type	Additional information
voidOrderRequest	This request is initiated when a manager voids (Over Ring) an order that has a loyalty discount applied. The API will validate the order discount and void as appropriate.	VoidOrderRequest	Required

Request Formats

application/json, text/json

Sample:

{
  "voidOrderRequest": {
    "header": {
      "operatorId": "sample string 1",
      "storeId": "sample string 2",
      "terminalId": "sample string 3",
      "posGroup": "sample string 4"
    },
    "loyaltyOrderID": "sample string 1",
    "shortCode": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<VoidOrderRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <POSLoyaltyVoidOrderRequest>
    <Header>
      <OperatorId>sample string 1</OperatorId>
      <POSGroup>sample string 4</POSGroup>
      <StoreId>sample string 2</StoreId>
      <TerminalId>sample string 3</TerminalId>
    </Header>
    <LoyaltyOrderID>sample string 1</LoyaltyOrderID>
    <ShortCode>sample string 2</ShortCode>
  </POSLoyaltyVoidOrderRequest>
</VoidOrderRequestModel>

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

Response Information

Resource Description

A simulated voidOrder response.

VoidOrderResponseModel

Name	Description	Type	Additional information
voidOrderResult	A successful response is indicated by the return of a successful request status.	VoidOrderResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "voidOrderResult": {
    "statusCode": 1,
    "resultDescription": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<VoidOrderResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <POSLoyaltyVoidOrderResponse>
    <ResultDescription>sample string 2</ResultDescription>
    <StatusCode>1</StatusCode>
  </POSLoyaltyVoidOrderResponse>
</VoidOrderResponseModel>