In this article
Overview
You can use this Snap to fetch a list of product variants, such as different sizes, colors, and prices.
Prerequisites
- Valid client ID.
- A valid account with the required permissions.
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 they are 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. Shopify uses 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 | Binary |
|
| Requires the EDI data and internal ID as a JSON document. |
| Output | Binary |
|
| The EDI transaction ID and order confirmation. |
Snap Settings
Parameter | Data Type | 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. | Get Products | Ord_300 |
| Version | String/Expression | Required. Specify the Shopify API version. Alternatively, click the Suggestion  icon to fetch the list of Shopify API versions. | 2021-04 | 2021-04 |
| Product ID | String/Expression | Required. Specify a unique identifier for the product. | N/A | CMS0119 |
| Resource ID | String/Expression | Specify a unique identifier for the resource. | N/A | $resid |
| Parameters | Use this field set to define object parameters ad their values. This field set contains the following fields:
| |||
| Parameters | String/Expression/Suggestion | Specify a query parameter. | N/A | |
| Parameter value | String/Expression | Specify a value for the parameter. | N/A | |
| 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:
| Validate & Execute | Execute only |
Troubleshooting
| Error | Reason | Resolution |
|---|---|---|
Batch execution failed | The Pipeline ended before the batch could complete execution due to a connection error. | Verify that the Batch size field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open. |
Examples
Getting Product Variants
We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set. This example demonstrates how we can use the <Snap Name> 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.
