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
Standard limit
Shopify Plus limit
(GraphQL)
Calculated query cost
50 points/second
100 points/second
(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 |
|
| |
Output | Document |
|
|
Snap Settings
Parameter | Data Type | Field Dependency | Description | Default Value | Example |
---|---|---|---|---|---|
Label | String | 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. | Calculate Order Refund | Ord_354 | |
Version | String/Expression | Required. Specify the Shopify API version. Alternatively, click the Suggestion icon to fetch the list of supported Shopify API versions and select a version. | 2021-04 | 2021-04 | |
Order ID | String/Expression | Required. Specify a unique identifier for the order. | |||
Number Of Retries | Integer/Expression | Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout. | 1 | 2 | |
Retry Interval (Seconds) | Integer/Expression | Specify the duration in seconds for which the Snap must wait between two reconnection attempts, until the number of retries is reached. | 1 | 5 | |
Snap Execution | Drop-down list | Select one of the three modes in which the Snap executes. Available options are:
| Execute only | 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:
<screenshot of Pipeline/Snap and description>
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.