Search for Product Variant with Shopify (OAuth) API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Shopify (OAuth), Schedule and 2,900+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Search for Product Variant with the Shopify (OAuth) API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and Shopify (OAuth) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Search for Product Variant action
1. Connect your Shopify (OAuth) account
2. Select a Product ID
3. Optional- Select a Product Variant ID
4. Optional- Configure Title
5. Optional- Configure Create If Not Found
6. Select one or more Options
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Search for Product Variant on Shopify (OAuth)

Description:Search for product variants or create one if not found. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/queries/productVariants)

Version:0.0.14

Key:shopify-search-product-variant

View on GitHub

Shopify (OAuth) Overview#

Shopify provides a powerful API that enables developers to build a wide range
of applications and tools for merchants. Some examples of what you can build
using the Shopify API include:

Merchant tools: tools that help merchants manage their stores, such as order
management, product administration, and reporting
E-commerce applications: applications that enable merchants to sell their
products online, such as shopping carts, product catalogs, and order
management
Integration tools: tools that helps integrate Shopify with other systems,
such as accounting, inventory, and shipping

Action Code#

import shopify from "../../shopify.app.mjs";
import utils from "../../common/utils.mjs";
import { MAX_LIMIT } from "../../common/constants.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "shopify-search-product-variant",
  name: "Search for Product Variant",
  description: "Search for product variants or create one if not found. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/queries/productVariants)",
  version: "0.0.14",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    shopify,
    productId: {
      propDefinition: [
        shopify,
        "productId",
      ],
    },
    productVariantId: {
      propDefinition: [
        shopify,
        "productVariantId",
        (c) => ({
          productId: c.productId,
        }),
      ],
      description: "ID of the product variant. Takes precedence over **Title**",
      optional: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "The name of the product variant",
      optional: true,
    },
    createIfNotFound: {
      type: "boolean",
      label: "Create If Not Found",
      description: "Creates the product variant with **Title** and the fields below if not found",
      optional: true,
      default: false,
      reloadProps: true,
    },
    optionIds: {
      propDefinition: [
        shopify,
        "productOptionIds",
        (c) => ({
          productId: c.productId,
        }),
      ],
      hidden: true,
    },
  },
  async additionalProps(existingProps) {
    let props = {};
    if (this.createIfNotFound) {
      existingProps.optionIds.hidden = false;
      props.price = {
        type: "string",
        label: "Price",
        description: "The price of the product variant",
        optional: true,
      };
      props.image = {
        type: "string",
        label: "Image URL",
        description: "The URL of an image to attach to the product variant",
        optional: true,
      };
    }
    return props;
  },
  methods: {
    async getOptionValues() {
      const { product: { options } } = await this.shopify.getProduct({
        id: this.productId,
        first: MAX_LIMIT,
      });
      const productOptions = {};
      for (const option of options) {
        for (const optionValue of option.optionValues) {
          productOptions[optionValue.id] = option.id;
        }
      }
      const optionValues = this.optionIds.map((id) => ({
        id,
        optionId: productOptions[id],
      }));
      return optionValues;
    },
  },
  async run({ $ }) {
    if (!(this.productVariantId || this.title)) {
      throw new ConfigurationError("Required field missing: Fill in `Product Variant ID` or `Title`");
    }

    let response;
    try {
      if (this.productVariantId) {
        response = await this.shopify.getProductVariant({
          id: this.productVariantId,
          first: MAX_LIMIT,
        });
      } else {
        response = await this.shopify.listProductVariants({
          query: `product_id:${utils.getIdFromGid(this.productId)} AND title:${JSON.stringify(this.title)}`,
          first: MAX_LIMIT,
        });
      }

      const variant = response?.productVariants?.nodes?.length
        ? response.productVariants.nodes[0]
        : response?.productVariant
          ? response.productVariant
          : {};

      const title = variant?.title;
      const id = variant?.id;

      if (title && id) {
        $.export("$summary", `Found product variant \`${title}\` with ID \`${id}\``);
      } else {
        throw new Error("No product variant found");
      }
    } catch (err) {
      if (!this.createIfNotFound) {
        $.export("$summary", "No product variant found");
        return;
      }

      response = await this.shopify.createProductVariants({
        productId: this.productId,
        variants: [
          {
            optionValues: this.optionIds && await this.getOptionValues(),
            price: this.price,
            mediaSrc: this.image,
          },
        ],
      });
      if (response.productVariantsBulkCreate.userErrors.length > 0) {
        throw new Error(response.productVariantsBulkCreate.userErrors[0].message);
      }
      $.export("$summary", `Created new product variant \`${response.productVariantsBulkCreate.productVariants.title}\` with ID \`${response.productVariantsBulkCreate.productVariants.id}\``);
    }
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Shopify (OAuth)	`shopify`	`app`	This component uses the Shopify (OAuth) app.
Product ID	`productId`	`string`	Select a value from the drop down menu.
Product Variant ID	`productVariantId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	The name of the product variant
Create If Not Found	`createIfNotFound`	`boolean`	Creates the product variant with Title and the fields below if not found

Action Authentication#

Shopify (OAuth) uses OAuth authentication. When you connect your Shopify (OAuth) account, Pipedream will open a popup window where you can sign into Shopify (OAuth) and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Shopify (OAuth) API.

Pipedream requests the following authorization scopes when you connect your account:

Search for Product Variant with Shopify (OAuth) API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Shopify (OAuth), Schedule and 2,900+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular