Update Article 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 Article 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 Article 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 Article action
1. Connect your Shopify (OAuth) account
2. Select a Blog ID
3. Select a Article ID
4. Optional- Configure Title
5. Optional- Configure Body
6. Optional- Configure Author
7. Optional- Configure Summary
8. Optional- Configure Image
9. Optional- Configure Tags
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 Article with Shopify API on New Requests from HTTP / Webhook API

HTTP / Webhook + Shopify (OAuth)

Try it

Update Article with Shopify API on New Submission from Typeform API

Typeform + Shopify (OAuth)

Try it

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

Jotform + Shopify (OAuth)

Try it

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

Stripe + Shopify (OAuth)

Try it

Update Article 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 Article on Shopify (OAuth)

Description:Update a blog article. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/articleUpdate)

Version:0.0.7

Key:shopify-update-article

View on GitHub

Code#

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

export default {
  key: "shopify-update-article",
  name: "Update Article",
  description: "Update a blog article. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/articleUpdate)",
  version: "0.0.7",
  type: "action",
  props: {
    shopify,
    blogId: {
      propDefinition: [
        shopify,
        "blogId",
      ],
    },
    articleId: {
      propDefinition: [
        shopify,
        "articleId",
        ({ blogId }) => ({
          blogId,
        }),
      ],
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the article",
      optional: true,
    },
    bodyHtml: {
      type: "string",
      label: "Body",
      description: "The text content of the article, complete with HTML markup.",
      optional: true,
    },
    author: {
      type: "string",
      label: "Author",
      description: "The name of the author of the article",
      optional: true,
    },
    summary: {
      type: "string",
      label: "Summary",
      description: "A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page.",
      optional: true,
    },
    image: {
      type: "string",
      label: "Image",
      description: "The URL of the image associated with the article",
      optional: true,
    },
    tags: {
      propDefinition: [
        shopify,
        "tags",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.shopify.updateArticle({
      id: this.articleId,
      article: {
        title: this.title,
        body: this.bodyHtml,
        author: this.author && {
          name: this.author,
        },
        summary: this.summary,
        image: this.image && {
          url: this.image,
        },
        tags: this.tags,
      },
    });
    if (response.articleUpdate.userErrors.length > 0) {
      throw new Error(response.articleUpdate.userErrors[0].message);
    }
    $.export("$summary", `Updated article with ID ${response.articleUpdate.article.id}.`);

    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.
Blog ID	`blogId`	`string`	Select a value from the drop down menu.
Article ID	`articleId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	The title of the article
Body	`bodyHtml`	`string`	The text content of the article, complete with HTML markup.
Author	`author`	`string`	The name of the author of the article
Summary	`summary`	`string`	A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page.
Image	`image`	`string`	The URL of the image associated with the article
Tags	`tags`	`string[]`	An array of tags to add

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: