Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Method returns a list of retail transactions that match the passed in criteria.
Syntax
client server public static container searchOrderList(
RetailTransactionId _transactionId,
SalesId _salesId,
RetailReceiptId _receiptId,
RetailOrderChannelReferenceId _channelRefId,
CustAccount _custAccount,
str _custFirstName,
str _custLastName,
RetailStoreId _storeId,
RetailTerminalId _terminalId,
RetailItemId _itemId,
RetailBarcode _barcode,
RetailStaffId _staffId,
str _startDate,
str _endDate,
boolean _includeDetails,
[RetailReceiptEmail _receiptEmailAddress,
String50 _seachIdentifiers,
int _resultsMaxCount,
str _retailTransactionTypes,
InventSerialId _serialNumber,
str _transactionStatusTypes])
Run On
Called
Parameters
- _transactionId
Type: RetailTransactionId Extended Data Type
TransactionID to match against the RetailTransactionTable.TransactionId field.
- _salesId
Type: SalesId Extended Data Type
SalesID to match against the SalesTable.SalesId field.
- _receiptId
Type: RetailReceiptId Extended Data Type
ReceiptID to match against the RetailTransactionTable.ReceiptId field.
- _channelRefId
Type: RetailOrderChannelReferenceId Extended Data Type
Channel Reference ID to match against the SalesOrder.ChannelReferenceId field.
- _custAccount
Type: CustAccount Extended Data Type
Customer Account Number to match against the RetailTransactionTable.CustAccount field.
- _custFirstName
Type: str
First name of customer who is linked to the RetailTransactionTable.
- _custLastName
Type: str
Last name of customer who is linked to the RetailTransactionTable.
- _storeId
Type: RetailStoreId Extended Data Type
StoreId to match against the RetailTransactionTable.Store field.
- _terminalId
Type: RetailTerminalId Extended Data Type
TerminalId to match against the RetailTransactionTable.Terminal field.
- _itemId
Type: RetailItemId Extended Data Type
ItemId to match against the RetailTransactionSalesTrans.ItemId field.
- _barcode
Type: RetailBarcode Extended Data Type
Barcode to match against the RetailTransactionSalesTrans.Barcode field.
- _staffId
Type: RetailStaffId Extended Data Type
StaffId to match against the RetailTransactionTable.Staff field.
- _startDate
Type: str
RetailTransactionTable.CreatedDateTime field greater than or equal to startDate.
- _endDate
Type: str
RetailTransactionTable.CreatedDateTime field less than or equal to endDate.
- _includeDetails
Type: boolean
Whether to include all order information including order lines and attributes.
- _receiptEmailAddress
Type: RetailReceiptEmail Extended Data Type
ReceiptEmailAddress to match against the RetailTransactionTable.ReceiptEmail field.
- _seachIdentifiers
Type: String50 Extended Data Type
SeachIdentifiers to math against the RetailTransactionTable with the following fields TransactionId ReceiptId SalesId CustomerAccount ChannelRefId
- _resultsMaxCount
Type: int
The maximum amount of rows to return (default is 20).
- _retailTransactionTypes
Type: str
Transaction types to be returned.
- _serialNumber
Type: InventSerialId Extended Data Type
SerialNumber to match against the RetailTransactionSalesTrans.InventSerialId field.
- _transactionStatusTypes
Type: str
Transaction's entry status to match against the RetailTransactionTable.EntryStatus field.
Return Value
Type: container
A list of orders that match all of the criteria parameters.