POST api/v7/TransactionLookups/SearchTransaction

Perform a a transaction search based on supplied criteria, which returns transaction summaries of matching records. [Optional Header]: {PageSize} - Defines the number of records in one page. Along with PageIndex it can be used to retrieve a subset of data. If this parameter is not provided, system takes default page size. [Optional Header]: {PageIndex} - Defines which page would be retrieved from server. If this parameter is not provided, system pulls the first page with 'PageSize' set of records. Example: If PageIndex is 0 and PageSize is 50, the response is first 50 records. The body of the post contains the SearchTransactionRequest to be executed

Request Information

URI Parameters

None.

Body Parameters

The request DTO containing the search parameters.

SearchTransactionRequest
NameDescriptionTypeRequired?Additional information
MessageContent

string

No

None.
MessageType

string

No

None.
PageIndex

string

No

None.
PageSize

string

No

None.
TranSortOrder

string

No

None.
RequestData

SearchTransactionRequestData

No

None.

Request Formats

application/json, text/json

Sample: 
{
  "MessageContent": "sample string 1",
  "MessageType": "sample string 2",
  "PageIndex": "sample string 3",
  "PageSize": "sample string 4",
  "TranSortOrder": "sample string 5",
  "RequestData": {
    "TrainingModeFlag": 0,
    "Store": "sample string 1",
    "Operator": "sample string 2",
    "Terminal": "sample string 3",
    "OrderNumber": "sample string 4",
    "MemberID": "sample string 5",
    "AccountNumber": "sample string 6",
    "AssociateID": "sample string 7",
    "Telephone": "sample string 8",
    "ReceiptNumber": "sample string 9",
    "SerialNumber": "sample string 10",
    "ItemCode": "sample string 11",
    "FirstName": "sample string 12",
    "LastName": "sample string 13",
    "EmailAddress": "sample string 14",
    "StoreNumber": "sample string 15",
    "TerminalNumber": "sample string 16",
    "TransactionNumber": "sample string 17",
    "ReceiptDate": "sample string 18",
    "GiftRegistryID": "sample string 19",
    "Transaction": {
      "BeginDateTime": "2018-01-01T00:00:00",
      "EndDateTime": "2018-01-01T00:00:00"
    }
  }
}

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" pageIndex="sample string 3" pageSize="sample string 4" tranSortOrder="sample string 5">
  <RequestData TrainingModeFlag="False" Store="sample string 1" Operator="sample string 2" Terminal="sample string 3">
    <OrderNumber>sample string 4</OrderNumber>
    <MemberID>sample string 5</MemberID>
    <AccountNumber>sample string 6</AccountNumber>
    <AssociateID>sample string 7</AssociateID>
    <Telephone>sample string 8</Telephone>
    <ReceiptNumber>sample string 9</ReceiptNumber>
    <SerialNumber>sample string 10</SerialNumber>
    <ItemCode>sample string 11</ItemCode>
    <FirstName>sample string 12</FirstName>
    <LastName>sample string 13</LastName>
    <EmailAddress>sample string 14</EmailAddress>
    <StoreNumber>sample string 15</StoreNumber>
    <TerminalNumber>sample string 16</TerminalNumber>
    <TransactionNumber>sample string 17</TransactionNumber>
    <ReceiptDate>sample string 18</ReceiptDate>
    <GiftRegistryID>sample string 19</GiftRegistryID>
    <Transaction>
      <BeginDateTime>2018-01-01T00:00:00</BeginDateTime>
      <EndDateTime>2018-01-01T00:00:00</EndDateTime>
    </Transaction>
  </RequestData>
</Lookup>

Response Information

Resource Description

A response record.

SearchTransactionResponse
NameDescriptionType
TrXML

SearchTransactionTRXMLPaged

Response Formats

application/json, text/json

Sample: 
{
  "TrXML": {
    "NextPageAvailable": true,
    "Transactions": {
      "RetailTransactions": [
        {
          "RetailStoreID": "sample string 1",
          "RetailStoreName": "sample string 2",
          "WorkstationID": "sample string 3",
          "SequenceNumber": "sample string 4",
          "BusinessDayDate": "2018-01-01T00:00:00",
          "OriginalTransactionID": "sample string 6",
          "ReceiptNumber": "sample string 7",
          "OriginalTransactionTotal": "sample string 8",
          "OrderNumber": "sample string 9",
          "RetailTransactionType": "sample string 10",
          "MockedReceiptNumber": "sample string 11",
          "CustomerID": "sample string 12",
          "LocationCode": "sample string 13"
        },
        {
          "RetailStoreID": "sample string 1",
          "RetailStoreName": "sample string 2",
          "WorkstationID": "sample string 3",
          "SequenceNumber": "sample string 4",
          "BusinessDayDate": "2018-01-01T00:00:00",
          "OriginalTransactionID": "sample string 6",
          "ReceiptNumber": "sample string 7",
          "OriginalTransactionTotal": "sample string 8",
          "OrderNumber": "sample string 9",
          "RetailTransactionType": "sample string 10",
          "MockedReceiptNumber": "sample string 11",
          "CustomerID": "sample string 12",
          "LocationCode": "sample string 13"
        }
      ]
    },
    "Error": "sample string 2"
  }
}

application/xml, text/xml

Sample: 
<tl xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TR_XML nextPageAvailable="true">
    <Transactions>
      <RetailTransaction>
        <RetailStoreID>sample string 1</RetailStoreID>
        <RetailStoreName>sample string 2</RetailStoreName>
        <WorkstationID>sample string 3</WorkstationID>
        <SequenceNumber>sample string 4</SequenceNumber>
        <BusinessDayDate>2018-01-01T00:00:00</BusinessDayDate>
        <OriginalTransactionID>sample string 6</OriginalTransactionID>
        <ReceiptNumber>sample string 7</ReceiptNumber>
        <OriginalTransactionTotal>sample string 8</OriginalTransactionTotal>
        <OrderNumber>sample string 9</OrderNumber>
        <RetailTransactionType>sample string 10</RetailTransactionType>
        <MockedReceiptNumber>sample string 11</MockedReceiptNumber>
        <CustomerID>sample string 12</CustomerID>
        <LocationCode>sample string 13</LocationCode>
      </RetailTransaction>
      <RetailTransaction>
        <RetailStoreID>sample string 1</RetailStoreID>
        <RetailStoreName>sample string 2</RetailStoreName>
        <WorkstationID>sample string 3</WorkstationID>
        <SequenceNumber>sample string 4</SequenceNumber>
        <BusinessDayDate>2018-01-01T00:00:00</BusinessDayDate>
        <OriginalTransactionID>sample string 6</OriginalTransactionID>
        <ReceiptNumber>sample string 7</ReceiptNumber>
        <OriginalTransactionTotal>sample string 8</OriginalTransactionTotal>
        <OrderNumber>sample string 9</OrderNumber>
        <RetailTransactionType>sample string 10</RetailTransactionType>
        <MockedReceiptNumber>sample string 11</MockedReceiptNumber>
        <CustomerID>sample string 12</CustomerID>
        <LocationCode>sample string 13</LocationCode>
      </RetailTransaction>
    </Transactions>
    <Error>sample string 2</Error>
  </TR_XML>
</tl>