Get Orders

Get Orders

In this article

Overview

You can use this Snap to fetch a list of orders/draft orders or a specific order/draft order using the resource ID.

Prerequisites

A valid account with the required permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

Shopify Behavior

This Snap does not get the count of orders.

Known Issues

None.

Snap Input and Output

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

 

  • Min:0

  • Max:1

  • Mapper

  • Copy

You must pass Order ID to fetch a specific order from the store.

Output

Document

  • Min:1

  • Max:1

  • JSON Formatter

  • CSV Formatter

Gets the list of orders/draft orders or specific order/draft order.

Snap Settings

Field Name

Field Dependency

Description

Field Name

Field Dependency

Description

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 ValueGet Orders
ExampleGet_Order_123

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
Example: 2021-04

Draft Orders

N/A

Specify the draft order which you want to fetch.

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

Resource Id

N/A

Specify a unique identifier of the order resource.

Default Value: N/A
Example: ord_id

Parameters

Use this field set to define object parameters and their values. This field set contains the following fields:

  • Parameter

  • Parameter value

Parameter

N/A

Specify a optional parameter for the order.

Default Value: N/A
Example: limit

Parameter value

N/A

Specify a value for the parameter.

Default Value: N/A
Example: 5

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 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 ValueValidate & Execute
ExampleExecute only