Create Order with SmartRoutes API on New Abandoned Cart from Shopify Developer App API

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

Trigger workflow on

New Abandoned Cart from the Shopify Developer App API

Next, do this

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

Select this integration
Configure the New Abandoned Cart trigger
1. Connect your Shopify Developer App account
2. Configure timer
Configure the Create Order action
1. Connect your SmartRoutes account
2. Configure Order Number
3. Select a Customer Account Number
4. Select a Type
5. Optional- Configure Delivery Contact Name
6. Optional- Configure Delivery Contact Number
7. Optional- Configure Delivery Contact Email
8. Optional- Configure Delivery Address
9. Optional- Configure Delivery Postcode
10. Optional- Configure Delivery Latitude
11. Optional- Configure Delivery Longitude
12. Optional- Configure Delivery Duration
13. Optional- Configure Delivery Notes
14. Optional- Configure Delivery Date
15. Optional- Configure Pickup Address
16. Optional- Configure Pickup Postcode
17. Optional- Configure Pickup Duration
18. Optional- Configure Pickup Latitude
19. Optional- Configure Pickup Longitude
20. Optional- Configure Pickup Notes
21. Optional- Configure Pickup Contact Name
22. Optional- Configure Pickup Contact Number
23. Optional- Configure Pickup Contact Email
24. Optional- Configure Parts
25. Optional- Configure Line Items
26. Optional- Configure Time Windows
27. Optional- Configure Skills
28. Optional- Select one or more Custom Fields
29. Optional- Select one or more Capacities
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 Abandoned Cart on Shopify Developer App

Description:Emit new event each time a user abandons their cart.

Version:0.0.4

Key:shopify_developer_app-new-abandoned-cart

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 shopify from "../../shopify_developer_app.app.mjs";
import common from "../../../shopify/sources/new-abandoned-cart/common.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-abandoned-cart",
  name: "New Abandoned Cart",
  type: "source",
  description: "Emit new event each time a user abandons their cart.",
  version: "0.0.4",
  dedupe: "unique",
  props: {
    shopify,
    ...common.props,
  },
};

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

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#

Create Order on SmartRoutes

Description:Creates a new order in the smartroutes. [See the documentation](https://api.smartroutes.io/v2/docs/api/#tag/Orders/paths/~1orders/post)

Version:0.0.1

Key:smartroutes-create-order

View on GitHub

SmartRoutes Overview#

The SmartRoutes API facilitates optimized routing for logistics and delivery services by calculating the best paths for multiple destinations. By integrating this API into Pipedream workflows, you can automate the process of generating efficient routes, tracking delivery status, and updating stakeholders. This streamlines operations for businesses that rely on prompt deliveries, such as e-commerce, food services, or courier companies.

Action Code#

import smartroutes from "../../smartroutes.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "smartroutes-create-order",
  name: "Create Order",
  description: "Creates a new order in the smartroutes. [See the documentation](https://api.smartroutes.io/v2/docs/api/#tag/Orders/paths/~1orders/post)",
  version: "0.0.1",
  type: "action",
  props: {
    smartroutes,
    orderNumber: {
      type: "string",
      label: "Order Number",
      description: "The order number",
    },
    customerAccount: {
      propDefinition: [
        smartroutes,
        "customerAccount",
      ],
    },
    type: {
      type: "string",
      label: "Type",
      description: "Type of the order (delivery, pickup, or shipment).",
      options: [
        "delivery",
        "pickup",
        "shipment",
      ],
    },
    deliveryContactName: {
      type: "string",
      label: "Delivery Contact Name",
      description: "Name of the contact person.",
      optional: true,
    },
    deliveryContactNumber: {
      type: "string",
      label: "Delivery Contact Number",
      description: "Contact number of the person.",
      optional: true,
    },
    deliveryContactEmail: {
      type: "string",
      label: "Delivery Contact Email",
      description: "Email of the contact person.",
      optional: true,
    },
    deliveryAddress: {
      type: "string",
      label: "Delivery Address",
      description: "Delivery address.",
      optional: true,
    },
    deliveryPostcode: {
      type: "string",
      label: "Delivery Postcode",
      description: "Postcode for delivery address.",
      optional: true,
    },
    deliveryLat: {
      type: "string",
      label: "Delivery Latitude",
      description: "Latitude of the delivery location.",
      optional: true,
    },
    deliveryLng: {
      type: "string",
      label: "Delivery Longitude",
      description: "Longitude of the delivery location.",
      optional: true,
    },
    deliveryDuration: {
      type: "integer",
      label: "Delivery Duration",
      description: "Duration for order delivery in minutes.",
      optional: true,
    },
    deliveryNotes: {
      type: "string",
      label: "Delivery Notes",
      description: "Notes for delivery instructions.",
      optional: true,
    },
    deliveryDate: {
      type: "string",
      label: "Delivery Date",
      description: "Date for order delivery.",
      optional: true,
    },
    pickupAddress: {
      type: "string",
      label: "Pickup Address",
      description: "Address for order pickup.",
      optional: true,
    },
    pickupPostcode: {
      type: "string",
      label: "Pickup Postcode",
      description: "Postcode for pickup address.",
      optional: true,
    },
    pickupDuration: {
      type: "integer",
      label: "Pickup Duration",
      description: "Duration for order pickup in minutes.",
      optional: true,
    },
    pickupLat: {
      type: "string",
      label: "Pickup Latitude",
      description: "Latitude of the pickup location.",
      optional: true,
    },
    pickupLng: {
      type: "string",
      label: "Pickup Longitude",
      description: "Longitude of the pickup location.",
      optional: true,
    },
    pickupNotes: {
      type: "string",
      label: "Pickup Notes",
      description: "Notes for pickup instructions.",
      optional: true,
    },
    pickupContactName: {
      type: "string",
      label: "Pickup Contact Name",
      description: "Name of the contact person for pickup.",
      optional: true,
    },
    pickupContactNumber: {
      type: "string",
      label: "Pickup Contact Number",
      description: "Contact number of the person for pickup.",
      optional: true,
    },
    pickupContactEmail: {
      type: "string",
      label: "Pickup Contact Email",
      description: "Email of the contact person for pickup.",
      optional: true,
    },
    parts: {
      type: "integer",
      label: "Parts",
      description: "Number of parts in the order.",
      optional: true,
    },
    lineItems: {
      type: "string[]",
      label: "Line Items",
      description: "Array of line items in the order. Each line item object must contain `product_code`, `product_name`, and `product_quantity`.",
      optional: true,
    },
    timeWindows: {
      type: "string[]",
      label: "Time Windows",
      description: "Array of time windows for order delivery or pickup. Each time window object must contain `from` (Start time of the time window. Ex: \"08:00\") and `to` (End time of the time window. Ex: \"12:00\").",
      optional: true,
    },
    skills: {
      type: "string[]",
      label: "Skills",
      description: "List of required skills for the order. Skills listed must exist within your Vehicle Settings.",
      optional: true,
    },
    customFields: {
      propDefinition: [
        smartroutes,
        "customFields",
      ],
      reloadProps: true,
    },
    capacities: {
      propDefinition: [
        smartroutes,
        "capacities",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.customFields?.length) {
      for (const field of this.customFields) {
        props[`customField_${field}`] = {
          type: "string",
          label: `Value of ${field}`,
        };
      }
    }
    if (this.capacities?.length) {
      for (const capacity of this.capacities) {
        props[`capacity_${capacity}`] = {
          type: "integer",
          label: `Capacity of ${capacity}`,
        };
      }
    }
    return props;
  },
  methods: {
    buildCustomFieldsObj() {
      return this.customFields.map((field) => ({
        name: field,
        value: this[`customField_${field}`],
      }));
    },
    buildCapacitiesObj() {
      return this.capacities.map((capacity) => ({
        type: capacity,
        capacity: this[`capacity_${capacity}`],
      }));
    },
  },
  async run({ $ }) {
    const { orders } = await this.smartroutes.createOrder({
      $,
      data: [
        {
          order_number: this.orderNumber,
          customer: {
            account: this.customerAccount,
          },
          type: this.type,
          delivery_contact_name: this.deliveryContactName,
          delivery_contact_number: this.deliveryContactNumber,
          delivery_contact_email: this.deliveryContactEmail,
          delivery_address: this.deliveryAddress,
          delivery_postcode: this.deliveryPostcode,
          delivery_lat: this.deliveryLat,
          delivery_lng: this.deliveryLng,
          delivery_duration: this.deliveryDuration,
          delivery_notes: this.deliveryNotes,
          delivery_date: this.deliveryDate,
          pickup_address: this.pickupAddress,
          pickup_postcode: this.pickupPostcode,
          pickup_duration: this.pickupDuration,
          pickup_lat: this.pickupLat,
          pickup_lng: this.pickupLng,
          pickup_notes: this.pickupNotes,
          pickup_contact_name: this.pickupContactName,
          pickup_contact_number: this.pickupContactNumber,
          pickup_contact_email: this.pickupContactEmail,
          parts: this.parts,
          line_items: utils.parseObjArray(this.lineItems),
          time_windows: utils.parseObjArray(this.timeWindows),
          skills: this.skills,
          custom_fields: this.customFields?.length && this.buildCustomFieldsObj(),
          capacities: this.capacities?.length && this.buildCapacitiesObj(),
        },
      ],
    });
    $.export("$summary", `Successfully created order with ID: ${orders[0].id}`);
    return orders;
  },
};

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
SmartRoutes	`smartroutes`	`app`	This component uses the SmartRoutes app.
Order Number	`orderNumber`	`string`	The order number
Customer Account Number	`customerAccount`	`string`	Select a value from the drop down menu.
Type	`type`	`string`	Select a value from the drop down menu:`deliverypickupshipment`
Delivery Contact Name	`deliveryContactName`	`string`	Name of the contact person.
Delivery Contact Number	`deliveryContactNumber`	`string`	Contact number of the person.
Delivery Contact Email	`deliveryContactEmail`	`string`	Email of the contact person.
Delivery Address	`deliveryAddress`	`string`	Delivery address.
Delivery Postcode	`deliveryPostcode`	`string`	Postcode for delivery address.
Delivery Latitude	`deliveryLat`	`string`	Latitude of the delivery location.
Delivery Longitude	`deliveryLng`	`string`	Longitude of the delivery location.
Delivery Duration	`deliveryDuration`	`integer`	Duration for order delivery in minutes.
Delivery Notes	`deliveryNotes`	`string`	Notes for delivery instructions.
Delivery Date	`deliveryDate`	`string`	Date for order delivery.
Pickup Address	`pickupAddress`	`string`	Address for order pickup.
Pickup Postcode	`pickupPostcode`	`string`	Postcode for pickup address.
Pickup Duration	`pickupDuration`	`integer`	Duration for order pickup in minutes.
Pickup Latitude	`pickupLat`	`string`	Latitude of the pickup location.
Pickup Longitude	`pickupLng`	`string`	Longitude of the pickup location.
Pickup Notes	`pickupNotes`	`string`	Notes for pickup instructions.
Pickup Contact Name	`pickupContactName`	`string`	Name of the contact person for pickup.
Pickup Contact Number	`pickupContactNumber`	`string`	Contact number of the person for pickup.
Pickup Contact Email	`pickupContactEmail`	`string`	Email of the contact person for pickup.
Parts	`parts`	`integer`	Number of parts in the order.
Line Items	`lineItems`	`string[]`	Array of line items in the order. Each line item object must contain `product_code`, `product_name`, and `product_quantity`.
Time Windows	`timeWindows`	`string[]`	Array of time windows for order delivery or pickup. Each time window object must contain `from` (Start time of the time window. Ex: "08:00") and `to` (End time of the time window. Ex: "12:00").
Skills	`skills`	`string[]`	List of required skills for the order. Skills listed must exist within your Vehicle Settings.
Custom Fields	`customFields`	`string[]`	Select a value from the drop down menu.
Capacities	`capacities`	`string[]`	Select a value from the drop down menu.