Get Customers

Get Customers

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/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

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 Name

Field Dependency

Description

Field Name

Field Dependency

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 ValueGet Customers
ExampleGet_Platinum_Customers

Version*

N/A

Resource Id

N/A

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

Default Value: N/A
Exampleres_id

Parameters

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

  • Parameter

  • Parameter value

Parameter

N/A

Specify an optional parameter for the customer.

Default Value: N/A
Example: limit

Parameter value

N/A

Specify a value for the parameter.

Default Value: N/A
Example: 5

Number Of Retries

N/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
ExampleExecute only

 

Example

Getting A Specific Customer