In this article
You can use this Snap to close, cancel or reopen an existing order.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations and Known Issues
- 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.
Snap Input and Output
|Input/Output||Type of View||Number of Views||Examples of Upstream and Downstream Snaps||Description|
|You must pass an Order ID. Upstream Snap is optional.|
- JSON Formatter
- CSV Formatter
Returns the order object that is requested.
|Field Name||Field Dependency||Description|
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: Order Operations
Specify the Shopify API version. Alternatively, click the Suggestion icon to fetch the list of supported Shopify API versions and select a version.
Default Value: 2021-07
Specify the Action type you want the Snap to perform on the order. The available options are:
- Cancel: Cancels the order.
- Close: Closes the order.
- Open: Opens the order.
Default Value: Close
Specify a unique identifier for the order.
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
Select one of the three modes in which the Snap executes. Available options are:
Default Value: Execute only
Example: Validate & Execute
"402 Payment Required"
|The requested shop is currently frozen. ||You need to log in as admin user and pay the outstanding balance to unfreeze the shop.|
"404 Not Found"
|The requested resource is not found.||The resource could be available again in the future.|
"406 Not Acceptable"
|The requested resource is only capable of generating content, but not acceptable according to the Accept headers sent in the request.||N/A|
|This is an intermittent error that you can encounter when there is a conflict in your orders, products, or customer data. For example, when you use unsupported characters.||Check for the conflicts in your metadata and rerun the Pipeline.|
"422 Unprocessable Entity"
The request body was well-formed but contains semantic errors. You can encounter a
422 error from a variety of scenarios including, but not limited to:
Formatting of the input is incorrect.
Checking out products that are out of stock.
Canceling an order that has fulfillments.
Creating an order with tax lines on both line items and the order.
Creating a customer without an email or name
Creating a product without a title.
|The response body provides details in the errors or error parameters. Fix the error parameters as given in the error description.|
"422 empty entity error"
|You might be sending null or empty or unsupported data. ||Check the data and fix the null or empty data.|
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 the 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.|
"500 Internal Server Error"
|An internal error in Shopify application causes this error. ||Post the error details to the API and Technology forum so that Shopify staff can investigate the issue.|
"501 Not Implemented"
|The requested endpoint is not available on that particular shop, for example, requesting access to a Plus-specific API on a non-Plus shop. This response may also indicate that this endpoint is reserved for future use.||N/A|
"504 Gateway Timeout"
|The request could not complete in time. Shopify waits up to 10 seconds for a response.||Break down the request in multiple smaller requests.|
Closing An Order Using Order Operations Snap
The Order Operations Snap enables you to close, cancel, or reopen an order. In this example Pipeline we demonstrate how to close an existing order using this Snap.
Initially we configure the JSON Generator Snap to pass the order data.
Upon validation, this Snap yields the following data in the output preview.
Next, we configure the Create Order Snap as follows to create an order.
Upon validation, we see the following output data of the created order.
Next, we configure the Order Operations Snap to close the order. To this end, we specify close for Action and $id for Order Id. Upon execution we see the status of order as closed in the Shopify application.
To validate the action of the Order Operations Snap, we configure the JSON Generator Snap to convert the document format to JSON format.
Finally we write the JSON file to the SL database using the File Writer Snap.
Download this Pipeline.
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.
Snap Pack History