Create Item with Zoho Books API on New Custom Events from BigCommerce API

Pipedream makes it easy to connect APIs for Zoho Books, BigCommerce and 3,000+ other apps remarkably fast.

Trigger workflow on

New Custom Events from the BigCommerce API

Next, do this

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

Select this integration
Configure the New Custom Events trigger
1. Connect your BigCommerce account
2. Configure Using channel
Configure the Create Item action
1. Connect your Zoho Books account
2. Configure Name
3. Configure Rate
4. Optional- Configure Description
5. Optional- Select a Tax Id
6. Optional- Configure Tax Percentage
7. Optional- Configure SKU
8. Optional- Select a Product Type
9. Optional- Configure HSN Or SAC
10. Optional- Configure Is Taxable
11. Optional- Configure Tax Exemption Id
12. Optional- Select a Account Id
13. Optional- Select a Item Type
14. Optional- Configure Purchase Description
15. Optional- Configure Purchase Rate
16. Optional- Configure Purchase Account Id
17. Optional- Configure Inventory Account Id
18. Optional- Configure Vendor Id
19. Optional- Configure Reorder Level
20. Optional- Configure Initial Stock
21. Optional- Configure Initial Stock Rate
22. Optional- Configure Item Tax Preferences
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 Custom Events on BigCommerce

Description:Emit new custom webhook event

Version:0.0.2

Key:bigcommerce-custom-events

View on GitHub

BigCommerce Overview#

The BigCommerce API enables merchants to seamlessly manage their e-commerce operations by automating tasks, syncing data, and integrating with a plethora of other services. With Pipedream, you can tap into the BigCommerce API to create custom workflows that handle everything from order processing to customer relationship management. The result is a more efficient, personalized shopping experience for customers and less manual work for store owners.

Trigger Code#

import bigcommerce from "../../bigcommerce.app.mjs";
import constants from "../../common/constants.mjs";
import { filterObj } from "../../utils.mjs";
import common from "../common/base.mjs";

export default {
  ...common,
  name: "New Custom Events",
  version: "0.0.2",
  type: "source",
  key: "bigcommerce-custom-events",
  description: "Emit new custom webhook event",
  props: {
    ...common.props,
    channel: {
      propDefinition: [
        bigcommerce,
        "channel",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.channel) {
      props.channelId = {
        type: "string",
        label: "Channel Id",
        description: "Id of the channel",
      };
    }

    props.type = {
      type: "string",
      label: "Webhook type",
      description: "Type of the webhook",
      options: Object.getOwnPropertyNames(
        filterObj(
          constants.WEBHOOK_SCOPES,
          (scope) => !!scope[this.channel
            ? "channel"
            : "default"],
        ),
      ),
      reloadProps: true,
    };

    if (this.type) {
      const scope = constants.WEBHOOK_SCOPES[this.type];
      props.scope = {
        type: "string",
        label: "Scope of the webhook",
        options: this.channel
          ? scope.channel
          : scope.default,
      };
    }

    return props;
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const hookId = await this.bigcommerce.createHook(
        this.http.endpoint,
        this.type,
        this.scope,
        this.channel,
        this.channelId,
      );
      this.setHookId(hookId);
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "Custom event created";
    },
  },
};

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
BigCommerce	`bigcommerce`	`app`	This component uses the BigCommerce 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.
Using channel	`channel`	`boolean`	Channel of the webhook

Trigger Authentication#

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

Navigate to Settings > API > Store-level API accounts
Name the account (it will only be visible to store users)
In the OAuth Scopes section, select the minimum scopes the app will require
Press Save.

The base API path will look something like this: https://api.bigcommerce.com/stores/123456/

In example above, the store_hash is 123456. Enter this and the access token below.

About BigCommerce#

Ecommerce for a New Era

Action#

Create Item on Zoho Books

Description:Creates a new item. [See the documentation](https://www.zoho.com/books/api/v3/items/#create-an-item)

Version:0.3.1

Key:zoho_books-create-item

View on GitHub

Zoho Books Overview#

Zoho Books API unlocks the potential to automate and streamline accounting tasks by integrating with Pipedream's serverless platform. With this powerful combo, you can automate invoicing, manage your accounts, reconcile bank transactions, and handle contacts and items without manual input. By setting up event-driven workflows, you can ensure data consistency across platforms, trigger notifications, and generate reports, all while saving time and reducing human error.

Action Code#

// legacy_hash_id: a_Xzi1qo
import {
  ITEM_TYPE_OPTIONS, PRODUCT_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import zohoBooks from "../../zoho_books.app.mjs";

export default {
  key: "zoho_books-create-item",
  name: "Create Item",
  description: "Creates a new item. [See the documentation](https://www.zoho.com/books/api/v3/items/#create-an-item)",
  version: "0.3.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    zohoBooks,
    name: {
      type: "string",
      label: "Name",
      description: "Name of the item. Max-length [100]",
    },
    rate: {
      type: "string",
      label: "Rate",
      description: "Price of the item.",
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description for the item. Max-length [2000]",
      optional: true,
    },
    taxId: {
      propDefinition: [
        zohoBooks,
        "taxId",
      ],
      description: "ID of the tax to be associated to the item.",
      optional: true,
    },
    taxPercentage: {
      type: "string",
      label: "Tax Percentage",
      description: "Percent of the tax.",
      optional: true,
    },
    sku: {
      type: "string",
      label: "SKU",
      description: "SKU value of item,should be unique throughout the product",
      optional: true,
    },
    productType: {
      type: "string",
      label: "Product Type",
      description: "Specify the type of an item.",
      optional: true,
      options: PRODUCT_TYPE_OPTIONS,
    },
    hsnOrSac: {
      type: "string",
      label: "HSN Or SAC",
      description: "HSN Code.",
      optional: true,
    },
    isTaxable: {
      type: "boolean",
      label: "Is Taxable",
      description: "Boolean to track the taxability of the item.",
      optional: true,
    },
    taxExemptionId: {
      type: "string",
      label: "Tax Exemption Id",
      description: "ID of the tax exemption. Mandatory, if is_taxable is false.",
      optional: true,
    },
    accountId: {
      propDefinition: [
        zohoBooks,
        "accountId",
      ],
      description: "ID of the account to which the item has to be associated with.",
      optional: true,
    },
    itemType: {
      type: "string",
      label: "Item Type",
      description: "Type of the item. Default value will be sales.",
      optional: true,
      options: ITEM_TYPE_OPTIONS,
    },
    purchaseDescription: {
      type: "string",
      label: "Purchase Description",
      description: "Purchase description for the item.",
      optional: true,
    },
    purchaseRate: {
      type: "string",
      label: "Purchase Rate",
      description: "Purchase price of the item.",
      optional: true,
    },
    purchaseAccountId: {
      type: "string",
      label: "Purchase Account Id",
      description: "ID of the COGS account to which the item has to be associated with. Mandatory, if item_type is purchase / sales and purchase / inventory.",
      optional: true,
    },
    inventoryAccountId: {
      type: "string",
      label: "Inventory Account Id",
      description: "ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.",
      optional: true,
    },
    vendorId: {
      type: "string",
      label: "Vendor Id",
      description: "Preferred vendor ID.",
      optional: true,
    },
    reorderLevel: {
      type: "string",
      label: "Reorder Level",
      description: "Reorder level of the item.",
      optional: true,
    },
    initialStock: {
      type: "string",
      label: "Initial Stock",
      description: "Opening stock of the item.",
      optional: true,
    },
    initialStockRate: {
      type: "string",
      label: "Initial Stock Rate",
      description: "Unit price of the opening stock.",
      optional: true,
    },
    itemTaxPreferences: {
      type: "string[]",
      label: "Item Tax Preferences",
      description: "A list of item tax objects. **Format: {\"tax_id\":\"12312312031200\",\"tax_specification\":\"intra\"}**",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.zohoBooks.createItem({
      $,
      data: {
        name: this.name,
        rate: this.rate && parseFloat(this.rate),
        description: this.description,
        tax_id: this.taxId,
        tax_percentage: this.taxPercentage,
        sku: this.sku,
        product_type: this.productType,
        hsn_or_sac: this.hsnOrSac,
        is_taxable: this.isTaxable,
        tax_exemption_id: this.taxExemptionId,
        account_id: this.accountId,
        item_type: this.itemType,
        purchase_description: this.purchaseDescription,
        purchase_rate: this.purchaseRate,
        purchase_account_id: this.purchaseAccountId,
        inventory_account_id: this.inventoryAccountId,
        vendor_id: this.vendorId,
        reorder_level: this.reorderLevel,
        initial_stock: this.initialStock,
        initial_stock_rate: this.initialStockRate,
        item_tax_preferences: parseObject(this.itemTaxPreferences),
      },
    });

    $.export("$summary", `Item successfully created with Id: ${response.item.item_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
Zoho Books	`zohoBooks`	`app`	This component uses the Zoho Books app.
Name	`name`	`string`	Name of the item. Max-length [100]
Rate	`rate`	`string`	Price of the item.
Description	`description`	`string`	Description for the item. Max-length [2000]
Tax Id	`taxId`	`string`	Select a value from the drop down menu.
Tax Percentage	`taxPercentage`	`string`	Percent of the tax.
SKU	`sku`	`string`	SKU value of item,should be unique throughout the product
Product Type	`productType`	`string`	Select a value from the drop down menu:`goodsservicedigital_service`
HSN Or SAC	`hsnOrSac`	`string`	HSN Code.
Is Taxable	`isTaxable`	`boolean`	Boolean to track the taxability of the item.
Tax Exemption Id	`taxExemptionId`	`string`	ID of the tax exemption. Mandatory, if is_taxable is false.
Account Id	`accountId`	`string`	Select a value from the drop down menu.
Item Type	`itemType`	`string`	Select a value from the drop down menu:`salespurchasessales_and_purchasesinventory`
Purchase Description	`purchaseDescription`	`string`	Purchase description for the item.
Purchase Rate	`purchaseRate`	`string`	Purchase price of the item.
Purchase Account Id	`purchaseAccountId`	`string`	ID of the COGS account to which the item has to be associated with. Mandatory, if item_type is purchase / sales and purchase / inventory.
Inventory Account Id	`inventoryAccountId`	`string`	ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.
Vendor Id	`vendorId`	`string`	Preferred vendor ID.
Reorder Level	`reorderLevel`	`string`	Reorder level of the item.
Initial Stock	`initialStock`	`string`	Opening stock of the item.
Initial Stock Rate	`initialStockRate`	`string`	Unit price of the opening stock.
Item Tax Preferences	`itemTaxPreferences`	`string[]`	A list of item tax objects. Format: {"tax_id":"12312312031200","tax_specification":"intra"}

Action Authentication#

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

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

ZohoBooks.fullaccess.all

Create Item with Zoho Books API on New Custom Events from BigCommerce API

Pipedream makes it easy to connect APIs for Zoho Books, BigCommerce and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular