In this article

Overview

You can use this Snap to fetch list of products or a specific product using Resource Id.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations

Known Issues

None.

Snap Input and Output


Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document


  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
You must pass the product ID. Upstream Snap is optional.
Output

Document

  • Min:1
  • Max:1
  • JSON Formatter
  • CSV Formatter

A list of products or a specific product.

Snap Settings


Parameter
Data Type
Description
Label*N/A

Specify the name for the Snap. You can modify the default name to be specific and meaningful, especially if you have more than one of the same Snap in your Pipeline.

Default Value: Get Products
Example: Electronics

Version*N/A
Default Value: 2021-07
Example: 2021-04
Resource Id*N/A

Specify a unique identifier for the product.

Default Value: N/A
Example: res_id

Parameters

Use this field set to define object parameters ad their values. This field set contains the following fields:

  • Parameter
  • Parameter value
ParameterN/A

Specify an optional parameter for the product variant.

Default Value: N/A
Example: limit

Parameter valueN/A

Specify a value for the parameter.

Default Value: N/A
Example: 5

Number Of RetriesN/A

Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.

Default Value: 1
Example: 2

Retry Interval (Seconds)N/A

Specify the duration in seconds for which the Snap must wait between two reconnection attempts, until the number of retries is reached.

Default Value: 1
Example: 5

Snap ExecutionN/A

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.

Default Value: Validate & Execute
Example: Execute only


Example

Getting A List Of Products

This example Pipeline demonstrates how we can get a list of products from the store. The example assumes that you have configured a valid Shopify account to be used with this Snap. 

We configure the following Get Products Snap to fetch all the products and their details. We leave the Resource ID blank, to enable the Snap to get all the products. 

Upon validation, we see the list of products in the output preview of the Snap.

See Also