NetSuite SuiteTalk icon

NetSuite SuiteTalk

NetSuite REST API

Batch Get Records

AI-generated

Summary

Retrieve multiple NetSuite records concurrently using batch jobs, providing the record IDs as input and optionally controlling returned fields and sub-resources.

Inputs

  • Record Type (required) — Select the type of NetSuite records to retrieve (e.g., salesOrder, customer, invoice). Use the 'Custom Record Script ID' if 'Custom Record' is selected.
  • Custom Record Script ID (required) — Specify the internal identifier of the custom record type (starting with 'customrecord.') when the selected record type is 'Custom Record'.
  • ID (Per Item) (required) — Provide the record identifier for each input item. This field supports expressions, and can use internal IDs or external IDs prefixed with 'eid:'. Each input item should have its own unique ID.
  • Restrict Returned Fields — Optionally specify which fields and sublists to return for each record to reduce response size.
  • Expand Sub-Resources (required) — Set whether to automatically expand all sublists, sublist lines, and subrecords on the returned records.
  • Batch Options — Configure batch job options such as Idempotency Key to avoid duplicate processing, enabling parallel processing of batch items, poll interval for job status checks, and timeout for batch job completion.
  • Options — Additional options including returning the full raw response data and setting the maximum number of retry attempts on rate limit or server errors.

Output shape

a list of records corresponding to the batch of requested IDs, each with success status and record data if successful

The operation handles input items in batches of up to 100 IDs per job. If 'Wait For Results' is enabled (always true for this operation), the node waits for completion and returns each record individually with its success status. If fetching fails, an error message is included for that item.

Links

Discussion