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

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
Example: Delete_Pending_Orders
Version*N/A

Specify the Shopify API version.

Default Value: 2021-07
Example: 2021-04

Draft OrdersN/A

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

Default Value: N/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
Example: 2568

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 Value: 1
Example: 2

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
Example: 2

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 Value: Execute only 
Example: Validate & 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.


See Also