In this article
Overview
You can use this Snap to calculate refund transactions based on line items 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 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. 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
| Field Name | Field Dependency | Description |
|---|---|---|
| Label | 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 | N/A | Required. Specify the Shopify API version. Alternatively, click the Suggestion Default Value: 2021-04 Example: 2021-04 |
| Order ID | N/A | Required. 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:
Default Value: Execute only Example: Validate & Execute |
Troubleshooting
| Error | Reason | Resolution |
|---|---|---|
| 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. |
Downloads
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.