Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 refund ID to get the specific order refund. Upstream Snap is optional.

Output

Document

  • Min:1
  • Max:1
  • Get Orders
  • Mapper

The order refund 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.

DefaultValueGet Order Refund
ExampleGet Order Refund_300

Version*N/A

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

DefaultValue2021-07
Example: 2021-04

Order Id*N/A

Specify a unique identifier for the order.

DefaultValue: N/A
Example: 988

Resource IdN/A

Specify a unique identifier for the refund.

DefaultValue: N/A
Example: res_id

Parameters

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

  • Parameter
  • Parameter value
ParameterN/A

Specify a query parameter.

DefaultValue: N/A
Example: limit

Parameter valueN/A

Specify a value for the parameter.

DefaultValue: N/A
Example:5

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.

DefaultValue1
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.

DefaultValue1
Example: 2

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.

DefaultValueValidate & Execute
Example: Execute only

Excerpt Include
Create Order
Create Order
nopaneltrue

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.

Image Added

We configure the Get Order Refund Snap to fetch the order refund details bearing the Order Id 3993490194622 and Resource Id 813559251134.
Image Added

Upon validation, the Snap gets the order refund data associated with the order.
Image Added

Excerpt Include
Shopify Snap Pack
Shopify Snap Pack
nopaneltrue

...