In this article
Table of Contents | ||||
---|---|---|---|---|
|
...
You can use this Snap to create an order risk for an existing order.
Prerequisites
None.
...
Works in Ultra Pipelines.
Limitations
...
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Known Issues
None.
Snap Input and Output
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| The ID of the order that the order risk belongs to. |
Output | Document |
|
| Creates an order risk for an order. |
...
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 Snaps Snap in your pipelinePipeline. Default Value: N/ACreate 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-0407 Example: 2021-04 |
Order Id* | N/A | Specify a unique identifier for the order. Default Value: N/A |
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 |
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 |
Snap Execution | N/A | Select one of the three modes in which the Snap executes. Available options are:
Default Value: Execute only |
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
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 Data | Order 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 Settings | Create 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 Settings | Create Order Risk Output |
---|---|
Attachments | ||
---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
...