NetSuite REST Read


You can use this Snap to read records based on the Record ID.

NetSuite REST Read Overview




  • The Snap initially takes more time to populate suggestions, but from the second call onwards, it fetches data from the cache, which refreshes every 60 minutes. Additionally, any updates to the metadata may take up to an hour to be reflected.
  • If you enable the expression for Record type, the Output fields suggestion does not work as expected.

    Workaround: To address this issue, consider the following workarounds:
    • Provide a value for Record type using suggestions.
    • Hard code the static string to enable the use of Output fields suggestions.

Known Issues

  • The Snap does not display errors for invalid columns in the Output fields property because the NetSuite API ignores the fields that are not part of the schema.

Snap Views

View Description Examples of Upstream and Downstream Snaps
Input This Snap has at the most one document input view. The entity from which you want to read the objects. Mapper
Output This Snap has at the most one document output view. This Snap displays records from the specified entity. Mapper

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when the Snap encounters an error.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
  • Add icon (): Indicates that you can add fields in the field set.
  • Remove icon (): Indicates that you can remove fields from the field set.
Field / Field Set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if there are more than one of the same Snap in the pipeline.

Default value: NetSuite REST Read

Example: Execute company names list
Record type String/Expression/Suggestion

Required. Specify the data entity or object the Snap should interact with using the NetSuite REST API.

Default: N/A

Example: account

Record ID String/Expression

Required. Specify the Record ID (the internal identifier of the NetSuite record).

Default: N/A

Example: 931

Output fields

Use this fieldset to specify the names of the fields and sublists on the record you want to retrieve.

Field String/Expression/Suggestion

Specify the names of the fields and sub-fields you want to retrieve.

Default: N/A

Example: companyName, email, firstName

Timeout options Specify the properties related to the timeout connections.
Read timeout (seconds) Integer/Expression

Specify the number of seconds the Snap must wait before it terminates the request because of a failure to receive data from the target service.

Default value: 60

Example: 500

Connection timeout (seconds) Integer/Expression

Specify the number of seconds the Snap must wait before it terminates the request because of a failure to establish a connection to the target endpoint or service.

Default value: 30

Example: 1000

Retry settings Specify the properties for handling retry during failures.
Retry on Dropdown list
Select the the condition to retry the request. Available options include:
  • Client errors (4xx): Retry the operation if there are network or connectivity issues.
  • Server errors (5xx): Retry for connection problems or when the server returns an internal server error (HTTP status codes 5xx).
  • Client and server errors (4xx, 5xx): Retry if there are connection issues or if the request is unauthorized (HTTP status codes 4xx or 5xx).

Default value: Server errors (5xx)

Example: Client and server errors (4xx, 5xx)

Maximum attempts Integer/Expression

Specify the maximum number of retry attempts in case of failure.

Default value: 5

Example: 10

Retry interval (seconds) Integer/Expression

Specify the intervals between each retry.

Default value: 3

Example: 15

Snap Execution Dropdown list Select one of the three modes in which the Snap executes.
Available options are:
  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps that are downstream from it.