Create Or Update Order with AmeriCommerce API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create Or Update Order 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 Typeform 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 New Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Create Or Update Order action
1. Connect your AmeriCommerce account
2. Optional- Select a Order ID
3. Optional- Select a Customer ID
4. Optional- Select a Order Status ID
5. Optional- Select a Order Shipping Address ID
6. Optional- Select a Order Billing Address ID
7. Optional- Select a Customer Type ID
8. Optional- Configure Special Instructions
9. Optional- Configure Subtotal
10. Optional- Configure Tax Total
11. Optional- Configure Shipping Total
12. Optional- Configure Discount Total
13. Optional- Configure Grand Total
14. Optional- Configure Cost Total
15. Optional- Select a Selected Shipping Method
16. Optional- Configure Referrer
17. Optional- Configure Admin Comments
18. Optional- Configure Source
19. Optional- Configure Search Phrase
20. Optional- Select a Store ID
21. Optional- Configure Is PPC
22. Optional- Configure PPC Keyword
23. Optional- Configure Handling Total
24. Optional- Configure Is Payment Order Only
25. Optional- Configure Selected Shipping Provider Service
26. Optional- Configure Additional Fees
27. Optional- Select a Adcode ID
28. Optional- Configure Is Gift
29. Optional- Configure Gift Message
30. Optional- Configure Public Comments
31. Optional- Configure Instructions
32. Optional- Configure Source Group
33. Optional- Select a From Subscription ID
34. Optional- Configure Discounted Shipping Total
35. Optional- Configure Order Number
36. Optional- Configure Coupon Code
37. Optional- Configure Order Type
38. Optional- Configure Expires
39. Optional- Configure Campaign Code
40. Optional- Configure Reward Points Credited
41. Optional- Select a Channel
42. Optional- Configure Device
43. Optional- Configure Due Date
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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Create Or Update Order on AmeriCommerce

Description:Creates a new order or updates an existing one. [See the documentation here](https://developers.cart.com/docs/rest-api/3f2ab73188031-create-an-order) and [here](https://developers.cart.com/docs/rest-api/e2649bb3adba9-update-an-order).

Version:0.0.1

Key:americommerce-create-update-order

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import app from "../../americommerce.app.mjs";

export default {
  key: "americommerce-create-update-order",
  name: "Create Or Update Order",
  description: "Creates a new order or updates an existing one. [See the documentation here](https://developers.cart.com/docs/rest-api/3f2ab73188031-create-an-order) and [here](https://developers.cart.com/docs/rest-api/e2649bb3adba9-update-an-order).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    orderId: {
      propDefinition: [
        app,
        "orderId",
      ],
    },
    customerId: {
      optional: true,
      propDefinition: [
        app,
        "customerId",
      ],
    },
    orderStatusId: {
      propDefinition: [
        app,
        "orderStatusId",
      ],
    },
    orderShippingAddressId: {
      label: "Order Shipping Address ID",
      description: "The ID of the order's shipping address.",
      propDefinition: [
        app,
        "orderAddressId",
      ],
    },
    orderBillingAddressId: {
      label: "Order Billing Address ID",
      description: "The ID of the order's billing address.",
      propDefinition: [
        app,
        "orderAddressId",
      ],
    },
    customerTypeId: {
      propDefinition: [
        app,
        "customerTypeId",
      ],
    },
    specialInstructions: {
      type: "string",
      label: "Special Instructions",
      description: "Special instructions for the order.",
      optional: true,
    },
    subtotal: {
      type: "string",
      label: "Subtotal",
      description: "The subtotal of the order.",
      optional: true,
    },
    taxTotal: {
      type: "string",
      label: "Tax Total",
      description: "The total tax for the order or tax added to the order.",
      optional: true,
    },
    shippingTotal: {
      type: "string",
      label: "Shipping Total",
      description: "The total shipping cost for the order or shipping added to the order.",
      optional: true,
    },
    discountTotal: {
      type: "string",
      label: "Discount Total",
      description: "The total discount for the order.",
      optional: true,
    },
    grandTotal: {
      type: "string",
      label: "Grand Total",
      description: "The grand total of the order.",
      optional: true,
    },
    costTotal: {
      type: "string",
      label: "Cost Total",
      description: "The total cost of the order.",
      optional: true,
    },
    selectedShippingMethod: {
      label: "Selected Shipping Method",
      description: "The selected shipping method for the order.",
      propDefinition: [
        app,
        "shippingMethodId",
        () => ({
          mapper: ({
            shipping_method_id: value,
            shipping_method: label,
          }) => ({
            label,
            value: String(value),
          }),
        }),
      ],
    },
    referrer: {
      type: "string",
      label: "Referrer",
      description: "The referrer for the order.",
      optional: true,
    },
    adminComments: {
      type: "string",
      label: "Admin Comments",
      description: "Comments from the admin about the order.",
      optional: true,
    },
    source: {
      type: "string",
      label: "Source",
      description: "The source of the order.",
      optional: true,
    },
    searchPhrase: {
      type: "string",
      label: "Search Phrase",
      description: "The search phrase for the order.",
      optional: true,
    },
    storeId: {
      propDefinition: [
        app,
        "storeId",
      ],
    },
    isPpc: {
      type: "boolean",
      label: "Is PPC",
      description: "Whether the order is a PPC order.",
      optional: true,
    },
    ppcKeyword: {
      type: "string",
      label: "PPC Keyword",
      description: "The PPC keyword for the order.",
      optional: true,
    },
    handlingTotal: {
      type: "string",
      label: "Handling Total",
      description: "The handling total for the order.",
      optional: true,
    },
    isPaymentOrderOnly: {
      type: "boolean",
      label: "Is Payment Order Only",
      description: "Whether the order is a payment order only.",
      optional: true,
    },
    selectedShippingProviderService: {
      type: "string",
      label: "Selected Shipping Provider Service",
      description: "The selected shipping provider service for the order.",
      optional: true,
    },
    additionalFees: {
      type: "string",
      label: "Additional Fees",
      description: "Additional fees for the order.",
      optional: true,
    },
    adcodeId: {
      propDefinition: [
        app,
        "adcodeId",
      ],
    },
    isGift: {
      type: "boolean",
      label: "Is Gift",
      description: "Whether the order is a gift.",
      optional: true,
    },
    giftMessage: {
      type: "string",
      label: "Gift Message",
      description: "The gift message for the order.",
      optional: true,
    },
    publicComments: {
      type: "string",
      label: "Public Comments",
      description: "Public comments about the order.",
      optional: true,
    },
    instructions: {
      type: "string",
      label: "Instructions",
      description: "Instructions for the order.",
      optional: true,
    },
    sourceGroup: {
      type: "string",
      label: "Source Group",
      description: "The source group for the order.",
      optional: true,
    },
    fromSubscriptionId: {
      label: "From Subscription ID",
      description: "The ID of the subscription.",
      propDefinition: [
        app,
        "subscriptionId",
      ],
    },
    discountedShippingTotal: {
      type: "string",
      label: "Discounted Shipping Total",
      description: "The discounted shipping total for the order.",
      optional: true,
    },
    orderNumber: {
      type: "string",
      label: "Order Number",
      description: "The order number.",
      optional: true,
    },
    couponCode: {
      type: "string",
      label: "Coupon Code",
      description: "The coupon code for the order.",
      optional: true,
    },
    orderType: {
      type: "string",
      label: "Order Type",
      description: "The type of order.",
      optional: true,
    },
    expires: {
      type: "boolean",
      label: "Expires",
      description: "Whether the order expires.",
      optional: true,
    },
    campaignCode: {
      type: "string",
      label: "Campaign Code",
      description: "The campaign code for the order.",
      optional: true,
    },
    rewardPointsCredited: {
      type: "boolean",
      label: "Reward Points Credited",
      description: "Whether the reward points are credited.",
      optional: true,
    },
    channel: {
      type: "string",
      label: "Channel",
      description: "The channel for the order.",
      optional: true,
      options: [
        "Online",
        "InStore",
        "Chat",
        "Phone",
        "Email",
      ],
    },
    device: {
      type: "string",
      label: "Device",
      description: "The device for the order.",
      optional: true,
    },
    dueDate: {
      type: "string",
      label: "Due Date",
      description: "The due date for the order. Eg. `2021-05-14`",
      optional: true,
    },
  },
  methods: {
    createOrder(args = {}) {
      return this.app.post({
        path: "/orders",
        ...args,
      });
    },
    updateOrder({
      orderId, ...args
    } = {}) {
      return this.app.put({
        path: `/orders/${orderId}`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createOrder,
      updateOrder,
      orderId,
      customerId,
      orderStatusId,
      orderShippingAddressId,
      orderBillingAddressId,
      customerTypeId,
      specialInstructions,
      subtotal,
      taxTotal,
      shippingTotal,
      discountTotal,
      grandTotal,
      costTotal,
      selectedShippingMethod,
      referrer,
      adminComments,
      source,
      searchPhrase,
      storeId,
      isPpc,
      ppcKeyword,
      handlingTotal,
      isPaymentOrderOnly,
      selectedShippingProviderService,
      additionalFees,
      adcodeId,
      isGift,
      giftMessage,
      publicComments,
      instructions,
      sourceGroup,
      fromSubscriptionId,
      discountedShippingTotal,
      orderNumber,
      couponCode,
      orderType,
      expires,
      campaignCode,
      rewardPointsCredited,
      channel,
      device,
      dueDate,
    } = this;

    const isCreate = !orderId;

    if (
      isCreate
        && (
          !customerId
          || !orderStatusId
          || !orderShippingAddressId
          || !orderBillingAddressId
          || !taxTotal
          || !shippingTotal
        )
    ) {
      throw new ConfigurationError("The **Customer ID**, **Order Status ID**, **Order Shipping Address ID**, **Order Billing Address ID**, **Tax Total**, and **Shipping Total** are required to create a new order.");
    }

    const data = {
      customer_id: customerId,
      order_status_id: orderStatusId,
      order_shipping_address_id: orderShippingAddressId,
      order_billing_address_id: orderBillingAddressId,
      customer_type_id: customerTypeId,
      special_instructions: specialInstructions,
      subtotal,
      tax_total: taxTotal,
      shipping_total: shippingTotal,
      discount_total: discountTotal,
      grand_total: grandTotal,
      cost_total: costTotal,
      selected_shipping_method: selectedShippingMethod,
      referrer,
      admin_comments: adminComments,
      source,
      search_phrase: searchPhrase,
      store_id: storeId,
      is_ppc: isPpc,
      ppc_keyword: ppcKeyword,
      handling_total: handlingTotal,
      is_payment_order_only: isPaymentOrderOnly,
      selected_shipping_provider_service: selectedShippingProviderService,
      additional_fees: additionalFees,
      adcode_id: adcodeId,
      is_gift: isGift,
      gift_message: giftMessage,
      public_comments: publicComments,
      instructions,
      source_group: sourceGroup,
      from_subscription_id: fromSubscriptionId,
      discounted_shipping_total: discountedShippingTotal,
      order_number: orderNumber,
      coupon_code: couponCode,
      order_type: orderType,
      expires,
      campaign_code: campaignCode,
      reward_points_credited: rewardPointsCredited,
      channel,
      device,
      due_date: dueDate,
    };

    if (isCreate) {
      const response = await createOrder({
        $,
        data,
      });
      $.export("$summary", `Successfully created the order with ID \`${response.id}\`.`);
      return response;
    }

    const response = await updateOrder({
      $,
      orderId,
      data,
    });
    $.export("$summary", `Successfully updated the order 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 ID	`orderId`	`string`	Select a value from the drop down menu.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Order Status ID	`orderStatusId`	`string`	Select a value from the drop down menu.
Order Shipping Address ID	`orderShippingAddressId`	`string`	Select a value from the drop down menu.
Order Billing Address ID	`orderBillingAddressId`	`string`	Select a value from the drop down menu.
Customer Type ID	`customerTypeId`	`string`	Select a value from the drop down menu.
Special Instructions	`specialInstructions`	`string`	Special instructions for the order.
Subtotal	`subtotal`	`string`	The subtotal of the order.
Tax Total	`taxTotal`	`string`	The total tax for the order or tax added to the order.
Shipping Total	`shippingTotal`	`string`	The total shipping cost for the order or shipping added to the order.
Discount Total	`discountTotal`	`string`	The total discount for the order.
Grand Total	`grandTotal`	`string`	The grand total of the order.
Cost Total	`costTotal`	`string`	The total cost of the order.
Selected Shipping Method	`selectedShippingMethod`	`string`	Select a value from the drop down menu.
Referrer	`referrer`	`string`	The referrer for the order.
Admin Comments	`adminComments`	`string`	Comments from the admin about the order.
Source	`source`	`string`	The source of the order.
Search Phrase	`searchPhrase`	`string`	The search phrase for the order.
Store ID	`storeId`	`string`	Select a value from the drop down menu.
Is PPC	`isPpc`	`boolean`	Whether the order is a PPC order.
PPC Keyword	`ppcKeyword`	`string`	The PPC keyword for the order.
Handling Total	`handlingTotal`	`string`	The handling total for the order.
Is Payment Order Only	`isPaymentOrderOnly`	`boolean`	Whether the order is a payment order only.
Selected Shipping Provider Service	`selectedShippingProviderService`	`string`	The selected shipping provider service for the order.
Additional Fees	`additionalFees`	`string`	Additional fees for the order.
Adcode ID	`adcodeId`	`string`	Select a value from the drop down menu.
Is Gift	`isGift`	`boolean`	Whether the order is a gift.
Gift Message	`giftMessage`	`string`	The gift message for the order.
Public Comments	`publicComments`	`string`	Public comments about the order.
Instructions	`instructions`	`string`	Instructions for the order.
Source Group	`sourceGroup`	`string`	The source group for the order.
From Subscription ID	`fromSubscriptionId`	`string`	Select a value from the drop down menu.
Discounted Shipping Total	`discountedShippingTotal`	`string`	The discounted shipping total for the order.
Order Number	`orderNumber`	`string`	The order number.
Coupon Code	`couponCode`	`string`	The coupon code for the order.
Order Type	`orderType`	`string`	The type of order.
Expires	`expires`	`boolean`	Whether the order expires.
Campaign Code	`campaignCode`	`string`	The campaign code for the order.
Reward Points Credited	`rewardPointsCredited`	`boolean`	Whether the reward points are credited.
Channel	`channel`	`string`	Select a value from the drop down menu:`OnlineInStoreChatPhoneEmail`
Device	`device`	`string`	The device for the order.
Due Date	`dueDate`	`string`	The due date for the order. Eg. `2021-05-14`

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.