Update Product Variant with Shopify (OAuth) API on New Discussion from GitHub API

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

Trigger workflow on

New Discussion from the GitHub API

Next, do this

Update 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 GitHub 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 New Discussion trigger
1. Connect your GitHub account
2. Select a Repository
Configure the Update Product Variant action
1. Connect your Shopify (OAuth) account
2. Select a Product ID
3. Select a Product Variant ID
4. Optional- Select one or more Options
5. Optional- Configure Price
6. Optional- Configure Image
7. Optional- Configure Sku
8. Optional- Configure Barcode
9. Optional- Configure Weight
10. Optional- Select a Weight Unit
11. Optional- Configure Metafields
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#

New Discussion on GitHub

Description:Emit new event when a discussion is created

Version:1.0.9

Key:github-new-discussion

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-discussion",
  name: "New Discussion",
  description: "Emit new event when a discussion is created",
  version: "1.0.9",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "discussion",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.action === "created";
    },
    getWebhookEventItem(body) {
      return body.discussion;
    },
    getSummary(item) {
      return `New discussion: "${item.title}"`;
    },
    getPollingData(args) {
      return this.github.getDiscussions(args);
    },
    sortByTimestamp(items) {
      return items.sort((a, b) => {
        const dateA = new Date(a.createdAt).getTime();
        const dateB = new Date(b.createdAt).getTime();
        return dateA - dateB;
      });
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#discussion";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/graphql/reference/objects#discussion";
    },
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

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

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action#

Update Product Variant on Shopify (OAuth)

Description:Update an existing product variant. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkUpdate)

Version:0.0.16

Key:shopify-update-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, WEIGHT_UNITS,
} from "../../common/constants.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "shopify-update-product-variant",
  name: "Update Product Variant",
  description: "Update an existing product variant. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkUpdate)",
  version: "0.0.16",
  type: "action",
  props: {
    shopify,
    productId: {
      propDefinition: [
        shopify,
        "productId",
      ],
    },
    productVariantId: {
      propDefinition: [
        shopify,
        "productVariantId",
        (c) => ({
          productId: c.productId,
        }),
      ],
    },
    optionIds: {
      propDefinition: [
        shopify,
        "productOptionIds",
        (c) => ({
          productId: c.productId,
        }),
      ],
      optional: true,
    },
    price: {
      type: "string",
      label: "Price",
      description: "The price of the product variant",
      optional: true,
    },
    image: {
      type: "string",
      label: "Image",
      description: "The URL of an image to be added to the product variant",
      optional: true,
    },
    sku: {
      type: "string",
      label: "Sku",
      description: "A unique identifier for the product variant in the shop",
      optional: true,
    },
    barcode: {
      type: "string",
      label: "Barcode",
      description: "The barcode, UPC, or ISBN number for the product",
      optional: true,
    },
    weight: {
      type: "string",
      label: "Weight",
      description: "The weight of the product variant in the unit system specified with Weight Unit",
      optional: true,
    },
    weightUnit: {
      type: "string",
      label: "Weight Unit",
      description: "The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied.",
      optional: true,
      options: WEIGHT_UNITS,
    },
    metafields: {
      propDefinition: [
        shopify,
        "metafields",
      ],
    },
  },
  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.weightUnit && !this.weight) || (!this.weightUnit && this.weight)) {
      throw new ConfigurationError("Must enter both Weight and Weight Unit to set weight");
    }

    const response = await this.shopify.updateProductVariant({
      productId: this.productId,
      variants: [
        {
          id: this.productVariantId,
          optionValues: this.optionIds && await this.getOptionValues(),
          price: this.price,
          mediaSrc: this.image,
          barcode: this.barcode,
          inventoryItem: (this.sku || this.weightUnit || this.weight) && {
            sku: this.sku,
            measurement: (this.weightUnit || this.weight) && {
              weight: {
                unit: this.weightUnit,
                value: +this.weight,
              },
            },
          },
          metafields: this.metafields && utils.parseJson(this.metafields),
        },
      ],
    });
    if (response.productVariantsBulkUpdate.userErrors.length > 0) {
      throw new Error(response.productVariantsBulkUpdate.userErrors[0].message);
    }
    $.export("$summary", `Created new product variant \`${response.productVariantsBulkUpdate.productVariants[0].title}\` with ID \`${response.productVariantsBulkUpdate.productVariants[0].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.
Options	`optionIds`	`string[]`	Select a value from the drop down menu.
Price	`price`	`string`	The price of the product variant
Image	`image`	`string`	The URL of an image to be added to the product variant
Sku	`sku`	`string`	A unique identifier for the product variant in the shop
Barcode	`barcode`	`string`	The barcode, UPC, or ISBN number for the product
Weight	`weight`	`string`	The weight of the product variant in the unit system specified with Weight Unit
Weight Unit	`weightUnit`	`string`	Select a value from the drop down menu:`KILOGRAMSGRAMSPOUNDSOUNCES`
Metafields	`metafields`	`string[]`	An array of objects, each one representing a metafield. If adding a new metafield, the object should contain `key`, `value`, `type`, and `namespace`. Example: `{{ [{ "key": "new", "value": "newvalue", "type": "single_line_text_field", "namespace": "global" }] }}`. To update an existing metafield, use the `id` and `value`. Example: `{{ [{ "id": "28408051400984", "value": "updatedvalue" }] }}`

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:

Update Product Variant with Shopify (OAuth) API on New Discussion from GitHub API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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