Create Order with Square API on New Order from Mailchimp API

Pipedream makes it easy to connect APIs for Square, Mailchimp and 2,900+ other apps remarkably fast.

Trigger workflow on

New Order from the Mailchimp API

Next, do this

Create Order with the Square 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 Mailchimp trigger and Square action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Order trigger
1. Connect your Mailchimp account
2. Configure timer
3. Select a Store Id
4. Select a Campaign ID
5. Optional- Select a Customer Id
6. Select a Has Outreach?
7. Optional- Select a Outreach Id
Configure the Create Order action
1. Connect your Square account
2. Select a Location
3. Optional- Select a Customer
4. Optional- Configure Reference ID
5. Optional- Configure Line Items
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 Order on Mailchimp

Description:Emit new event when an order is added to your store, or Mailchimp account.

Version:0.0.2

Key:mailchimp-new-order

View on GitHub

Mailchimp Overview#

The Mailchimp API taps into the heart of your email marketing efforts, allowing you to manage subscribers, campaigns, and reports. With the API, you can automate tasks like syncing subscriber lists, segmenting contacts based on behavior, and personalizing email content to match user profiles. It's a powerful tool for marketers looking to fine-tune their email strategy and maximize engagement.

Trigger Code#

import common from "../common/timer-based.mjs";
import constants from "../constants.mjs";

export default {
  ...common,
  key: "mailchimp-new-order",
  name: "New Order",
  description: "Emit new event when an order is added to your store, or Mailchimp account.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    storeId: {
      propDefinition: [
        common.props.mailchimp,
        "storeId",
      ],
      description: "The unique ID of the store you'd like to watch for new orders",
    },
    campaignId: {
      propDefinition: [
        common.props.mailchimp,
        "campaignId",
      ],
      description: "Watch only for new orders with a specific Campaign Id value.",
    },
    customerId: {
      type: "string",
      label: "Customer Id",
      description: "Watch only for new orders made by a specific customer with this unique ID",
      optional: true,
      useQuery: true,
      async options({ page }) {
        const count = constants.PAGE_SIZE;
        const offset = count * page;
        const config = {
          count,
          offset,
        };
        const customersResults =  await this.mailchimp.getAllStoreCustomers(this.storeId, config);
        if (customersResults.customers) {
          return customersResults.customers.map((customer) => ({
            label: `${customer.first_name} ${customer.last_name}`,
            value: customer.id,
          }));
        } else {
          return [];
        }
      },
    },
    hasOutreach: {
      type: "string",
      label: "Has Outreach?",
      description: "Watch only for new orders that have an outreach attached. For example, an email campaign or Facebook ad",
      options: constants.ORDER_HAS_OUTREACH_CHOICES,
      default: "Both",
    },
    outreachId: {
      type: "string",
      label: "Outreach Id",
      description: "Ignored if `hasOutreach` is marked as 'No'",
      optional: true,
      useQuery: true,
      async options({ page }) {
        const count = constants.PAGE_SIZE;
        const offset = count * page;
        const config = {
          count,
          offset,
        };
        const outreachResults =  await this.mailchimp.getAllFacebookAds(config);
        return outreachResults.facebook_ads.map((outreach) => ({
          label: outreach.name,
          value: outreach.id,
        }));
      },
    },
  },
  hooks: {
    async deploy() {
      this._clearProcessedIds();
      const processedIds = new Set(this._getProcessedIds());
      // Emits sample events on the first run during deploy.
      const count = 10;
      const config = {
        count,
        offset: 0,
        campaignId: this.campaignId,
        outreachId: this.outreachId,
        customerId: this.customerId,
        hasOutreach: this.hasOutreach,
      };
      const orderStream = this.mailchimp.getOrderStream(this.storeId, config);
      let i = 0;
      for await (const order of orderStream) {
        if (i < count) {
          this.processEvent(order);
          processedIds.add(order.id);// Mark customer as successfully processed
          this._setProcessedIds(processedIds);
        }
        i++;
      }
    },
  },
  methods: {
    ...common.methods,
    generateMeta(eventPayload) {
      const ts = Date.parse(eventPayload.created_at);
      return {
        id: eventPayload.id,
        summary: "A new order has been submitted.",
        ts,
      };
    },
    _clearProcessedIds() {
      return this.db.set("processedIds", []);
    },
    _getProcessedIds() {
      return this.db.get("processedIds");
    },
    _setProcessedIds(processedIds) {
      this.db.set("processedIds", Array.from(processedIds));
    },
  },
  async run() {
    const processedIds = new Set(this._getProcessedIds());
    const config = {
      count: constants.PAGE_SIZE,
      offset: 0,
    };
    const orderStream = this.mailchimp.getOrderStream(this.storeId, config);
    for await (const order of orderStream) {
      if (processedIds.has(order.id)) {
        continue;
      }
      this.processEvent(order);
      processedIds.add(order.id);// Mark order as successfully processed
      this._setProcessedIds(processedIds);
    }
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Mailchimp	`mailchimp`	`app`	This component uses the Mailchimp app.
	`timer`	`$.interface.timer`
Store Id	`storeId`	`string`	Select a value from the drop down menu.
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
Customer Id	`customerId`	`string`	Select a value from the drop down menu.
Has Outreach?	`hasOutreach`	`string`	Select a value from the drop down menu:`YesNoBoth`
Outreach Id	`outreachId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Mailchimp uses OAuth authentication. When you connect your Mailchimp account, Pipedream will open a popup window where you can sign into Mailchimp and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Mailchimp API.

Pipedream requests the following authorization scopes when you connect your account:

About Mailchimp#

Mailchimp is a marketing automation and email marketing platform.

Action#

Create Order on Square

Description:Creates a new order that can include information about products for purchase. [See docs here](https://developer.squareup.com/reference/square/orders-api/create-order).

Version:0.0.4

Key:square-create-order

View on GitHub

Square Overview#

The Square API opens up a realm of possibilities for merchants to effortlessly manage their sales, inventory, customers, and payments. With Pipedream, you can automate actions based on events in Square, such as new transactions, updated orders, or customer profile changes. Craft custom workflows that react in real-time, sync data across platforms, or streamline reporting. Through Pipedream's serverless platform, you can connect Square with countless other apps without writing extensive code, turning manual tasks into automated, efficient processes.

Action Code#

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

export default {
  key: "square-create-order",
  name: "Create Order",
  description: "Creates a new order that can include information about products for purchase. [See docs here](https://developer.squareup.com/reference/square/orders-api/create-order).",
  type: "action",
  version: "0.0.4",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    square,
    location: {
      propDefinition: [
        square,
        "location",
      ],
    },
    customer: {
      propDefinition: [
        square,
        "customer",
      ],
      optional: true,
    },
    referenceId: {
      propDefinition: [
        square,
        "referenceId",
      ],
    },
    lineItems: {
      type: "object",
      label: "Line Items",
      description: "The line items included in the order. Please insert an array of `OrderLineItem`s as a custom expression. For example: `{{ [{\"quantity\": \"1\", \"name\": \"Item 1\", \"base_price_money\":  {amount: 1, currency: \"USD\"} }, {\"quantity\": \"2\", \"name\": \"Item 2\", \"base_price_money\": {amount: 2, currency: \"USD\"} }] }}`. [See docs here](https://developer.squareup.com/reference/square/objects/OrderLineItem)",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.square.createOrder({
      $,
      generateIdempotencyKey: true,
      data: {
        order: {
          location_id: this.location,
          customer_id: this.customer,
          reference_id: this.referenceId,
          line_items: typeof this.lineItems === "string"
            ? JSON.parse(this.lineItems)
            : this.lineItems,
        },
      },
    });
    $.export("$summary", "Successfully created order");
    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
Square	`square`	`app`	This component uses the Square app.
Location	`location`	`string`	Select a value from the drop down menu.
Customer	`customer`	`string`	Select a value from the drop down menu.
Reference ID	`referenceId`	`string`	An optional second ID used to associate the customer profile with an entity in another system
Line Items	`lineItems`	`object`	The line items included in the order. Please insert an array of `OrderLineItem`s as a custom expression. For example: `{{ [{"quantity": "1", "name": "Item 1", "base_price_money": {amount: 1, currency: "USD"} }, {"quantity": "2", "name": "Item 2", "base_price_money": {amount: 2, currency: "USD"} }] }}`. See docs here

Action Authentication#

Square uses OAuth authentication. When you connect your Square account, Pipedream will open a popup window where you can sign into Square and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Square API.

Pipedream requests the following authorization scopes when you connect your account:

CUSTOMERS_READCUSTOMERS_WRITEPAYMENTS_READPAYMENTS_WRITEORDERS_READORDERS_WRITESUBSCRIPTIONS_READSUBSCRIPTIONS_WRITEITEMS_READITEMS_WRITEINVOICES_READINVOICES_WRITELOYALTY_READLOYALTY_WRITEEMPLOYEES_READEMPLOYEES_WRITEMERCHANT_PROFILE_READBANK_ACCOUNTS_READSETTLEMENTS_READDEVELOPER_APPLICATION_WEBHOOKS_WRITEAPPOINTMENTS_ALL_READAPPOINTMENTS_READ

Create Order with Square API on New Order from Mailchimp API

Pipedream makes it easy to connect APIs for Square, Mailchimp 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