Add Or Update Records with Grist API on New Cancelled Order (Instant) from Shopify API

Pipedream makes it easy to connect APIs for Grist, Shopify and 2,400+ other apps remarkably fast.

Trigger workflow on

New Cancelled Order (Instant) from the Shopify API

Next, do this

Add Or Update Records with the Grist 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 Shopify trigger and Grist action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Cancelled Order (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Add Or Update Records action
1. Connect your Grist account
2. Configure Document ID
3. Select a Table ID
4. Optional- Configure Do Not Parse
5. Optional- Select a On Many
6. Optional- Configure No Add
7. Optional- Configure No Update
8. Configure Data Records
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 Cancelled Order (Instant) on Shopify

Description:Emit new event each time a new order is cancelled.

Version:0.0.4

Key:shopify_developer_app-new-cancelled-order

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Trigger Code#

import constants from "../common/constants.mjs";
import common from "../common/webhook-metafields.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-cancelled-order",
  name: "New Cancelled Order (Instant)",
  type: "source",
  description: "Emit new event each time a new order is cancelled.",
  version: "0.0.4",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.ORDERS_CANCELLED;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.updated_at);
      return {
        id: ts,
        summary: `Order Cancelled ${resource.id}.`,
        ts,
      };
    },
  },
};

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
Shopify	`app`	`app`	This component uses the Shopify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Metafield Namespaces	`metafieldNamespaces`	`string[]`	Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.

Trigger Authentication#

Shopify uses API keys for authentication. When you connect your Shopify account, Pipedream securely stores the keys so you can easily authenticate to Shopify APIs in both code and no-code steps.

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

Action#

Add Or Update Records on Grist

Description:Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)

Version:0.0.2

Key:grist-add-update-records

View on GitHub

Grist Overview#

Grist API on Pipedream enables you to automate data management tasks in your Grist documents. This might mean syncing data across different platforms, triggering notifications based on data changes, or processing data through custom logic. With Pipedream, you can use the Grist API to build workflows that react to events in real-time, connect to hundreds of other services, manipulate data in sophisticated ways, and create custom endpoints to integrate with your Grist data.

Action Code#

import app from "../../grist.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "grist-add-update-records",
  name: "Add Or Update Records",
  description: "Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    docId: {
      propDefinition: [
        app,
        "docId",
      ],
    },
    tableId: {
      propDefinition: [
        app,
        "tableId",
        ({ docId }) => ({
          docId,
        }),
      ],
    },
    noParse: {
      propDefinition: [
        app,
        "noParse",
      ],
    },
    onMany: {
      type: "string",
      label: "On Many",
      description: "Which records to update if multiple records are found to match.",
      optional: true,
      options: [
        {
          value: "first",
          label: "The first matching record (default)",
        },
        {
          value: "none",
          label: "Do not update anything",
        },
        {
          value: "all",
          label: "Update all matches",
        },
      ],
    },
    noAdd: {
      type: "boolean",
      label: "No Add",
      description: "Set to true to prohibit adding records.",
      optional: true,
    },
    noUpdate: {
      type: "boolean",
      label: "No Update",
      description: "Set to true to prohibit updating records.",
      optional: true,
    },
    records: {
      description: app.propDefinitions.records.description + " Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. `[ { \"require\": { \"pet\": \"cat\" }, \"fields\": { \"popularity\": 67 } } ]`",
      propDefinition: [
        app,
        "records",
      ],
    },
  },
  methods: {
    addUpdateRecords({
      docId, tableId, ...args
    } = {}) {
      return this.app.put({
        path: `/docs/${docId}/tables/${tableId}/records`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      addUpdateRecords,
      docId,
      tableId,
      noParse: noparse,
      onMany: onmany,
      noAdd: noadd,
      noUpdate: noupdate,
      records,
    } = this;

    await addUpdateRecords({
      $,
      docId,
      tableId,
      params: {
        noparse,
        onmany,
        noadd,
        noupdate,
      },
      data: {
        records: utils.parseArray(records),
      },
    });

    $.export("$summary", "Successfully ran this action");

    return {
      success: true,
    };
  },
};

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
Grist	`app`	`app`	This component uses the Grist app.
Document ID	`docId`	`string`	The ID of the Grist document to operate on. You can find this in the Settings menu of the document.
Table ID	`tableId`	`string`	Select a value from the drop down menu.
Do Not Parse	`noParse`	`boolean`	Set to `true` to prohibit parsing strings according to the column type.
On Many	`onMany`	`string`	Select a value from the drop down menu:`{ "value": "first", "label": "The first matching record (default)" }{ "value": "none", "label": "Do not update anything" }{ "value": "all", "label": "Update all matches" }`
No Add	`noAdd`	`boolean`	Set to true to prohibit adding records.
No Update	`noUpdate`	`boolean`	Set to true to prohibit updating records.
Data Records	`records`	`string[]`	The data for the records to append or update. Each record should be a JSON-formatted string, mapping column names to cell values. Eg. `[ { "fields": { "pet": "cat", "popularity": 67 } } ]`. Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. `[ { "require": { "pet": "cat" }, "fields": { "popularity": 67 } } ]`

Action Authentication#

Grist uses API keys for authentication. When you connect your Grist account, Pipedream securely stores the keys so you can easily authenticate to Grist APIs in both code and no-code steps.

To retrieve your API key,

Navigate to your Girst account and sign in
Go to “Profile Settings” > “API”

Add Or Update Records with Grist API on New Cancelled Order (Instant) from Shopify API

Pipedream makes it easy to connect APIs for Grist, Shopify and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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