On this Page
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Snap type: | Read | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
Description: | This Snap provides the ability to search records of an object in NetSuite by providing criteria. The criteria fields that can be set on the object are provided on the input view of the Snap and can be mapped using an upstream Mapper or Structure Snap.
| |||||||||
| Prerequisites: | [None] | |||||||||
| Support and limitations: |
| |||||||||
| Account: | This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See NetSuite Account for information on setting up this type of account.
| |||||||||
| Views: |
| |||||||||
Settings | ||||||||||
Label | Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. | |||||||||
Object | Required. The NetSuite Object type to update. For example, to search for records of a custom record type, select Custom Record from the available options.
| |||||||||
Custom record | Conditional. Custom record type to search. This is applicable and required only if Custom Record is selected for Object. | |||||||||
Body fields only | If selected, NetSuite returns only the most important fields of each record. If these fields are sufficient, leave this checked. Clear this only if you need the sublists of each record, such as a Customer's addresses, or computed fields, such as a Customer's Balance. This may negatively impact the time required to perform the search and substantially increase the size of the output. When clearing this option, it is strongly recommended to reduce the Page Size. | |||||||||
Advanced | If selected, performs an advanced search, which enables you to execute a saved search using its ID & search for relevant records in it. | |||||||||
Return search column | Conditional. If selected, returns only the values for the required columns. This is applicable only when performing an Advanced search, which is used to execute a saved search. If not selected, this returns all the record details.
Default value: Selected | |||||||||
Page size | Maximum number of results to return per page. This Snap will automatically make multiple service requests to retrieve all available pages. You should consider setting this to a smaller value to reduce memory usage, especially when Body Fields Only is not selected, which can substantially increase the size of each page, depending on the Object type. Min value: 5 Max value: 1000 | |||||||||
Request timeout | Required. The timeout for the web service call (in seconds). 0 indicates no timeout. Example: 0 | |||||||||
Maximum request attempts | Required. Specifies the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response. Default value: 3 | |||||||||
Retry request interval | Required. Specifies the interval (in seconds) between two successive requests. A retry happens only when the previous attempt resulted in an exception. Default value: 2 | |||||||||
Snap execution Default Value: Execute only | Select one of the following three modes in which the Snap executes:
| |||||||||
Troubleshooting
| multiexcerpt-include-macro | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Examples
Using the NetSuite Search Snap to Retrieve Customer Records
In this example, you search for and retrieve a list of customer records that have a "balance" greater than 10000. You then preview the Total Records and their status.
| Expand | ||
|---|---|---|
| ||
In this pipeline:
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|