Bulk Import with Shopify (OAuth) API on Import Needs Review from Dromo API

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

Trigger workflow on

Import Needs Review from the Dromo API

Next, do this

Bulk Import 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 Dromo 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 Import Needs Review trigger
1. Connect your Dromo account
2. Configure timer
Configure the Bulk Import action
1. Connect your Shopify (OAuth) account
2. Configure alert
3. Configure Mutation
4. Configure File Path
5. Optional- Configure Client Identifier
6. Optional- Configure syncDir
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#

Import Needs Review on Dromo

Description:Emit new event when a headless import has issues and needs a review

Version:0.0.1

Key:dromo-import-needs-review

View on GitHub

Dromo Overview#

The Dromo API is a logistics and shipment tracking service that provides real-time data on shipments across carriers. With this API, you can tap into a vast network of shipping information, automate tracking processes, send notifications on shipment updates, and integrate your logistics data with other business systems. On Pipedream, you can create workflows that leverage the Dromo API to connect with various apps, automate shipment tracking updates, and streamline logistics processes.

Trigger Code#

import base from "../common/base.mjs";

export default {
  ...base,
  key: "dromo-import-needs-review",
  name: "Import Needs Review",
  description: "Emit new event when a headless import has issues and needs a review",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...base.methods,
    getResourceFn() {
      return this.dromo.listHeadlessImports;
    },
    isRelevant(item) {
      return item.status === "NEEDS_REVIEW";
    },
    generateMeta(item) {
      return {
        id: item.id,
        summary: `Import ${item.id} needs review`,
        ts: Date.parse(item.modified_date),
      };
    },
  },
};

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
Dromo	`dromo`	`app`	This component uses the Dromo app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About Dromo#

Dromo is a self-service data file importer that deploys in minutes. Embed in your app or trigger via API to handle csv, xls, xlsx and more.

Action#

Bulk Import on Shopify (OAuth)

Description:Execute bulk mutations by uploading a JSONL file containing mutation variables. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/bulkoperationrunmutation)

Version:0.0.4

Key:shopify-bulk-import

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 { axios } from "@pipedream/platform";
import fs from "fs";
import FormData from "form-data";

export default {
  key: "shopify-bulk-import",
  name: "Bulk Import",
  description: "Execute bulk mutations by uploading a JSONL file containing mutation variables. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/bulkoperationrunmutation)",
  version: "0.0.4",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    shopify,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Use the Shopify trigger \"New Event Emitted (Instant)\" with event type `bulk_operations/finish` to receive notifications when bulk imports are completed",
    },
    mutation: {
      type: "string",
      label: "Mutation",
      description: "The mutation to be executed in bulk. [See the documentation](https://shopify.dev/docs/api/usage/bulk-operations/imports) for a list of supported mutations. Example: `mutation call($input: ProductInput!) { productCreate(input: $input) { product { id title } } }`",
    },
    filePath: {
      type: "string",
      label: "File Path",
      description: "File path in the `/tmp` directory of a JSONL file including the variables for the mutation. Each line in the JSONL file represents one input unit. The mutation runs once on each line of the input file. [See the documentation](https://shopify.dev/docs/api/usage/bulk-operations/imports) for more information.",
    },
    clientIdentifier: {
      type: "string",
      label: "Client Identifier",
      description: "An optional identifier which may be used for querying",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  methods: {
    stagedUploadQuery() {
      return `
        mutation stagedUploadsCreate($input: [StagedUploadInput!]!) {
          stagedUploadsCreate(input: $input) {
            stagedTargets {
              url
              resourceUrl
              parameters {
                name
                value
              }
            }
          }
        }
      `;
    },
    bulkImportMutation() {
      return `
        mutation bulkOperationRunMutation($clientIdentifier: String, $mutation: String!, $stagedUploadPath: String!) {
          bulkOperationRunMutation(clientIdentifier: $clientIdentifier, mutation: $mutation, stagedUploadPath: $stagedUploadPath) {
            bulkOperation {
              id
              completedAt
              createdAt
              fileSize
              objectCount
              rootObjectCount
              partialDataUrl
              query
              status
              url
            }
            userErrors {
              field
              message
            }
          }
        }
      `;
    },
  },
  async run({ $ }) {
    const filePath = this.filePath.includes("/tmp")
      ? this.filePath
      : `/tmp/${this.filePath}`;
    const filename = filePath.split("/").pop();

    // create staged upload path

    const { stagedUploadsCreate: { stagedTargets } }
      = await this.shopify._makeGraphQlRequest(this.stagedUploadQuery(), {
        input: [
          {
            resource: "BULK_MUTATION_VARIABLES",
            filename,
            mimeType: "text/jsonl",
            httpMethod: "POST",
          },
        ],
      });

    const {
      url, parameters,
    } = stagedTargets[0];

    // upload file to staged upload path

    let stagedUploadPath;
    const form = new FormData();
    parameters.forEach(({
      name, value,
    }) => {
      form.append(name, value);
      if (name === "key") {
        stagedUploadPath = value;
      }
    });
    form.append("file", fs.createReadStream(filePath));

    await axios($, {
      url,
      method: "POST",
      headers: form.getHeaders(),
      data: form,
    });

    // perform bulk import

    const response = await this.shopify._makeGraphQlRequest(this.bulkImportMutation(), {
      mutation: this.mutation,
      stagedUploadPath,
      clientIdentifier: this.clientIdentifier,
    });

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

    $.export("$summary", "Successfully completed bulk import");
    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.
Mutation	`mutation`	`string`	The mutation to be executed in bulk. See the documentation for a list of supported mutations. Example: `mutation call($input: ProductInput!) { productCreate(input: $input) { product { id title } } }`
File Path	`filePath`	`string`	File path in the `/tmp` directory of a JSONL file including the variables for the mutation. Each line in the JSONL file represents one input unit. The mutation runs once on each line of the input file. See the documentation for more information.
Client Identifier	`clientIdentifier`	`string`	An optional identifier which may be used for querying
syncDir	`syncDir`	`dir`

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:

Bulk Import with Shopify (OAuth) API on Import Needs Review from Dromo API

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

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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