In this article

Overview

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

Prerequisites

Valid client ID.
A valid account with the required permissions.

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

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

If the APIs cross the rate limit, the Snap fails.

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

Output

Document

Min:1
Max:1

Mapper Snap
Create Order Snap
Get Order Snap

Snap Settings

Field Name	Data Type	Field Dependency	Description
Label	String	N/A	Required. 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	String/Expression	N/A	Required. 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	String/Expression	N/A	Required. Specify a unique identifier for the order. Default Value: N/A Example: Ord_254
Number Of Retries	Integer/Expression	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)	Integer/Expression	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	Drop-down list	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
423 error	Shopify APIs use different API rate-limiting methods. If the APIs cross the rate limit, the Snap fails.	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.

Examples

Calculating Order Refund

This example Pipeline demonstrates how we can use the Calculate Order Refund Snap to achieve this result:

Download this Pipeline.

Downloads

Important Steps to Successfully Reuse Pipelines

Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.

	File	Modified

No files shared here yet.

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

Calculate Order Refund