Generate Match Report with Interzoid API on New Draft Order (Instant) from Shopify Developer App API

Pipedream makes it easy to connect APIs for Interzoid, Shopify Developer App and 2,000+ other apps remarkably fast.

Trigger workflow on

New Draft Order (Instant) from the Shopify Developer App API

Next, do this

Generate Match Report with the Interzoid API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Draft Order (Instant) trigger
1. Connect your Shopify Developer App account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Generate Match Report action
1. Connect your Interzoid account
2. Select a Matching Algorithm Type
3. Select a Database Connection Type
4. Configure Connection String
5. Configure Table Name
6. Configure Match Column Name
7. Optional- Configure Reference
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 Draft Order (Instant) on Shopify Developer App

Description:Emit new event for each new draft order submitted to a store.

Version:0.0.2

Key:shopify_developer_app-new-draft-order

View on GitHub

Shopify Developer App 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 common from "../common/webhook.mjs";
import constants from "../common/constants.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-draft-order",
  name: "New Draft Order (Instant)",
  type: "source",
  description: "Emit new event for each new draft order submitted to a store.",
  version: "0.0.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.DRAFT_ORDERS_CREATE;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.created_at);
      return {
        id: resource.id,
        summary: `New Draft Order ${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 Developer App	`app`	`app`	This component uses the Shopify Developer App 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
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook

Trigger Authentication#

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

Find your Shop ID

Get your Access Token

Next, 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 Developer App#

Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.

Action#

Generate Match Report on Interzoid

Description:Generate a Match Report using a dataset table or file (CSV/TSV/Excel). [See the documentation](https://connect.interzoid.com/data-matching-workflow)

Version:0.0.1

Key:interzoid-generate-match-report

View on GitHub

Interzoid Overview#

The Interzoid API offers a plethora of data-driven APIs that enable you to enrich, standardize, and deduplicate data across various fields such as demographics, financials, and text. With these capabilities, you can enhance data quality, drive better analytics, and create more intelligent workflows and applications. In Pipedream, you can integrate these APIs into serverless workflows, triggering actions based on various events, manipulating and routing data to other apps, services, or data stores with ease.

Action Code#

import interzoid from "../../interzoid.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "interzoid-generate-match-report",
  name: "Generate Match Report",
  description: "Generate a Match Report using a dataset table or file (CSV/TSV/Excel). [See the documentation](https://connect.interzoid.com/data-matching-workflow)",
  version: "0.0.1",
  type: "action",
  props: {
    interzoid,
    category: {
      type: "string",
      label: "Matching Algorithm Type",
      description: "This category type indicates which set of Machine Learning and matching algorithms to make use of based on type of data content",
      options: constants.CATEGORY_OPTIONS,
    },
    source: {
      type: "string",
      label: "Database Connection Type",
      description: "Source of data, such as 'CSV', 'Snowflake', 'Postgres', etc.",
      options: constants.SOURCE_OPTIONS,
    },
    connection: {
      type: "string",
      label: "Connection String",
      description: "Connection string to access database, or in the case of a CSV or TSV file, use the full URL of the location of the file.",
    },
    table: {
      type: "string",
      label: "Table Name",
      description: "Table name to access the source data. Use \"CSV\" or \"TSV\" for delimited text files.",
    },
    column: {
      type: "string",
      label: "Match Column Name",
      description: "Column name within the table to access the source data. This is a number for CSV or TSV files, starting with number 1 from the left side of the file.",
    },
    reference: {
      type: "string",
      label: "Reference",
      description: "An additional column from the source table to display in the output results, such as a primary key.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.interzoid.generateMatchReport({
      $,
      params: {
        category: this.category,
        source: this.source,
        connection: this.connection,
        table: this.table,
        column: this.column,
        reference: this.reference,
      },
    });

    $.export("$summary", "Successfully generated match report");

    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
Interzoid	`interzoid`	`app`	This component uses the Interzoid app.
Matching Algorithm Type	`category`	`string`	Select a value from the drop down menu:`{ "label": "Company and Organization Names", "value": "company" }{ "label": "Individual Names", "value": "individual" }{ "label": "Street Addresses", "value": "address" }`
Database Connection Type	`source`	`string`	Select a value from the drop down menu:`AWS RDS/AuroraSnowflakeAzure SQLGoogle Cloud SQLDatabricksPostgreSQLMySQLMariaDBParquetCSVTSVExcel`
Connection String	`connection`	`string`	Connection string to access database, or in the case of a CSV or TSV file, use the full URL of the location of the file.
Table Name	`table`	`string`	Table name to access the source data. Use "CSV" or "TSV" for delimited text files.
Match Column Name	`column`	`string`	Column name within the table to access the source data. This is a number for CSV or TSV files, starting with number 1 from the left side of the file.
Reference	`reference`	`string`	An additional column from the source table to display in the output results, such as a primary key.

Action Authentication#

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

About Interzoid#

AI & ML-based Data Engineering in the Cloud for better data - Connect to Cloud database tables, CSVs, etc with data workloads running entirely in the Cloud.

More Ways to Connect Interzoid + Shopify Developer App#

Other Popular Integrations#

Generate Match Report with Interzoid API on New Article from Shopify Developer App API

Shopify Developer App + Interzoid