In this article

Overview

You can use this Snap to create a new product.

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 

Binary


  • Min:1
  • Max:1
  • Mapper
  • Copy
The description of the product.
Output

Binary


  • Min:1
  • Max:1
  • File Writer

Returns a meta field found by namespace and key.

Snap Settings


Field Name
Field Description
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 Snaps in your Pipeline.

Default Value: Create Product
Example: Product_354

Version*N/A

Specify the Shopify API version. Alternatively, click the Suggestion  icon to fetch the list of Shopify API versions.

Default Value: 2021-07
Example: 2021-04

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: 5

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

Managing Products And Their Variants

This basic Use Case demonstrates how we can manage products and their variants—right from creating a product, product variant, updating it, and finally deleting the product variant when it runs out of inventory.

This Pipeline includes the following steps:

  1. Creating Product
  2. Creating Product Variant
  3. Updating Product Variant
  4. Deleting Product Variant

First, we configure the Mapper Snap to pass details of the product that we want to create.

Upon validation, this Snap generates product data as follows.

Next, we create the product using the Create Product Snap.

Upon validation, the Snap generates the following product data in the output preview.

We now configure the second Mapper Snap to pass the product variant details (as highlighted below) for the product we have just created.

Upon validation, the Snap generates output data as follows.

We configure the Create Product Variant Snap—we specify $id in the Product Id field to create a variant for the product.

Upon validation, the Snap generates the output with the product variant id and the other variant details of the product.


Next, we configure the third Mapper Snap to map specific product details (as highlighted below) against the target columns.

Upon validation, the Snap generates the following output.

We configure the Update Product Variant Snap to update the details of the product variant.

Upon validation, the Snap generates the following product variant data.

Finally, we configure the Delete Product Variant Snap to delete the variant—we specify the $product_id (Product Id) and $id (Resource Id) to accomplish this task.

Upon validation, we see the status of the delete operation as Success, which indicates the successful deletion of the product variant record.

Download this Pipeline.


See Also