Skip to end of metadata
Go to start of metadata


A Shopify Put Products activity updates products at a Shopify connection and is used as a target in an operation. After configuring a Shopify connection, you can configure as many Shopify activities as you like for each Shopify connection.

NOTE: Projects created prior to the Cloud Studio 10.19 release need to be reconfigured by selecting an Authentication Type in the Shopify connection.

Creating a Shopify Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Within the Endpoints filter, click the Shopify connection block to display activities that are available to be used with a Shopify connection:

Connectivity tab

To create an activity that can be configured, the activity must first be added to an operation on the design canvas. To add an activity to an operation, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After a Shopify activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: This opens the activity configuration screen for you to configure the activity. For details, see Configuring a Shopify Put Product Activity later on this page.

  • Delete: This is used to permanently delete the activity.

  • Rename: This positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: This changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Available only from the actions menu on the design canvas, this removes the activity as a step in the operation without deleting it from the project. When you remove an activity that is adjacent to a transformation, if schemas are provided within that activity, they will no longer be referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: This deploys the activity and any components it is dependent on.

  • Configurable Deploy: This opens the deployment screen, where you can select project components to deploy.

  • Add to group: This opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: This creates a copy of the activity as a new, unreferenced component. Upon creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring a Shopify Put Products Activity

Follow these steps to configure a Shopify put products activity:

Step 1: Enter Basic Information

Connectivity tab

  • Name: Enter a name to use to identify the Shopify put products activity. The name must be unique for each put products activity and must not contain forward slashes (/) or colons (:).

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 2: Review Data Schema

Connectivity tab

  • Data Schema: The request and response data schemas for Shopify will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The Shopify connector uses the Shopify REST Admin Product API. Refer to the API documentation and links in the following table for information on the schema fields.

    NOTE: The Shopify connector no longer supports API version 2019-07. Support for the current versions are backwards compatible and existing projects should not break. Refer to Shopify API Versioning for a list of supported versions release dates.

    • Request:

      Request Schema Field/NodeAPI Field or TypeNotes
      PutProductRequestnodeRequest for the activity
      UpdateProductnodeNode representing the product updates
      elementnodeNode representing a product update
      idIntegerA unique numeric identifier, of up to 32 digits, for the product
      product_typeStringA categorization for the product used for filtering and searching products
      published_scopeStringWhether the product is published to the Point of Sale channel; valid values web or global
      titleStringThe name of the product
      variantsnodeA list of product variants, each representing a different version of the product
      variantselementnodeA product variant, representing a different version of the product
      inventory_policyStringWhether customers are allowed to place an order for the product variant when it's out of stock
      positionIntegerThe order of the product variant in the list of product variants
      priceFloatThe price of the product variant
      requires_shippingBoolean (Deprecated)Whether a customer needs to provide a shipping address when placing an order for the product variant
      skuStringA unique identifier for the product variant in the shop
      titleStringThe title of the product variant
      weightIntegerThe weight of the product variant in the unit system specified with weight_unit
      weight_unitStringThe unit of measurement that applies to the product variant's weight
      vendorStringThe name of the product's vendor
    • Response:

      Response Schema Field/NodeAPI Field or TypeNotes
      PutProductResponsenodeResponse from the activity
      UpdateFailedRecordsnodeNode representing the failed records
      FailurenodeNode representing a failed record
      errorMessaageStringError message of the failure
      UpdateSuccessRecordsnodeNode representing the success records
      successnodeNode representing a success record
      idIntegerThe ID of the successfully updated record
  • Add Plugin(s): Plugins are Jitterbit- or user-provided applications that extend Harmony's native capabilities. To apply a plugin to the activity, click to expand this section and select the checkbox next to the plugin to be used. For additional instructions on using plugins, including details on setting any required variables used by the plugin, see Plugins Added to an Activity.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Next Steps

After configuring a Shopify put products activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

Shopify put products activities can be used as a target with these operation patterns:

Other patterns are not valid using Shopify put products activities. See the validation patterns on the Operation Validity page.

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

On This Page

Last updated:  Jun 25, 2019

  • No labels