In this article
Overview
You can use this Snap to fetch a list of orders/draft orders or a specific order/draft order using the resource ID.
Prerequisites
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 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.
Shopify Behavior
This Snap does not get the count of orders.
Known Issues
None.
Snap Input and Output
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| You must pass Order ID to fetch a specific order from the store. |
| Output | Document |
|
| Gets the list of orders/draft orders or specific order/draft order. |
Snap Settings
Field Name | Field Dependency | Description |
|---|---|---|
| Label* | N/A | Specify 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 Snap in your Pipeline. Default Value: Get Orders Example: Get_Order_123 |
| Draft Orders | N/A | Specify the draft order which you want to fetch. Default Value: N/A |
| Resource Id | N/A | Specify a unique identifier of the order resource. Default Value: N/A |
| Parameters | Use this field set to define object parameters and their values. This field set contains the following fields:
| |
| Parameter | N/A | Specify a optional parameter for the order. Default Value: N/A |
| Parameter value | N/A | Specify a value for the parameter. Default Value: N/A |
| 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 |
| 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 |
| Snap Execution | N/A | Select one of the three modes in which the Snap executes. Available options are:
Default Value: Validate & Execute |