POST api/v7/TransactionLookups/CustomerTransaction

Perform a customer transaction lookup request using the provided customer and period and return the transaction overview information. The period can either be the last N transactions or days.

Request Information

URI Parameters

None.

Body Parameters

The customer transaction lookup request data

CustomerTransactionRequest
NameDescriptionTypeRequired?Additional information
MessageContent

string

No

None.
MessageType

string

No

None.
Request

CustomerTransactionRequestData

No

None.

Request Formats

application/json, text/json

Sample: 
{
  "MessageContent": "sample string 1",
  "MessageType": "sample string 2",
  "Request": {
    "TrainingModeFlag": 0,
    "CustomerID": "sample string 1",
    "LookupData": {
      "LookupType": 0,
      "Period": "sample string 1"
    }
  }
}

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 TrainingModeFlag="False">
    <CustomerID>sample string 1</CustomerID>
    <LastXLookup type="Days">sample string 1</LastXLookup>
  </RequestData>
</Lookup>

Response Information

Resource Description

The customer transaction data for the request message

CustomerTransactionResponse
NameDescriptionType
MessageContent

string
MessageType

string
Request

CustomerTransactionResponseRequestData
Response

CustomerTransactionResponseData

Response Formats

application/json, text/json

Sample: 
{
  "MessageContent": "sample string 1",
  "MessageType": "sample string 2",
  "Request": {
    "CustomerID": "sample string 1",
    "LookupData": {
      "LookupType": 0,
      "Period": "sample string 1"
    }
  },
  "Response": {
    "MemberJoinDate": "sample string 1",
    "Transactions": {
      "RetailTransactions": [
        {
          "TypeCode": "sample string 1",
          "OriginalTransactionID": "sample string 2",
          "CustomerID": "sample string 3",
          "EndDateTime": "2018-01-01T00:00:00",
          "ItemCount": 5,
          "Total": {
            "TotalType": "sample string 1",
            "Total": 2
          }
        },
        {
          "TypeCode": "sample string 1",
          "OriginalTransactionID": "sample string 2",
          "CustomerID": "sample string 3",
          "EndDateTime": "2018-01-01T00:00:00",
          "ItemCount": 5,
          "Total": {
            "TotalType": "sample string 1",
            "Total": 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>
    <CustomerID>sample string 1</CustomerID>
    <LastXLookup type="Days">sample string 1</LastXLookup>
  </RequestData>
  <ResponseData>
    <MemberJoinDate>sample string 1</MemberJoinDate>
    <Transactions>
      <RetailTransaction TypeCode="sample string 1">
        <OriginalTransactionID>sample string 2</OriginalTransactionID>
        <CustomerID>sample string 3</CustomerID>
        <EndDateTime>2018-01-01T00:00:00</EndDateTime>
        <ItemCount>5</ItemCount>
        <Total TotalType="sample string 1">2</Total>
      </RetailTransaction>
      <RetailTransaction TypeCode="sample string 1">
        <OriginalTransactionID>sample string 2</OriginalTransactionID>
        <CustomerID>sample string 3</CustomerID>
        <EndDateTime>2018-01-01T00:00:00</EndDateTime>
        <ItemCount>5</ItemCount>
        <Total TotalType="sample string 1">2</Total>
      </RetailTransaction>
    </Transactions>
  </ResponseData>
</Lookup>