In this article

Overview

You can use this Snap to calculate refund transactions based on line and shipped items.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

API versions: Shopify releases new API versions every quarter. Each stable version is supported only for a minimum of 12 months. Part of a Shopify API is deprecated if it becomes unnecessary, unsafe, or outdated. The API’s are marked as deprecated when it's removed in a newer version of the API. The deprecation is then retroactively applied to previous stable versions of the API.
API Rate Limit: All Shopify APIs are rate-limited. They use various strategies to enforce rate limits, such as Calculated query cost, Request-based limit, and Time-based limit.
Shopify Snap Pack uses admin APIs, which are applicable for Request-based limit. If the APIs cross the rate limit, the Snap fails.

API
Rate-limiting method
Standard limit
Shopify Plus limit
Admin API
(GraphQL)
Calculated query cost
50 points/second
100 points/second
Admin API
(REST)
Request-based limit
2 requests/second
4 requests/second

Known Issues

None.

Snap Input and Output

Input/Output Type of View Number of Views Examples of Upstream and Downstream Snaps Description

Input

Document

Min:1
Max:1

Mapper Snap
Copy Snap

The order details, such as time of order creation, order ID, order note, amount, and currency code. For example,

"refund_duties": [ { "duty_id": 1, "refund_type": "FULL" "note": "Item was damaged during shipping" } ]

Output

Document

Min:1
Max:1

Mapper Snap
Create Order Snap
Get Order Snap

Retrieves a specific refund.

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 Snaps in your pipeline. Default Value: Calculate Order Refund Example: Ord_354
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-04 Example: 2021-04
Order ID*	N/A	Specify a unique identifier for the order. Default Value: N/A Example: Ord_254
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 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 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. Default Value: Execute only Example: Validate & Execute

Troubleshooting

Error Reason Resolution

"422 Unprocessable Entity"

The request body was well-formed but contains semantic errors. You can encounter a 422 error from a variety of scenarios including, but not limited to:

Formatting of the input is incorrect.
Checking out products that are out of stock.
Canceling an order that has fulfillments.
Creating an order with tax lines on both line items and the order.
Creating a customer without an email or name
Creating a product without a title.

The response body provides details in the errors or error parameters.

Fix the error parameters as given in the error description.

"423 locked"

The requested shop is currently locked. Shops are locked if they repeatedly exceed their API request limit, or if there is an issue with the account, such as a detected compromise or fraud risk.

Wait for Shopify to unlock your account after a specified amount of time, after which you should be able to continue working on your Pipeline, or contact support if your shop is locked.

"429 Too Many Requests" Shopify APIs use different API rate-limiting methods. If the APIs exceeds the rate limit, the Snap fails. See the API Call Limit documentation for a breakdown of Shopify's rate-limiting mechanism.

Error rendering macro 'excerpt-include' : No link could be created for 'XYZ Snap Pack'.

Calculate Order Refund