On this Page

Snap type:

Read


Description:

This Snap retrieves the inventory availability for a given list of items. You can also filter the returned list using Last quantity available change option. If set, this Snap returns only items with quantity available changes recorded as of the specified date. 


  • Expected upstream Snaps: Any Snap that provides a document output view, such as Mapper or Structure or a JSON Generator Snap.
  • Expected downstream Snaps: Any Snap that has a document input view, such as Filter or Mapper or JSON Formatter.
  • Expected input: This Snap provides a schema on its input view for the selected object that can then be used in a Mapper Snap to map the required fields. 
  • Expected output: This Snap provides the result of the get operation for each record on the output view. Errors can be routed to the error view if enabled or cause the Snap to fail during execution.


Prerequisites:

[None]


Support and limitations:Works in Ultra Task Pipelines.
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:


InputThis Snap has exactly one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.


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.

Batch size


Required. The maximum number of item references to send in a single request. Set it to 1 to make a separate request for each input document. 

 Default value: 100

Last quantity available change


When specified, returns only items with quantity available changes recorded as of the specified Date/Time. This should be either an expression that evaluates to a Date/Time, or an expression or literal with a String value in ISO8601 format. 

If Batch size is greater than 1 and this field is an expression, quantity available change will only be evaluated against the very first document in the batch and that value will be sent with every request. If Batch size is 1 and this field is an expression, quantity available change will be evaluated against every document.

Default value: 3

Request timeout


Required. Specifies the timeout (in seconds) for the web service call. Set this to 0 to indicate no timeout. 

Default value: 0 (no timeout)

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
Example: Validate & Execute

Select one of the following three modes in which the Snap executes:

  • 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.

Troubleshooting

Example

The following example illustrates the usage of NetSuite Get Item Availability Snap. In this example pipeline, NetSuite Get Item Availability Snap retrieves a record based on a specified Last quantity available change filter condition.

 

In the pipeline execution:

  1. Mapper Snap maps the record detail(s) to the input fields of NetSuite Get Item Availability Snap:
  2. NetSuite Get Item Availability Snap retrieves the record details:

    The Snap filters the data based on the specified last quantity available date/time. The following is the data preview: