In this article

Overview

You can use this Snap to create a transaction record for an existing order.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations 

If you provide an invalid value for Transaction ID or Parent ID, the Snap is not validated. The Snap ignores the invalid values and processes the operation.

Known Issues

None.

Snap Input and Output

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

Document


  • Min:1
  • Max:1
  • Mapper
  • Copy
The customer, product, and variant IDs.
Output

Document

  • Min:1
  • Max:1
  • Mapper
  • Create Order
  • Order Operations

The transaction ID for the 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 Snap in your Pipeline.

Default Value: Create Transaction
ExampleCreate_Transaction
Version*N/A

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
Example2021-04

Order Id*N/A

Specify the order ID for which you want to create a transaction.

Default Value: N/A
Example: ORD9

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 ExecutionN/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

Managing Order Transactions

This example Pipeline demonstrates how to manage transactions—starting from creating transactions for an order, performing an order operation, getting transactions, and finally deleting the order.
This Pipelines includes the following key steps:

  1. Creating an Order
  2. Creating a Transaction
  3. Performing order operations
  4. Getting Transactions

We use four Mapper Snaps to transform the data before each step.

Initially, we configure the JSON Generator Snap to pass the following data.

JSON Generator ConfigurationOutput

Next, we configure the first Mapper Snap to pass specific data relating to line items and tax amount. 

Upon validation, the Snap generates output as follows.

Create Order: We configure the Create Order Snap to create an order with the inputs (line items and tax amount) from the upstream Snap. Upon validation, we see the order details in the output preview of the Snap.

Create Order Snap ConfigurationOutput

Next, we configure the second Mapper Snap to pass the transaction data of the order as input to the downstream Snap.

Upon validation, the Snap generates the transaction data as follows.

Create Transaction: We configure the Create Transaction Snap to create a transaction for the order. Upon validation, we see the transaction details in the output preview of the Snap.

Create Transaction Snap ConfigurationOutput

Next, we configure the third Mapper Snap to pass the order details.

Upon validation, the Snap generates the output as follows.

Order Operations: We configure the Order Operations Snap to cancel the order. Upon execution the status of the order is displayed cancelled in the Shopify application.

Order Operations Snap ConfigurationOutput

Next, we configure the last Mapper Snap as follows.

Upon validation, the Snap generates the following output.

Get Transaction: We configure the Get Transactions Snap to get the transaction details for the created transaction. Upon validation, the Snap gets the transactions as we see in the output preview of the Snap.

Get Transaction Snap ConfigurationOutput

Delete Order: Finally, we configure the Delete Order Snap to delete the order. Upon validation, we see the status as success which indicates the order is deleted.

Delete Order Snap ConfigurationOutput

Download this Pipeline.



See Also