Update Metaobject with Shopify (OAuth) API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Update Metaobject 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#

Create a workflow to Update Metaobject with the Shopify (OAuth) API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Update Metaobject action
1. Connect your Shopify (OAuth) account
2. Select a Type
3. Select a Metaobject ID
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Update Metaobject with Shopify API on New Requests from HTTP / Webhook API

HTTP / Webhook + Shopify (OAuth)

Try it

Update Metaobject with Shopify API on New Submission from Typeform API

Typeform + Shopify (OAuth)

Try it

Update Metaobject with Shopify API on New Submission (Instant) from Jotform API

Jotform + Shopify (OAuth)

Try it

Update Metaobject with Shopify API on New Custom Webhook Events from Stripe API

Stripe + Shopify (OAuth)

Try it

Update Metaobject with Shopify API on New Scheduled Tasks from Pipedream API

Pipedream + Shopify (OAuth)

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Update Metaobject on Shopify (OAuth)

Description:Updates a metaobject. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/metaobjectUpdate)

Version:0.0.7

Key:shopify-update-metaobject

View on GitHub

Code#

import shopify from "../../shopify.app.mjs";
import common from "../common/metaobjects.mjs";
import { MAX_LIMIT } from "../../common/constants.mjs";

export default {
  ...common,
  key: "shopify-update-metaobject",
  name: "Update Metaobject",
  description: "Updates a metaobject. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/metaobjectUpdate)",
  version: "0.0.7",
  type: "action",
  props: {
    shopify,
    type: {
      propDefinition: [
        shopify,
        "metaobjectType",
      ],
      reloadProps: true,
    },
    metaobject: {
      propDefinition: [
        shopify,
        "metaobjectId",
        (c) => ({
          type: c.type,
        }),
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.type) {
      return props;
    }
    try {
      return await this.getMetaobjectFields(props);
    }
    catch {
      return await this.getTypeFields(props);
    }
  },
  methods: {
    ...common.methods,
    async getMetaobjectFields(props) {
      const { metaobject: { fields } } = await this.getMetaobject({
        id: this.metaobject,
      });
      for (const field of fields) {
        props[field.key] = {
          type: "string",
          label: field.definition.name,
          optional: true,
        };
        if (field.value) {
          props[field.key].default = field.value;
        }
      }
      return props;
    },
    async getTypeFields(props) {
      const { metaobjectDefinitions: { nodes } } = await this.shopify.listMetaobjectDefinitions({
        first: MAX_LIMIT,
      });
      const { fieldDefinitions } = nodes.find(({ id }) => id === this.type);
      for (const def of fieldDefinitions) {
        props[def.key] = {
          type: "string",
          label: def.name,
          optional: true,
        };
      }
      return props;
    },
  },
  async run({ $ }) {
    const { metaobject: { fields } } = await this.getMetaobject({
      id: this.metaobject,
    });

    const newFields = [];
    for (const field of fields) {
      newFields.push({
        key: field.key,
        value: this[field.key]
          ? this[field.key]
          : field.value || "",
      });
    }

    const response = await this.updateMetaobject({
      id: this.metaobject,
      fields: newFields,
    });

    if (response.metaobjectUpdate.userErrors.length > 0) {
      throw new Error(response.metaobjectUpdate.userErrors[0].message);
    }

    $.export("$summary", `Successfully updated metaobject with ID ${this.metaobject}`);
    return response;
  },
};

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
Shopify (OAuth)	`shopify`	`app`	This component uses the Shopify (OAuth) app.
Type	`type`	`string`	Select a value from the drop down menu.
Metaobject ID	`metaobject`	`string`	Select a value from the drop down menu.

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: