/
Get Order Refund

Get Order Refund

May 08, 2024

In this article

Overview

You can use this Snap to fetch a list of refunds for an order or a specific refund of an order.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations

Shopify Behavior

  • When you create an order for a product, you cannot apply discount on a line item. If the associated discount application is of type code, the Snap returns the discount code that was entered at checkout. Else, the Snap returns the title of the discount that was applied. See 

    Discount APIs for more information.

  • This Snap gets data for non existing orders also.

  • This Snap does not get the count of orders.

  • Order discount is applied for invalid discount codes. The discount percentage or amount is allotted more than percentage/amount set for valid discount code. For example, summer20 is a valid discount code, which should apply 20% of discount. However, if we provide discount percentage as 50%, then it applies 50% discount ignoring the set discount percentage.

Known Issues

None.

Snap Input and Output

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

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

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
Example: Get Order Refund_300

Version*

N/A

Specify the Shopify API version. Alternatively, click the Suggestion 

 icon to fetch the list of Shopify API versions.

DefaultValue: 2021-07
Example:2021-04

Order Id*

N/A

Specify a unique identifier for the order.

DefaultValue: N/A
Example: 988

Resource Id

N/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

Parameter

N/A

Specify a query parameter.

DefaultValue: N/A
Example: limit

Parameter value

N/A

Specify a value for the parameter.

DefaultValue: N/A
Example:5

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

DefaultValue: 1
Example: 2

Snap Execution

N/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.

DefaultValue: Validate & Execute
Example: Execute only