Create Order with Shopify Developer App API on New Lead Created from Vtiger CRM API

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

Trigger workflow on

New Lead Created from the Vtiger CRM API

Next, do this

Create Order with the Shopify Developer App API

No credit card required

▶

Watch us build a workflow

4 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 Vtiger CRM trigger and Shopify Developer App action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Lead Created trigger
1. Connect your Vtiger CRM account
2. Configure timer
Configure the Create Order action
1. Connect your Shopify Developer App account
2. Optional- Select a Customer ID
3. Configure Line Items
4. Optional- Configure Billing Address
5. Optional- Configure Shipping Address
6. Optional- Select a Financial Status
7. Optional- Configure Discount Code
8. Optional- Configure Fulfillments
9. Optional- Select a Fulfillment Status
10. Optional- Configure Send Receipt
11. Optional- Configure Send Fulfillment Receipt
12. Optional- Configure Tax Lines
13. Optional- Configure Currency
14. Optional- Configure Note
15. Optional- Configure Note Attributes
16. Optional- Select a Inventory Behavior
17. Optional- Configure Shipping Lines
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 Lead Created on Vtiger CRM

Description:Emit new event when a new lead is created in VTiger CRM.

Version:0.0.1

Key:vtiger_crm-new-lead-created

View on GitHub

Vtiger CRM Overview#

The Vtiger CRM API lets you tap into your customer relationship data to create, read, update, and delete records across various entities such as contacts, leads, and opportunities. In Pipedream, you can leverage this API to automate workflows, sync data across platforms, and react to events in real-time, all without the need for dedicated backend code. You can create dynamic workflows that respond to webhooks, schedule tasks, and integrate with 1000+ apps readily available on Pipedream.

Trigger Code#

import base from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...base,
  key: "vtiger_crm-new-lead-created",
  name: "New Lead Created",
  description: "Emit new event when a new lead is created in VTiger CRM.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...base.methods,
    async getResources(modifiedTime) {
      const { result: { updated: leads } } = await this.vtiger.getSync({
        params: {
          modifiedTime,
          elementType: "Leads",
          syncType: "user",
        },
      });
      return leads;
    },
    getTsField() {
      return "createdtime";
    },
    generateMeta(lead) {
      return {
        id: lead.id,
        summary: `New Lead with ID ${lead.id}`,
        ts: Date.parse(lead.createdtime),
      };
    },
  },
  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
Vtiger CRM	`vtiger`	`app`	This component uses the Vtiger CRM app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To retrieve your Access Key,

Navigate to your Vtiger CRM account and sign in
Click the dropdown on the to right
Go to “My Preferences”

Your instance is 1234.abc if your Vtiger CRM dashboard URL is https://1234.abc.vtiger.com/
Enter the email address you use to log into VTiger CRM as the username

About Vtiger CRM#

Vtiger all-in-one CRM empowers you to align your marketing, sales and support teams with unified customer data powered by One View

Action#

Create Order on Shopify Developer App

Description:Creates a new order. For full order object details [see the docs](https://shopify.dev/api/admin-rest/2022-01/resources/order#[post]/admin/api/2022-01/orders.json) or [see examples](https://shopify.dev/api/admin-rest/2022-01/resources/order#[post]/admin/api/#{api_version}/orders.json_examples)

Version:0.0.3

Key:shopify_developer_app-create-order

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.

Action Code#

import shopify from "../../shopify_developer_app.app.mjs";
import common from "../../../shopify/actions/create-order/common.mjs";
import { toSingleLineString } from "../../../shopify/actions/common/common.mjs";

export default {
  ...common,
  key: "shopify_developer_app-create-order",
  name: "Create Order",
  description: toSingleLineString(`Creates a new order.
    For full order object details [see the docs](https://shopify.dev/api/admin-rest/2022-01/resources/order#[post]/admin/api/2022-01/orders.json)
    or [see examples](https://shopify.dev/api/admin-rest/2022-01/resources/order#[post]/admin/api/#{api_version}/orders.json_examples)
  `),
  version: "0.0.3",
  type: "action",
  props: {
    shopify,
    customerId: {
      propDefinition: [
        shopify,
        "customerId",
      ],
      optional: true,
    },
    ...common.props,
  },
};

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
Shopify Developer App	`shopify`	`app`	This component uses the Shopify Developer App app.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Line Items	`lineItems`	`string[]`	A list of line item objects, each containing information about an item in the order. Example: `{ "variant_id": 447654529, "quantity": 1, "price": 2.50, "name": "Name", "title": "Title" }`. More details when searching line_items in Shopify Order Object
Billing Address	`billingAddress`	`object`	The mailing address associated with the payment method. More details when searching billing_address in Shopify Order Object
Shipping Address	`shippingAddress`	`object`	The mailing address to where the order will be shipped. More details when searching billing_address in Shopify Order Object
Financial Status	`financialStatus`	`string`	Select a value from the drop down menu:`pendingauthorizedpartially_paidpaidpartially_refundedrefundedvoided`
Discount Code	`discountCode`	`object`	A discount applied to the order. Example: `{ "code": "SPRING30", "type": "fixed_amount", "amount": "30.00" }`. More details when searching discount_codes in Shopify Order Object
Fulfillments	`fulfillments`	`string[]`	An array of fulfillments associated with the order. For more information, see the Fulfillment API
Fulfillment Status	`fulfillmentStatus`	`string`	Select a value from the drop down menu:`fulfillednullpartialrestocked`
Send Receipt	`sendReceipt`	`boolean`	Whether to send an order confirmation to the customer
Send Fulfillment Receipt	`sendFulfillmentReceipt`	`boolean`	Whether to send a shipping confirmation to the customer
Tax Lines	`taxLines`	`string[]`	An array of tax line objects, each of which details a tax applicable to the order. Example: `[ { "rate": 0.06, "price": 11.94, "title": "State Tax", "channel_liable": true } ]`. More details when searching tax_lines in Shopify Order Object
Currency	`currency`	`string`	The three-letter code (ISO 4217 format) for the shop currency
Note	`note`	`string`	An optional note that a shop owner can attach to the order
Note Attributes	`noteAttributes`	`string[]`	Extra information that is added to the order. Appears in the Additional details section of an order details page. Each array entry must contain an object with `name` and `value` keys.
Inventory Behavior	`inventoryBehavior`	`string`	Select a value from the drop down menu:`{ "value": "bypass", "label": "Do not claim inventory" }{ "value": "decrement_ignoring_policy", "label": "Ignore the product's inventory policy and claim inventory" }{ "value": "decrement_obeying_policy", "label": "Follow the product's inventory policy and claim inventory, if possible" }`
Shipping Lines	`shippingLines`	`string[]`	An array of objects, each of which details a shipping method used. More details when searching shipping_lines in Shopify Order Object

Action 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)