In this article

Overview

You can use this Snap to fetch the list of all order risks or a specific risk of an order.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations

This Snap does not get the count of orders.

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 order id and risk ID to fetch a specific risk record. Upstream Snap is optional.

Output

Document

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

Retrieves the list of order risks or a single order risk by its ID.

Snap Settings


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 Value: Get Order Risk
Example: Ord_254

Version*N/A

Specify the Shopify API version. Alternatively, click the Suggestion  icon to fetch the list of supported Shopify API versions and select a version. 

Default Value: 2021-07
Example: 2021-04

Order Id*N/ASpecify a unique identifier for the order.

Default Value: N/A
Example: Ord_id

Resource IdN/ASpecify a unique identifier of the order risk.

Default Value: N/A
Example: Res_id

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 Specific Order Risk

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

We configure the Get Order Risk Snap to fetch the order risk details of the Order Id 4023839555764 and Resource Id 619654323188.

Upon validation, the Snap gets the order risk details associated with the order.


See Also