In this article

Overview

You can use this Snap to create an order risk for an existing order.

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:1
  • Max:1
  • Mapper
  • Copy
The ID of the order that the order risk belongs to.
Output

Document

  • Min:1
  • Max:1
  • Mapper
  • Create Order Refund
  • Order Operations

Creates an order risk for an order.

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: Create Order Risk
Example: Create Order Risk
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/A

Specify a unique identifier for the order.

Default Value: N/A
Example: Ord254

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


Example

Creating An Order Risk

This simple example Pipeline demonstrates how to create an order risk for an order. We must first create an order to create an order risk.

First, we configure the JSON Generator Snap to pass the order data as follows.

Order DataOrder Data Output


Next, we create an order with the order details from the upstream Snap—we configure the Create Order Snap as follows.

Create Order Snap SettingsCreate Order Snap Output

Next, we prepare an order risk for the order we just created using the Mapper Snap. To this end, we map the order risk details as highlighted in the image below.

Upon validation, we see the following output in the data preview of the Snap.

Next, we create an Order Risk for the order using the Create Order Risk Snap. We pass $id in the Order Id field. Upon validation, the Snap generates the order risk details for the given order as follows:

Create Order Risk SettingsCreate Order Risk Output

Download this Pipeline.



See Also