Delete Order

In this article

Overview

You can use this Snap to delete (soft delete) existing order records from the Shopify store.

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

    API

    Rate-limiting method

    Standard 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

    4 requests/second

Known Issues

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document


  • Min:0
  • Max:1
  • Mapper
  • Copy

The ID of the order or draft order to delete. Upstream Snap is optional.


Output

Document


  • Min:0
  • Max:1
  • Get Orders

Displays the status of the deleted order.

Snap Settings

Field NameField DependencyDescription
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 Snaps in your Pipeline.

Default Value: Delete Order
ExampleDelete_Pending_Orders
Version*N/A

Specify the Shopify API version.

Default Value2021-07
Example2021-04

Draft OrdersN/A

Specify a draft order ID to delete (soft delete) draft orders from the store.

Default ValueN/A (Expression enabled by default)
Example: 786

Resource Id*N/A

Specify a unique identifier of the order to delete a specific record.

Default Value: N/A
Example2568

Number Of RetriesN/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 Value1
Example2

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 Value1
Example2

Snap Execution

N/A


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.

Default ValueExecute only 
ExampleValidate & Execute

Example

Deleting an Order

The following Pipeline describes how the Delete Order Snap functions as a standalone Snap in a Pipeline.

We configure the Delete Order Snap with the resource order ID that we want to delete.

Upon validation, the order is deleted—we see the status of the delete operation as Success in the output preview of the Snap.


Snap Pack History

 Click here to expand...
Snap Pack Version 

Release

Date

Type

Updates

4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.
4.27main12833 StableUpgraded with the latest SnapLogic Platform release.
4.26 

main11181

Latest

Introduced the Shopify Snap Pack that enables businesses to set up an online store and sell their products online with ease. You can use this Snap Pack to create orders, products, customers, and run automated workflows. This Snap Pack offers the following Snaps:


See Also