POST api/v7/TransactionLookups/VoidTransaction

Checks the specified transaction to see if it can be voided

Request Information

URI Parameters

None.

Body Parameters

The void request message

LookupRequest
NameDescriptionTypeRequired?Additional information
MessageContent

string

No

None.
MessageType

string

No

None.
Request

RetrieveTransactionRequest

No

None.

Request Formats

application/json, text/json

Sample: 
{
  "MessageContent": "sample string 1",
  "MessageType": "sample string 2",
  "Request": {
    "Terminal": "sample string 1",
    "Operator": "sample string 2",
    "Store": "sample string 3",
    "TimeStamp": "sample string 4",
    "TrainingModeFlag": 0,
    "LockTimeout": 5,
    "MemberID": "sample string 6",
    "AccountNumber": "sample string 7",
    "Telephone": "sample string 8",
    "AssociateID": "sample string 9",
    "SerialNumber": "sample string 10",
    "OrderNumber": "sample string 11",
    "Transactions": [
      {
        "RequestType": "sample string 1",
        "RetailStoreID": "sample string 2",
        "BusinessUnit": {
          "UnitID": {
            "TypeCode": "sample string 1",
            "Name": "sample string 2"
          }
        },
        "WorkstationID": "sample string 3",
        "SequenceNumber": 4,
        "BusinessDayDate": "sample string 5"
      },
      {
        "RequestType": "sample string 1",
        "RetailStoreID": "sample string 2",
        "BusinessUnit": {
          "UnitID": {
            "TypeCode": "sample string 1",
            "Name": "sample string 2"
          }
        },
        "WorkstationID": "sample string 3",
        "SequenceNumber": 4,
        "BusinessDayDate": "sample string 5"
      }
    ],
    "Item": {
      "ItemID": "sample string 1",
      "ItemType": "sample string 2",
      "SequenceNumber": "sample string 3",
      "Quantity": "sample string 4"
    },
    "UnitPrice": "sample string 12",
    "TransactionOrder": 0,
    "ItemPriceOrder": 0,
    "OrderPriority": 0,
    "AllowedLocations": [
      "sample string 1",
      "sample string 2"
    ],
    "DisallowedLocations": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample: 
<Lookup xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" content="sample string 1" type="sample string 2">
  <RequestData Terminal="sample string 1" Operator="sample string 2" Store="sample string 3" TimeStamp="sample string 4" TrainingModeFlag="False">
    <LockTimeout>5</LockTimeout>
    <MemberID>sample string 6</MemberID>
    <AccountNumber>sample string 7</AccountNumber>
    <Telephone>sample string 8</Telephone>
    <AssociateID>sample string 9</AssociateID>
    <SerialNumber>sample string 10</SerialNumber>
    <OrderNumber>sample string 11</OrderNumber>
    <Transaction>
      <RequestType>sample string 1</RequestType>
      <RetailStoreID>sample string 2</RetailStoreID>
      <BusinessUnit>
        <UnitID TypeCode="sample string 1" Name="sample string 2" />
      </BusinessUnit>
      <WorkstationID>sample string 3</WorkstationID>
      <SequenceNumber>4</SequenceNumber>
      <BusinessDayDate>sample string 5</BusinessDayDate>
    </Transaction>
    <Transaction>
      <RequestType>sample string 1</RequestType>
      <RetailStoreID>sample string 2</RetailStoreID>
      <BusinessUnit>
        <UnitID TypeCode="sample string 1" Name="sample string 2" />
      </BusinessUnit>
      <WorkstationID>sample string 3</WorkstationID>
      <SequenceNumber>4</SequenceNumber>
      <BusinessDayDate>sample string 5</BusinessDayDate>
    </Transaction>
    <ItemID Type="sample string 2" SequenceNumber="sample string 3" Quantity="sample string 4">sample string 1</ItemID>
    <UnitPrice>sample string 12</UnitPrice>
    <TranOrderParameter>Oldest</TranOrderParameter>
    <ItemPriceOrderParameter>Highest</ItemPriceOrderParameter>
    <OrderPriorityParameter>Transaction</OrderPriorityParameter>
    <AllowedLocations>
      <Location>sample string 1</Location>
      <Location>sample string 2</Location>
    </AllowedLocations>
    <DisallowedLocations>
      <Location>sample string 1</Location>
      <Location>sample string 2</Location>
    </DisallowedLocations>
  </RequestData>
</Lookup>

Response Information

Resource Description

A success or error message indicating whether the transaction can be voided

HttpResponseMessage
NameDescriptionType
Version

Version
Content

HttpContent
StatusCode

HttpStatusCode
ReasonPhrase

string
Headers

Collection of Object
RequestMessage

HttpRequestMessage
IsSuccessStatusCode

boolean