Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


In this article

Table of Contents
maxLevel2
absoluteUrltrue

...

Excerpt
  • 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.

    limit:

    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

    Shopify Plus limit:

    4 requests/second


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

...


ParameterData TypeField DependencyDescriptionDefault ValueExample
LabelString
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 RefundOrd_354
VersionString/Expression

Required. Specify the Shopify API version. Alternatively, click the Suggestion Image Modified icon to fetch the list of supported Shopify API versions and select a version. 

2021-042021-04
Order IDString/Expression
Required. Specify a unique identifier for the order.

Number Of RetriesInteger/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.12
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.15
Snap ExecutionDrop-down list

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.

Execute onlyValidate & Execute


Troubleshooting

...