Description
This function searches for a list of product purchases matching a given search filter.
Style
Document
Input (Literal)
The input of this method is the argument listProductPurchases of type listProductPurchases having the structure defined by the following table.
Element |
Type |
Occurs |
Description |
|---|---|---|---|
searchFilter |
0..1 |
The filter to apply |
|
queryLimit |
0..1 |
The query limit to apply |
Output (Literal)
The output of this method is the argument listProductPurchasesResponse of type listProductPurchasesResponse having the structure defined by the following table.
Element |
Type |
Occurs |
Description |
listProductPurchases |
0..1 |
The list of matching product purchases |
Remarks
On an exception, no product purchases are returned.
The product purchases searched for are specified by the searchFilter and the queryLimit specified by the caller. For documentation on how the filter and query limit work, see the complex types searchFilter and queryLimit.
Each product purchase represents an instance of a customer subscribing to a product offer, potentially generating a stream of one or more unit transactions associated therewith. For more details, see the productPurchase complex type.