POST api/v8/TransactionSearch/Search

Searches transactions based on the provided filters.

Request Information

URI Parameters

None.

Body Parameters

Contains the different filters that will be used to search for transactions.

TransactionSearchFilters
NameDescriptionTypeRequired?Additional information
StoreId

string

No

None.
TransactionTypeIds

Collection of integer

No

None.
TenderTypeIds

Collection of integer

No

None.
StartDate

string

No

None.
EndDate

string

No

None.
StartTime

string

No

None.
EndTime

string

No

None.
TerminalNumberFrom

integer

No

None.
TerminalNumberTo

integer

No

None.
AssociateIdFrom

string

No

None.
AssociateIdTo

string

No

None.
TenderAmountFrom

decimal number

No

None.
TenderAmountTo

decimal number

No

None.
TransactionTotalFrom

decimal number

No

None.
TransactionTotalTo

decimal number

No

None.
CustomerIdFrom

CustomerIdFrom number to search - This is going to be absolute, use CustomerID property instead

 integer

No

None.
CustomerIdTo

CustomerIdTo number to search - This is going to be absolute, use CustomerID property instead

 integer

No

None.
CustomerId

Get or set the customer loyatly Id to wildcard search

 string

No

None.
TrainingMode

boolean

No

None.
PageNumber

Gets or sets the page number of the results returned.

 integer

No

None.
PageSize

Gets or sets the size of results returned.

 integer

No

None.

Request Formats

application/json, text/json

Sample: 
{
  "StoreId": "sample string 1",
  "TransactionTypeIds": [
    1,
    2
  ],
  "TenderTypeIds": [
    1,
    2
  ],
  "StartDate": "sample string 2",
  "EndDate": "sample string 3",
  "StartTime": "sample string 4",
  "EndTime": "sample string 5",
  "TerminalNumberFrom": 1,
  "TerminalNumberTo": 1,
  "AssociateIdFrom": "sample string 6",
  "AssociateIdTo": "sample string 7",
  "TenderAmountFrom": 1.0,
  "TenderAmountTo": 1.0,
  "TransactionTotalFrom": 1.0,
  "TransactionTotalTo": 1.0,
  "CustomerIdFrom": 1,
  "CustomerIdTo": 1,
  "CustomerId": "sample string 8",
  "TrainingMode": true,
  "PageNumber": 1,
  "PageSize": 1
}

application/xml, text/xml

Sample: 
<TransactionSearchFilters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StoreId>sample string 1</StoreId>
  <TransactionTypeIds>
    <int>1</int>
    <int>2</int>
  </TransactionTypeIds>
  <TenderTypeIds>
    <int>1</int>
    <int>2</int>
  </TenderTypeIds>
  <StartDate>sample string 2</StartDate>
  <EndDate>sample string 3</EndDate>
  <StartTime>sample string 4</StartTime>
  <EndTime>sample string 5</EndTime>
  <TerminalNumberFrom>1</TerminalNumberFrom>
  <TerminalNumberTo>1</TerminalNumberTo>
  <AssociateIdFrom>sample string 6</AssociateIdFrom>
  <AssociateIdTo>sample string 7</AssociateIdTo>
  <TenderAmountFrom>1</TenderAmountFrom>
  <TenderAmountTo>1</TenderAmountTo>
  <TransactionTotalFrom>1</TransactionTotalFrom>
  <TransactionTotalTo>1</TransactionTotalTo>
  <CustomerId>sample string 8</CustomerId>
  <TrainingMode>true</TrainingMode>
  <PageNumber>1</PageNumber>
  <PageSize>1</PageSize>
</TransactionSearchFilters>

Response Information

Resource Description

Returns an array of transactions that matched the filters provided.

Collection of TransactionSearchResult
NameDescriptionType
TransactionId

Gets or sets the ID of this transaction.

 string
TransactionNumber

Gets or sets a readable identifier of this transaction.

 integer
ManagerOverride

string
Date

date
TerminalNumber

string
AssociateId

string
Total

decimal number
TransactionTypeId

integer
TransactionTypeDescription

string
StationID

string
TillID

string
CustomerID

string
StoreID

string
ItemCount

integer
TotalDiscountAmount

decimal number
IsSupervisorOverride

boolean
Canceled

boolean
Suspended

boolean
Resumed

boolean
TrainingMode

boolean
TaxAmount

decimal number
CardVoid

boolean
AgeVerification

boolean
ReceiptImage

Gets or sets the receipt image of this transaction.

 string
SupervisorOverrides

Gets or sets the collectioni of supervisor overrides in this transaction.

 Collection of SupervisorOverride
Items

Gets or sets the collection of items in this transaction.

Response Formats

application/json, text/json

Sample: 
[
  {
    "TransactionId": "sample string 1",
    "TransactionNumber": 2,
    "ManagerOverride": "sample string 3",
    "Date": "2018-01-01T00:00:00",
    "TerminalNumber": "sample string 5",
    "AssociateId": "sample string 6",
    "Total": 7.0,
    "TransactionTypeId": 8,
    "TransactionTypeDescription": "sample string 9",
    "StationID": "sample string 10",
    "TillID": "sample string 11",
    "CustomerID": "sample string 12",
    "StoreID": "sample string 13",
    "ItemCount": 1,
    "TotalDiscountAmount": 1.0,
    "IsSupervisorOverride": true,
    "Canceled": true,
    "Suspended": true,
    "Resumed": true,
    "TrainingMode": true,
    "TaxAmount": 1.0,
    "CardVoid": true,
    "AgeVerification": true,
    "ReceiptImage": "sample string 14",
    "SupervisorOverrides": [
      {
        "SequenceNumber": 1,
        "SupervisorId": "sample string 2"
      },
      {
        "SequenceNumber": 1,
        "SupervisorId": "sample string 2"
      }
    ],
    "Items": [
      {
        "SeqenceNumber": 1,
        "ItemId": "sample string 2",
        "ItemTypeId": 3,
        "ItemTypeDescription": "sample string 4",
        "Department": 1,
        "Description": "sample string 5",
        "Quantity": 6.0,
        "UnitPrice": 7.0,
        "Amount": 1.0,
        "DepartmentName": "sample string 8",
        "Units": 1.0,
        "UnitOfMeasure": "sample string 9"
      },
      {
        "SeqenceNumber": 1,
        "ItemId": "sample string 2",
        "ItemTypeId": 3,
        "ItemTypeDescription": "sample string 4",
        "Department": 1,
        "Description": "sample string 5",
        "Quantity": 6.0,
        "UnitPrice": 7.0,
        "Amount": 1.0,
        "DepartmentName": "sample string 8",
        "Units": 1.0,
        "UnitOfMeasure": "sample string 9"
      }
    ],
    "Discounts": [
      {
        "SequenceNumber": 1,
        "DiscountTypeId": 2,
        "DiscountTypeDescription": "sample string 3",
        "Amount": 4.0
      },
      {
        "SequenceNumber": 1,
        "DiscountTypeId": 2,
        "DiscountTypeDescription": "sample string 3",
        "Amount": 4.0
      }
    ],
    "Taxes": [
      {
        "SeqenceNumber": 1,
        "TaxTypeId": "sample string 2",
        "TaxTypeDescription": "sample string 3",
        "Amount": 4.0
      },
      {
        "SeqenceNumber": 1,
        "TaxTypeId": "sample string 2",
        "TaxTypeDescription": "sample string 3",
        "Amount": 4.0
      }
    ],
    "Tenders": [
      {
        "SequenceNumber": 1,
        "TenderTypeID": 2,
        "TenderTypeDescription": "sample string 3",
        "CheckNumber": 1,
        "AccountNumber": "sample string 4",
        "Amount": 5.0,
        "DomesticAmount": 1.0,
        "CardType": "sample string 6",
        "CreditDescription": "sample string 7",
        "Count": 1,
        "TenderChange": 1.0
      },
      {
        "SequenceNumber": 1,
        "TenderTypeID": 2,
        "TenderTypeDescription": "sample string 3",
        "CheckNumber": 1,
        "AccountNumber": "sample string 4",
        "Amount": 5.0,
        "DomesticAmount": 1.0,
        "CardType": "sample string 6",
        "CreditDescription": "sample string 7",
        "Count": 1,
        "TenderChange": 1.0
      }
    ],
    "DigitalSignatures": [
      {
        "SequenceNumber": 1,
        "SignatureData": "sample string 2"
      },
      {
        "SequenceNumber": 1,
        "SignatureData": "sample string 2"
      }
    ]
  },
  {
    "TransactionId": "sample string 1",
    "TransactionNumber": 2,
    "ManagerOverride": "sample string 3",
    "Date": "2018-01-01T00:00:00",
    "TerminalNumber": "sample string 5",
    "AssociateId": "sample string 6",
    "Total": 7.0,
    "TransactionTypeId": 8,
    "TransactionTypeDescription": "sample string 9",
    "StationID": "sample string 10",
    "TillID": "sample string 11",
    "CustomerID": "sample string 12",
    "StoreID": "sample string 13",
    "ItemCount": 1,
    "TotalDiscountAmount": 1.0,
    "IsSupervisorOverride": true,
    "Canceled": true,
    "Suspended": true,
    "Resumed": true,
    "TrainingMode": true,
    "TaxAmount": 1.0,
    "CardVoid": true,
    "AgeVerification": true,
    "ReceiptImage": "sample string 14",
    "SupervisorOverrides": [
      {
        "SequenceNumber": 1,
        "SupervisorId": "sample string 2"
      },
      {
        "SequenceNumber": 1,
        "SupervisorId": "sample string 2"
      }
    ],
    "Items": [
      {
        "SeqenceNumber": 1,
        "ItemId": "sample string 2",
        "ItemTypeId": 3,
        "ItemTypeDescription": "sample string 4",
        "Department": 1,
        "Description": "sample string 5",
        "Quantity": 6.0,
        "UnitPrice": 7.0,
        "Amount": 1.0,
        "DepartmentName": "sample string 8",
        "Units": 1.0,
        "UnitOfMeasure": "sample string 9"
      },
      {
        "SeqenceNumber": 1,
        "ItemId": "sample string 2",
        "ItemTypeId": 3,
        "ItemTypeDescription": "sample string 4",
        "Department": 1,
        "Description": "sample string 5",
        "Quantity": 6.0,
        "UnitPrice": 7.0,
        "Amount": 1.0,
        "DepartmentName": "sample string 8",
        "Units": 1.0,
        "UnitOfMeasure": "sample string 9"
      }
    ],
    "Discounts": [
      {
        "SequenceNumber": 1,
        "DiscountTypeId": 2,
        "DiscountTypeDescription": "sample string 3",
        "Amount": 4.0
      },
      {
        "SequenceNumber": 1,
        "DiscountTypeId": 2,
        "DiscountTypeDescription": "sample string 3",
        "Amount": 4.0
      }
    ],
    "Taxes": [
      {
        "SeqenceNumber": 1,
        "TaxTypeId": "sample string 2",
        "TaxTypeDescription": "sample string 3",
        "Amount": 4.0
      },
      {
        "SeqenceNumber": 1,
        "TaxTypeId": "sample string 2",
        "TaxTypeDescription": "sample string 3",
        "Amount": 4.0
      }
    ],
    "Tenders": [
      {
        "SequenceNumber": 1,
        "TenderTypeID": 2,
        "TenderTypeDescription": "sample string 3",
        "CheckNumber": 1,
        "AccountNumber": "sample string 4",
        "Amount": 5.0,
        "DomesticAmount": 1.0,
        "CardType": "sample string 6",
        "CreditDescription": "sample string 7",
        "Count": 1,
        "TenderChange": 1.0
      },
      {
        "SequenceNumber": 1,
        "TenderTypeID": 2,
        "TenderTypeDescription": "sample string 3",
        "CheckNumber": 1,
        "AccountNumber": "sample string 4",
        "Amount": 5.0,
        "DomesticAmount": 1.0,
        "CardType": "sample string 6",
        "CreditDescription": "sample string 7",
        "Count": 1,
        "TenderChange": 1.0
      }
    ],
    "DigitalSignatures": [
      {
        "SequenceNumber": 1,
        "SignatureData": "sample string 2"
      },
      {
        "SequenceNumber": 1,
        "SignatureData": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfTransactionSearchResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TransactionSearchResult>
    <TransactionId>sample string 1</TransactionId>
    <TransactionNumber>2</TransactionNumber>
    <ManagerOverride>sample string 3</ManagerOverride>
    <Date>2018-01-01T00:00:00</Date>
    <TerminalNumber>sample string 5</TerminalNumber>
    <AssociateId>sample string 6</AssociateId>
    <Total>7</Total>
    <TransactionTypeId>8</TransactionTypeId>
    <TransactionTypeDescription>sample string 9</TransactionTypeDescription>
    <StationID>sample string 10</StationID>
    <TillID>sample string 11</TillID>
    <CustomerID>sample string 12</CustomerID>
    <StoreID>sample string 13</StoreID>
    <ItemCount>1</ItemCount>
    <TotalDiscountAmount>1</TotalDiscountAmount>
    <IsSupervisorOverride>true</IsSupervisorOverride>
    <Canceled>true</Canceled>
    <Suspended>true</Suspended>
    <Resumed>true</Resumed>
    <TrainingMode>true</TrainingMode>
    <TaxAmount>1</TaxAmount>
    <CardVoid>true</CardVoid>
    <AgeVerification>true</AgeVerification>
    <ReceiptImage>sample string 14</ReceiptImage>
    <SupervisorOverrides>
      <SupervisorOverride>
        <SequenceNumber>1</SequenceNumber>
        <SupervisorId>sample string 2</SupervisorId>
      </SupervisorOverride>
      <SupervisorOverride>
        <SequenceNumber>1</SequenceNumber>
        <SupervisorId>sample string 2</SupervisorId>
      </SupervisorOverride>
    </SupervisorOverrides>
    <Items>
      <Item>
        <SeqenceNumber>1</SeqenceNumber>
        <ItemId>sample string 2</ItemId>
        <ItemTypeId>3</ItemTypeId>
        <ItemTypeDescription>sample string 4</ItemTypeDescription>
        <Department>1</Department>
        <Description>sample string 5</Description>
        <Quantity>6</Quantity>
        <UnitPrice>7</UnitPrice>
        <Amount>1</Amount>
        <DepartmentName>sample string 8</DepartmentName>
        <Units>1</Units>
        <UnitOfMeasure>sample string 9</UnitOfMeasure>
      </Item>
      <Item>
        <SeqenceNumber>1</SeqenceNumber>
        <ItemId>sample string 2</ItemId>
        <ItemTypeId>3</ItemTypeId>
        <ItemTypeDescription>sample string 4</ItemTypeDescription>
        <Department>1</Department>
        <Description>sample string 5</Description>
        <Quantity>6</Quantity>
        <UnitPrice>7</UnitPrice>
        <Amount>1</Amount>
        <DepartmentName>sample string 8</DepartmentName>
        <Units>1</Units>
        <UnitOfMeasure>sample string 9</UnitOfMeasure>
      </Item>
    </Items>
    <Discounts>
      <Discount>
        <SequenceNumber>1</SequenceNumber>
        <DiscountTypeId>2</DiscountTypeId>
        <DiscountTypeDescription>sample string 3</DiscountTypeDescription>
        <Amount>4</Amount>
      </Discount>
      <Discount>
        <SequenceNumber>1</SequenceNumber>
        <DiscountTypeId>2</DiscountTypeId>
        <DiscountTypeDescription>sample string 3</DiscountTypeDescription>
        <Amount>4</Amount>
      </Discount>
    </Discounts>
    <Taxes>
      <Tax>
        <SeqenceNumber>1</SeqenceNumber>
        <TaxTypeId>sample string 2</TaxTypeId>
        <TaxTypeDescription>sample string 3</TaxTypeDescription>
        <Amount>4</Amount>
      </Tax>
      <Tax>
        <SeqenceNumber>1</SeqenceNumber>
        <TaxTypeId>sample string 2</TaxTypeId>
        <TaxTypeDescription>sample string 3</TaxTypeDescription>
        <Amount>4</Amount>
      </Tax>
    </Taxes>
    <Tenders>
      <Tender>
        <SequenceNumber>1</SequenceNumber>
        <TenderTypeID>2</TenderTypeID>
        <TenderTypeDescription>sample string 3</TenderTypeDescription>
        <CheckNumber>1</CheckNumber>
        <AccountNumber>sample string 4</AccountNumber>
        <Amount>5</Amount>
        <DomesticAmount>1</DomesticAmount>
        <CardType>sample string 6</CardType>
        <CreditDescription>sample string 7</CreditDescription>
        <Count>1</Count>
        <TenderChange>1</TenderChange>
      </Tender>
      <Tender>
        <SequenceNumber>1</SequenceNumber>
        <TenderTypeID>2</TenderTypeID>
        <TenderTypeDescription>sample string 3</TenderTypeDescription>
        <CheckNumber>1</CheckNumber>
        <AccountNumber>sample string 4</AccountNumber>
        <Amount>5</Amount>
        <DomesticAmount>1</DomesticAmount>
        <CardType>sample string 6</CardType>
        <CreditDescription>sample string 7</CreditDescription>
        <Count>1</Count>
        <TenderChange>1</TenderChange>
      </Tender>
    </Tenders>
    <DigitalSignatures>
      <DigitalSignature>
        <SequenceNumber>1</SequenceNumber>
        <SignatureData>sample string 2</SignatureData>
      </DigitalSignature>
      <DigitalSignature>
        <SequenceNumber>1</SequenceNumber>
        <SignatureData>sample string 2</SignatureData>
      </DigitalSignature>
    </DigitalSignatures>
  </TransactionSearchResult>
  <TransactionSearchResult>
    <TransactionId>sample string 1</TransactionId>
    <TransactionNumber>2</TransactionNumber>
    <ManagerOverride>sample string 3</ManagerOverride>
    <Date>2018-01-01T00:00:00</Date>
    <TerminalNumber>sample string 5</TerminalNumber>
    <AssociateId>sample string 6</AssociateId>
    <Total>7</Total>
    <TransactionTypeId>8</TransactionTypeId>
    <TransactionTypeDescription>sample string 9</TransactionTypeDescription>
    <StationID>sample string 10</StationID>
    <TillID>sample string 11</TillID>
    <CustomerID>sample string 12</CustomerID>
    <StoreID>sample string 13</StoreID>
    <ItemCount>1</ItemCount>
    <TotalDiscountAmount>1</TotalDiscountAmount>
    <IsSupervisorOverride>true</IsSupervisorOverride>
    <Canceled>true</Canceled>
    <Suspended>true</Suspended>
    <Resumed>true</Resumed>
    <TrainingMode>true</TrainingMode>
    <TaxAmount>1</TaxAmount>
    <CardVoid>true</CardVoid>
    <AgeVerification>true</AgeVerification>
    <ReceiptImage>sample string 14</ReceiptImage>
    <SupervisorOverrides>
      <SupervisorOverride>
        <SequenceNumber>1</SequenceNumber>
        <SupervisorId>sample string 2</SupervisorId>
      </SupervisorOverride>
      <SupervisorOverride>
        <SequenceNumber>1</SequenceNumber>
        <SupervisorId>sample string 2</SupervisorId>
      </SupervisorOverride>
    </SupervisorOverrides>
    <Items>
      <Item>
        <SeqenceNumber>1</SeqenceNumber>
        <ItemId>sample string 2</ItemId>
        <ItemTypeId>3</ItemTypeId>
        <ItemTypeDescription>sample string 4</ItemTypeDescription>
        <Department>1</Department>
        <Description>sample string 5</Description>
        <Quantity>6</Quantity>
        <UnitPrice>7</UnitPrice>
        <Amount>1</Amount>
        <DepartmentName>sample string 8</DepartmentName>
        <Units>1</Units>
        <UnitOfMeasure>sample string 9</UnitOfMeasure>
      </Item>
      <Item>
        <SeqenceNumber>1</SeqenceNumber>
        <ItemId>sample string 2</ItemId>
        <ItemTypeId>3</ItemTypeId>
        <ItemTypeDescription>sample string 4</ItemTypeDescription>
        <Department>1</Department>
        <Description>sample string 5</Description>
        <Quantity>6</Quantity>
        <UnitPrice>7</UnitPrice>
        <Amount>1</Amount>
        <DepartmentName>sample string 8</DepartmentName>
        <Units>1</Units>
        <UnitOfMeasure>sample string 9</UnitOfMeasure>
      </Item>
    </Items>
    <Discounts>
      <Discount>
        <SequenceNumber>1</SequenceNumber>
        <DiscountTypeId>2</DiscountTypeId>
        <DiscountTypeDescription>sample string 3</DiscountTypeDescription>
        <Amount>4</Amount>
      </Discount>
      <Discount>
        <SequenceNumber>1</SequenceNumber>
        <DiscountTypeId>2</DiscountTypeId>
        <DiscountTypeDescription>sample string 3</DiscountTypeDescription>
        <Amount>4</Amount>
      </Discount>
    </Discounts>
    <Taxes>
      <Tax>
        <SeqenceNumber>1</SeqenceNumber>
        <TaxTypeId>sample string 2</TaxTypeId>
        <TaxTypeDescription>sample string 3</TaxTypeDescription>
        <Amount>4</Amount>
      </Tax>
      <Tax>
        <SeqenceNumber>1</SeqenceNumber>
        <TaxTypeId>sample string 2</TaxTypeId>
        <TaxTypeDescription>sample string 3</TaxTypeDescription>
        <Amount>4</Amount>
      </Tax>
    </Taxes>
    <Tenders>
      <Tender>
        <SequenceNumber>1</SequenceNumber>
        <TenderTypeID>2</TenderTypeID>
        <TenderTypeDescription>sample string 3</TenderTypeDescription>
        <CheckNumber>1</CheckNumber>
        <AccountNumber>sample string 4</AccountNumber>
        <Amount>5</Amount>
        <DomesticAmount>1</DomesticAmount>
        <CardType>sample string 6</CardType>
        <CreditDescription>sample string 7</CreditDescription>
        <Count>1</Count>
        <TenderChange>1</TenderChange>
      </Tender>
      <Tender>
        <SequenceNumber>1</SequenceNumber>
        <TenderTypeID>2</TenderTypeID>
        <TenderTypeDescription>sample string 3</TenderTypeDescription>
        <CheckNumber>1</CheckNumber>
        <AccountNumber>sample string 4</AccountNumber>
        <Amount>5</Amount>
        <DomesticAmount>1</DomesticAmount>
        <CardType>sample string 6</CardType>
        <CreditDescription>sample string 7</CreditDescription>
        <Count>1</Count>
        <TenderChange>1</TenderChange>
      </Tender>
    </Tenders>
    <DigitalSignatures>
      <DigitalSignature>
        <SequenceNumber>1</SequenceNumber>
        <SignatureData>sample string 2</SignatureData>
      </DigitalSignature>
      <DigitalSignature>
        <SequenceNumber>1</SequenceNumber>
        <SignatureData>sample string 2</SignatureData>
      </DigitalSignature>
    </DigitalSignatures>
  </TransactionSearchResult>
</ArrayOfTransactionSearchResult>