Add or Update Row with Orca Scan API on New Customer Created (Instant) from Shopify Developer App API

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

Trigger workflow on

New Customer Created (Instant) from the Shopify Developer App API

Next, do this

Add or Update Row with the Orca Scan 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 Orca Scan action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Customer Created (Instant) trigger
1. Connect your Shopify Developer App account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Add or Update Row action
1. Connect your Orca Scan account
2. Select a Sheet ID
3. Configure Row Data
4. Optional- Configure Barcode
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 Customer Created (Instant) on Shopify Developer App

Description:Emit new event for each new customer added to a store.

Version:0.0.2

Key:shopify_developer_app-new-customer-created

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-customer-created",
  name: "New Customer Created (Instant)",
  type: "source",
  description: "Emit new event for each new customer added to a store.",
  version: "0.0.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.CUSTOMERS_CREATE;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.created_at);
      return {
        id: resource.id,
        summary: `New Customer ${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#

Add or Update Row on Orca Scan

Description:Adds a new row or updates an existing row in a sheet. [See the documentation](https://orcascan.com/guides/add-barcode-tracking-to-your-system-using-a-rest-api-f09a21c3)

Version:0.0.1

Key:orca_scan-add-update-row

View on GitHub

Orca Scan Overview#

The Orca Scan API is a gateway to integrate barcode scanning and inventory management capabilities into various workflows. By leveraging the API, you can automate data collection, streamline inventory tracking, and sync your barcode scanning data with other systems. When used on Pipedream, you can merge Orca Scan functionalities with countless other apps, creating custom automation rules, processing data, and managing inventory in real-time. Ideal for inventory management, asset tracking, and data collection automation, the Orca Scan API is a tool that can adapt to a myriad of business needs.

Action Code#

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

export default {
  key: "orca_scan-add-update-row",
  name: "Add or Update Row",
  description: "Adds a new row or updates an existing row in a sheet. [See the documentation](https://orcascan.com/guides/add-barcode-tracking-to-your-system-using-a-rest-api-f09a21c3)",
  version: "0.0.1",
  type: "action",
  props: {
    orca_scan,
    sheetId: {
      propDefinition: [
        orca_scan,
        "sheetId",
      ],
    },
    rowData: {
      propDefinition: [
        orca_scan,
        "rowData",
      ],
    },
    barcode: {
      propDefinition: [
        orca_scan,
        "barcode",
      ],
    },
  },
  async run({ $ }) {
    let rowId = null;

    // Check if a row with the given barcode exists
    if (this.barcode) {
      const { data } = await this.orca_scan.listRows({
        sheetId: this.sheetId,
        params: {
          barcode: this.barcode || null,
        },
      });
      if (data.length > 0) {
        const row = data[0];
        // Assume the first row is the one to update
        rowId = row._id;
        for (const [
          key,
          value,
        ] of Object.entries(this.rowData)) {
          row[key] = value;
        }
        this.rowData = row;
      } else {
        this.rowData.barcode = this.barcode;
      }
    }

    if (!this.rowData.date) this.rowData.date = new Date();

    // Make the request to add or update the row
    const response = await this.orca_scan.addOrUpdateRow({
      sheetId: this.sheetId,
      data: this.rowData,
      rowId: rowId,
    });

    $.export("$summary", `Successfully ${rowId
      ? "updated"
      : "added"} row with ID: ${response.data?._id}`);
    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
Orca Scan	`orca_scan`	`app`	This component uses the Orca Scan app.
Sheet ID	`sheetId`	`string`	Select a value from the drop down menu.
Row Data	`rowData`	`object`	The data for the new row to be added or updated. To get the fields, use the `Find Row` action to find a row and refer to the JSON output.
Barcode	`barcode`	`string`	The barcode value to locate a specific row record. If the barcode is not found, a new row will be created. If the barcode is found, the row will be updated with the data in `Row Data`.