Versions Compared

Old Version 11

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 12

changes.mady.by.user Kalpana Malladi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

None.

Snap Input and Output

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

Document


  • Min:0
  • Max:1
  • Mapper
  • Copy
You must pass an Order ID. Upstream Snap is optional.
Output

Document


  • Min:1
  • Max:1
  • JSON Formatter
  • CSV Formatter

Returns the order object that is requested.

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 Snap in your pipelinePipeline.
Default Value: Order Operations
Example: Order_334
Version*N/A

Specify the Shopify API version. Alternatively, click the Suggestion Image Modified icon to fetch the list of supported Shopify API versions and select a version. 

Default Value: 2021-07
Example: 2021-04

Action*N/A

Specify the Action type. The available options are:

  • Cancel: Cancels the order.
  • Close: Closes the order.
  • Open: Opens the order.

Default Value: Close
Example: Open

Order Id*N/A

Specify a unique identifier for the order.

Default Value: N/A
Example: ord_id

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

Insert excerpt
Create Order
Create Order
nopaneltrue

Example

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. For the purpose of demonstrating this example, we first create an order (using the Create Order Snap) to close this order in the subsequent step. 

Image Added

Initially we configure the JSON Generator Snap to pass the order data.

Image Added

Upon validation, this Snap yields the following data in the output preview.

Image Added

Next, we configure the Create Order Snap as follows to create an order.

Image Added

Upon validation, we see the following output data of the created order.

Image Added

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

To validate the action of the Order Operations Snap, we configure the JSON Generator Snap to convert the document format to JSON format.
Image Added

Finally we write the JSON file to the SL database using the File Writer Snap.
Image Added

Download this Pipeline.

Attachments
patterns*.slp, *.zip


Insert excerpt
Shopify Snap Pack
Shopify Snap Pack
nopaneltrue

...