In this article

Overview

You can use this Snap to update details of an existing order.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

When you pass invalid data, this Snap does not throw any error. For example, if you enter an invalid country code, currency, or invalid country name, this Snap ignores that invalid data.

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
You must pass appropriate details that you want to update for the order.
Output

Document


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

The updated order ID and the order details.

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 ValueUpdate_Order
ExampleUpdate_Premium_Order
Version*N/A

Draft OrdersN/A

Specify the draft order ID to update the draft order.

Default Value: N/A (Expression enabled by default)
Example$id

Resource Id*N/A

Specify the ID of the order/draft order to update a specific record.

Default Value: N/A
Exampleres_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 ValueExecute only
ExampleValidate & Execute


Example

Updating An Order

This example Pipeline demonstrates how we can update an existing order.

We configure the Get Customers Snap as follows. We do not specify the Resource Id, because we want to get the list of all customers. Upon validation, we get the customer's list in the output preview.

Get Customers Snap ConfigurationOutput

Next, we configure the Mapper Snap by passing the required details to create an order for a specific customer.

Upon validation, we see the following order data in the output preview of the Snap.

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

Create Order Snap ConfigurationOutput

Next, we configure the second Mapper Snap to pass the required details as highlighted below to update the order.

Upon validation, we see the order details in the preview of the Snap.

Finally, we configure the Update Order Snap to update the order with the output from the upstream Mapper Snap. Upon validation, we see the following updated order details in the output preview of the Snap.

Update Order Snap ConfigurationUpdate Order Output

Download this Pipeline.



See Also