In this article

Overview

You can use this Snap to fetch the list of customer records or a specific customer record by passing the customer 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
  • Copy
You must pass resource ID to get a specific customer record. Upstream Snap is optional.
Output

Document

  • Min:1
  • Max:1
  • Order Fulfillment
  • Order Operations
  • Order Refund

List of customer records or a specific customer record.

Snap Settings

Field NameField DependencyDescription
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 Customers
Example: Get_Platinum_Customers
Version*N/A


Specify the Shopify API version. Alternatively, click the Suggestion  icon to fetch the list of Shopify API versions. 
The schema is static and is captured from the 2021-04 version of Shopify. See Shopify REST APIs for more information.

Default Value: 2021-07
Example: 2021-04


Resource IdN/A

Specify the ID of the customer resource ID to fetch a specific record.

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

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: 2

Snap Execution

N/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 Specific Customer

This is a simple example of a stand-alone Pipeline that demonstrates how we can get details of a specific customer. This example assumes that you have configured a valid Shopify account to be used with this Snap. 

We configure the Get Customers Snap to fetch the customer details bearing the Resource ID, 5394320261300. 

Upon validation, the Snap gets the customer details associated with the Resource Id as follows. 


See Also