In this article
Table of Contents | ||||
---|---|---|---|---|
|
...
Info | ||
---|---|---|
| ||
|
...
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| You must pass Order ID and refund ID to get the specific order refund. Upstream Snap is optional. |
Output | Document |
|
| The order refund ID. |
...
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. DefaultValue: Get Order Refund |
Version* | N/A | Specify the Shopify API version. Alternatively, click the Suggestion icon to fetch the list of Shopify API versions. DefaultValue: 2021-07 |
Order Id* | N/A | Specify a unique identifier for the order. DefaultValue: N/A |
Resource Id | N/A | Specify a unique identifier for the refund. DefaultValue: N/A |
Parameters | Use this field set to define object parameters ad their values. This field set contains the following fields:
| |
Parameter | N/A | Specify a query parameter. DefaultValue: N/A |
Parameter value | N/A | Specify a value for the parameter. DefaultValue: 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. DefaultValue: 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. DefaultValue: 1 |
Snap Execution | N/A | Select one of the three modes in which the Snap executes. Available options are:
DefaultValue: Validate & Execute |
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Example
Getting A Specific Order Refund
This is a simple example of a stand-alone Pipeline that demonstrates how we can get details of a specific order refund. This example assumes that you have configured a valid Shopify account to be used with this Snap.
We configure the Get Order Refund Snap to fetch the order refund details bearing the Order Id 3993490194622 and Resource Id 813559251134.
Upon validation, the Snap gets the order refund data associated with the order.
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
...