Overview
The node provides integration with NetSuite's REST API to perform various record-related operations. Specifically, the "List Records" operation retrieves multiple records of a specified type from NetSuite, optionally filtered by a query, and supports pagination through limit and offset parameters.
This node is beneficial when you want to automate data retrieval from NetSuite for reporting, synchronization with other systems, or bulk processing of records. For example, you could use it to list all sales orders within a date range, fetch customer records for marketing campaigns, or extract inventory items for stock analysis.
Properties
| Name | Meaning |
|---|---|
| Record Type | The type of NetSuite record to retrieve. Options include Assembly Item, Billing Account, Calendar Event, Cash Sale, Charge, Classification (BETA), Contact, Customer, Invoice, Sales Order, Vendor, and many others including Custom Record (requires Script ID). |
| Custom Record Script ID | Required if "Record Type" is set to Custom Record. This is the internal identifier of the custom record type, usually starting with "customrecord". |
| Query | Optional SuiteQL-like query string to filter or customize the records returned. |
| Return All | Boolean flag indicating whether to return all matching records or limit the number of results. |
| Limit | Maximum number of records to return if "Return All" is false. Value between 1 and 1000. Default is 100. |
| Offset | Number of records to skip before starting to return results, used for pagination. Default is 0. |
| API Version | The version of the NetSuite REST API to use. Currently only "v1" is supported. |
| Options | Additional options: - Concurrency: Maximum number of simultaneous REST requests sent to NetSuite (default 1). - Full Response: Whether to return the full HTTP response instead of just the body. |
Output
The output is an array of JSON objects representing the retrieved NetSuite records. Each item corresponds to one record and contains its fields as key-value pairs.
- If "Full Response" option is enabled, the output includes the full HTTP response details such as status code and headers.
- Pagination is handled internally; if "Return All" is true, the node will paginate through all available records.
- No binary data output is produced by this operation.
Dependencies
- Requires valid NetSuite API credentials with appropriate permissions to access the requested record types.
- Uses the NetSuite REST API endpoint corresponding to the selected API version.
- Supports concurrency control via the "Concurrency" option to manage request load.
- Requires n8n environment configured with these credentials and network access to NetSuite services.
Troubleshooting
- Common issues:
- Invalid or missing credentials will cause authentication failures.
- Specifying a custom record type without providing the correct Script ID will result in errors.
- Exceeding API rate limits may cause request throttling or failures.
- Incorrect query syntax can lead to empty results or errors.
- Error messages:
- Errors from NetSuite are parsed and surfaced with descriptive messages.
- If "Continue On Fail" is disabled, the node execution stops on first error.
- To resolve errors, verify credentials, record type names, query correctness, and API limits.