Change Order Status with AmeriCommerce API on Card Due Date Reminder from Pipedream API

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

Trigger workflow on

Card Due Date Reminder from the Pipedream API

Next, do this

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

Select this integration
Configure the Card Due Date Reminder trigger
1. Connect your Pipedream account
2. Connect your Pipedream account
3. Select a Board
4. Select a Time Before
Configure the Change Order Status action
1. Connect your AmeriCommerce account
2. Select a Order Status ID
3. Optional- Configure Name
4. Optional- Configure Is Open
5. Optional- Configure Is Declined
6. Optional- Configure Is Cancelled
7. Optional- Configure Is Shipped
8. Optional- Configure Color
9. Optional- Select a Email Template ID
10. Optional- Configure Is Fully Refunded
11. Optional- Configure Is Partially Refunded
12. Optional- Configure Is Quote Status
13. Optional- Configure Is Partially Shipped
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#

Card Due Date Reminder on Pipedream

Description:Emit new event at a specified time before a card is due.

Version:0.1.1

Key:trello-card-due-date-reminder

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import taskScheduler from "../../../pipedream/sources/new-scheduled-tasks/new-scheduled-tasks.mjs";
import trello from "../../trello.app.mjs";
import ms from "ms";
import constants from "../../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "trello-card-due-date-reminder",
  name: "Card Due Date Reminder", /* eslint-disable-line pipedream/source-name */
  description: "Emit new event at a specified time before a card is due.",
  version: "0.1.1",
  type: "source",
  dedupe: "unique",
  props: {
    pipedream: taskScheduler.props.pipedream,
    trello,
    db: "$.service.db",
    http: "$.interface.http",
    board: {
      propDefinition: [
        trello,
        "board",
      ],
    },
    timeBefore: {
      type: "string",
      label: "Time Before",
      description: "How far before the due time the event should trigger. For example, `5 minutes`, `10 minutes`, `1 hour`.",
      default: "5 minutes",
      options: constants.NOTIFICATION_TIMES,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.timeBefore) {
      props.timer = {
        type: "$.interface.timer",
        description: "Poll the API to schedule alerts for any newly created events",
        default: {
          intervalSeconds: ms(this.timeBefore) / 1000,
        },
      };
    }
    return props;
  },
  hooks: {
    async deactivate() {
      const ids = this._getScheduledEventIds();
      if (!ids?.length) {
        return;
      }
      for (const id of ids) {
        if (await this.deleteEvent({
          body: {
            id,
          },
        })) {
          console.log("Cancelled scheduled event");
        }
      }
      this._setScheduledEventIds();
    },
  },
  methods: {
    ...taskScheduler.methods,
    generateMeta({
      id, name: summary,
    }, now) {
      return {
        id,
        summary,
        ts: now,
      };
    },
    _getScheduledEventIds() {
      return this.db.get("scheduledEventIds");
    },
    _setScheduledEventIds(ids) {
      this.db.set("scheduledEventIds", ids);
    },
    _getScheduledCardIds() {
      return this.db.get("scheduledCardIds");
    },
    _setScheduledCardIds(ids) {
      this.db.set("scheduledCardIds", ids);
    },
    _hasDeployed() {
      const result = this.db.get("hasDeployed");
      this.db.set("hasDeployed", true);
      return result;
    },
    emitEvent(card, now) {
      const meta = this.generateMeta(card, now);
      this.$emit(card, meta);
    },
  },
  async run(event) {
    const now = event.timestamp * 1000;

    // self subscribe only on the first time
    if (!this._hasDeployed()) {
      await this.selfSubscribe();
    }

    let scheduledEventIds = this._getScheduledEventIds() || [];

    // incoming scheduled event
    if (event.$channel === this.selfChannel()) {
      const remainingScheduledEventIds = scheduledEventIds.filter((id) => id !== event["$id"]);
      this._setScheduledEventIds(remainingScheduledEventIds);
      this.emitEvent(event, now);
      return;
    }

    // schedule new events
    const scheduledCardIds = this._getScheduledCardIds() || {};
    const cards = await this.trello.getCards({
      boardId: this.board,
    });

    for (const card of cards) {
      const dueDate = card.due
        ? new Date(card.due)
        : null;
      if (!dueDate || dueDate.getTime() < Date.now()) {
        delete scheduledCardIds[card.id];
        continue;
      }

      const later = new Date(dueDate.getTime() - ms(this.timeBefore));

      if (scheduledCardIds[card.id]) {
        // reschedule if card's due date has changed
        if (card.due !== scheduledCardIds[card.id].dueDate) {
          await this.deleteEvent({
            body: {
              id: scheduledCardIds[card.id].eventId,
            },
          });
          scheduledEventIds = scheduledEventIds
            .filter((id) => id !== scheduledCardIds[card.id].eventId);
        } else {
          continue;
        }
      }

      const scheduledEventId = this.emitScheduleEvent(card, later);
      scheduledEventIds.push(scheduledEventId);
      scheduledCardIds[card.id] = {
        eventId: scheduledEventId,
        dueDate: card.due,
      };
    }
    this._setScheduledEventIds(scheduledEventIds);
    this._setScheduledCardIds(scheduledCardIds);
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Pipedream	`trello`	`app`	This component uses the Pipedream 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.
Board	`board`	`string`	Select a value from the drop down menu.
Time Before	`timeBefore`	`string`	Select a value from the drop down menu:`5 minutes10 minutes15 minutes30 minutes1 hour2 hours3 hours6 hours12 hours1 day2 days3 days1 week`

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Change Order Status on AmeriCommerce

Description:Changes the status of an existing order. [See the documentation](https://developers.cart.com/docs/rest-api/6898d9f254dfb-update-an-order-status).

Version:0.0.1

Key:americommerce-change-order-status

View on GitHub

Action Code#

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

export default {
  key: "americommerce-change-order-status",
  name: "Change Order Status",
  description: "Changes the status of an existing order. [See the documentation](https://developers.cart.com/docs/rest-api/6898d9f254dfb-update-an-order-status).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    orderStatusId: {
      optional: false,
      propDefinition: [
        app,
        "orderStatusId",
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the order status.",
      optional: true,
    },
    isOpen: {
      type: "boolean",
      label: "Is Open",
      description: "Indicates whether the order status is open.",
      optional: true,
    },
    isDeclined: {
      type: "boolean",
      label: "Is Declined",
      description: "Indicates whether the order status is declined.",
      optional: true,
    },
    isCancelled: {
      type: "boolean",
      label: "Is Cancelled",
      description: "Indicates whether the order status is cancelled.",
      optional: true,
    },
    isShipped: {
      type: "boolean",
      label: "Is Shipped",
      description: "Indicates whether the order status is shipped.",
      optional: true,
    },
    color: {
      type: "string",
      label: "Color",
      description: "The color of the order status.",
      optional: true,
    },
    emailTemplateId: {
      propDefinition: [
        app,
        "emailTemplateId",
      ],
    },
    isFullyRefunded: {
      type: "boolean",
      label: "Is Fully Refunded",
      description: "Indicates whether the order status is fully refunded.",
      optional: true,
    },
    isPartiallyRefunded: {
      type: "boolean",
      label: "Is Partially Refunded",
      description: "Indicates whether the order status is partially refunded.",
      optional: true,
    },
    isQuoteStatus: {
      type: "boolean",
      label: "Is Quote Status",
      description: "Indicates whether the order status is a quote status.",
      optional: true,
    },
    isPartiallyShipped: {
      type: "boolean",
      label: "Is Partially Shipped",
      description: "Indicates whether the order status is partially shipped.",
      optional: true,
    },
  },
  methods: {
    changeOrderStatus({
      orderStatusId, ...args
    } = {}) {
      return this.app.put({
        path: `/order_statuses/${orderStatusId}`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      changeOrderStatus,
      orderStatusId,
      name,
      isOpen,
      isDeclined,
      isCancelled,
      isShipped,
      color,
      emailTemplateId,
      isFullyRefunded,
      isPartiallyRefunded,
      isQuoteStatus,
      isPartiallyShipped,
    } = this;

    const response = await changeOrderStatus({
      $,
      orderStatusId,
      data: {
        name,
        is_open: isOpen,
        is_declined: isDeclined,
        is_cancelled: isCancelled,
        is_shipped: isShipped,
        color,
        email_template_id: emailTemplateId,
        is_fully_refunded: isFullyRefunded,
        is_partially_refunded: isPartiallyRefunded,
        is_quote_status: isQuoteStatus,
        is_partially_shipped: isPartiallyShipped,
      },
    });
    $.export("$summary", `Successfully changed the order status with ID \`${response.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
AmeriCommerce	`app`	`app`	This component uses the AmeriCommerce app.
Order Status ID	`orderStatusId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the order status.
Is Open	`isOpen`	`boolean`	Indicates whether the order status is open.
Is Declined	`isDeclined`	`boolean`	Indicates whether the order status is declined.
Is Cancelled	`isCancelled`	`boolean`	Indicates whether the order status is cancelled.
Is Shipped	`isShipped`	`boolean`	Indicates whether the order status is shipped.
Color	`color`	`string`	The color of the order status.
Email Template ID	`emailTemplateId`	`string`	Select a value from the drop down menu.
Is Fully Refunded	`isFullyRefunded`	`boolean`	Indicates whether the order status is fully refunded.
Is Partially Refunded	`isPartiallyRefunded`	`boolean`	Indicates whether the order status is partially refunded.
Is Quote Status	`isQuoteStatus`	`boolean`	Indicates whether the order status is a quote status.
Is Partially Shipped	`isPartiallyShipped`	`boolean`	Indicates whether the order status is partially shipped.

Action Authentication#

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

About AmeriCommerce#

The B2B Commerce Platform for Digital Transformations.

More Ways to Connect AmeriCommerce + Pipedream#

Other Popular Integrations#

Change Order Status with AmeriCommerce API on New Scheduled Tasks from Pipedream API

Pipedream + AmeriCommerce

Change Order Status with AmeriCommerce API on Card Due Date Reminder from Pipedream API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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