SearchParam
Used to create a unique search parameter.
Description
This object is used to create a search parameter for methods such as searchTransactions and searchCustomers.
It consists of three properties: the name of the field you are searching on, the type of comparison to make, and the value. Since each method uses a unique set of search parameters, check the documentation of each method for a list of valid field names. A complete list of all methods using this object can be found below.
Properties
Type | Name | Description |
---|---|---|
string | Field | Name of field you are searching. |
string | Type | Type of comparison to make. Options are: gt - greater than, lt - less than, eq - equals, contains - partial match |
string | Value | Value to search on |