Create Item with Zoho Books API on New Coupon Event (Instant) from WooCommerce API

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

Trigger workflow on

New Coupon Event (Instant) from the WooCommerce 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 WooCommerce 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 Coupon Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create Item action
1. Connect your Zoho Books account
2. Configure organization_id
3. Configure name
4. Configure rate
5. Optional- Configure description
6. Optional- Configure tax_id
7. Optional- Configure tax_percentage
8. Optional- Configure sku
9. Optional- Select a product_type
10. Optional- Configure hsn_or_sac
11. Optional- Configure is_taxable
12. Optional- Configure tax_exemption_id
13. Optional- Configure account_id
14. Optional- Configure avatax_tax_code
15. Optional- Configure avatax_use_code
16. Optional- Select a item_type
17. Optional- Configure purchase_description
18. Optional- Configure purchase_rate
19. Optional- Configure purchase_account_id
20. Optional- Configure inventory_account_id
21. Optional- Configure vendor_id
22. Optional- Configure reorder_level
23. Optional- Configure initial_stock
24. Optional- Configure initial_stock_rate
25. 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 Coupon Event (Instant) on WooCommerce

Description:Emit new event each time the specified coupon event(s) occur

Version:0.0.3

Key:woocommerce-new-coupon-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "woocommerce-new-coupon-event",
  name: "New Coupon Event (Instant)",
  description: "Emit new event each time the specified coupon event(s) occur",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listCoupons({
        per_page: perPage,
        orderby: "date",
      });
    },
    getTopic(topicType) {
      return `coupon.${topicType}`;
    },
    generateMeta(eventType, {
      id, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Coupon ID: ${id} ${eventType}`,
        ts,
      };
    },
  },
};

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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce 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.
Event topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

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

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Create Item on Zoho Books

Description:Creates a new item.

Version:0.2.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 { axios } from "@pipedream/platform";

export default {
  key: "zoho_books-create-item",
  name: "Create Item",
  description: "Creates a new item.",
  version: "0.2.1",
  type: "action",
  props: {
    zoho_books: {
      type: "app",
      app: "zoho_books",
    },
    organization_id: {
      type: "string",
      description: "In Zoho Books, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Books Organization with it's own organization ID, base currency, time zone, language, contacts, reports, etc.\n\nThe parameter `organization_id` should be sent in with every API request to identify the organization.\n\nThe `organization_id` can be obtained from the GET `/organizations` API's JSON response. Alternatively, it can be obtained from the **Manage Organizations** page in the admin console.",
    },
    name: {
      type: "string",
      description: "Name of the item. Max-length [100]",
    },
    rate: {
      type: "string",
      description: "Price of the item.",
    },
    description: {
      type: "string",
      description: "Description for the item. Max-length [2000]",
      optional: true,
    },
    tax_id: {
      type: "string",
      description: "ID of the tax to be associated to the item.",
      optional: true,
    },
    tax_percentage: {
      type: "string",
      description: "Percent of the tax.",
      optional: true,
    },
    sku: {
      type: "string",
      description: "SKU value of item,should be unique throughout the product",
      optional: true,
    },
    product_type: {
      type: "string",
      description: "Specify the type of an item. Allowed values: `goods` or `service` or `digital_service`.",
      optional: true,
      options: [
        "goods",
        "service",
        "digital_service",
      ],
    },
    hsn_or_sac: {
      type: "string",
      description: "HSN Code.",
      optional: true,
    },
    is_taxable: {
      type: "boolean",
      description: "Boolean to track the taxability of the item.",
      optional: true,
    },
    tax_exemption_id: {
      type: "string",
      description: "ID of the tax exemption. Mandatory, if is_taxable is false.",
      optional: true,
    },
    account_id: {
      type: "string",
      description: "ID of the account to which the item has to be associated with.",
      optional: true,
    },
    avatax_tax_code: {
      type: "string",
      description: "A tax code is a unique label used to group Items (products, services, or charges) together. Max-length [25]",
      optional: true,
    },
    avatax_use_code: {
      type: "string",
      description: "Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Max-length [25]",
      optional: true,
    },
    item_type: {
      type: "string",
      description: "Type of the item. Allowed values: `sales`,`purchases`,`sales_and_purchases` and `inventory`. Default value will be sales.",
      optional: true,
      options: [
        "sales",
        "purchases",
        "sales_and_purchases",
        "inventory",
      ],
    },
    purchase_description: {
      type: "string",
      description: "Purchase description for the item.",
      optional: true,
    },
    purchase_rate: {
      type: "string",
      description: "Purchase price of the item.",
      optional: true,
    },
    purchase_account_id: {
      type: "string",
      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,
    },
    inventory_account_id: {
      type: "string",
      description: "ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.",
      optional: true,
    },
    vendor_id: {
      type: "string",
      description: "Preferred vendor ID.",
      optional: true,
    },
    reorder_level: {
      type: "string",
      description: "Reorder level of the item.",
      optional: true,
    },
    initial_stock: {
      type: "string",
      description: "Opening stock of the item.",
      optional: true,
    },
    initial_stock_rate: {
      type: "string",
      description: "Unit price of the opening stock.",
      optional: true,
    },
    item_tax_preferences: {
      type: "any",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs: https://www.zoho.com/books/api/v3/#Items_Create_an_Item

    if (!this.organization_id || !this.name || !this.rate) {
      throw new Error("Must provide organization_id, name, and rate parameters.");
    }

    return await axios($, {
      method: "post",
      url: `https://books.${this.zoho_books.$auth.base_api_uri}/api/v3/items?organization_id=${this.organization_id}`,
      headers: {
        Authorization: `Zoho-oauthtoken ${this.zoho_books.$auth.oauth_access_token}`,
      },
      data: {
        name: this.name,
        rate: this.rate,
        description: this.description,
        tax_id: this.tax_id,
        tax_percentage: this.tax_percentage,
        sku: this.sku,
        product_type: this.product_type,
        hsn_or_sac: this.hsn_or_sac,
        is_taxable: this.is_taxable,
        tax_exemption_id: this.tax_exemption_id,
        account_id: this.account_id,
        avatax_tax_code: this.avatax_tax_code,
        avatax_use_code: this.avatax_use_code,
        item_type: this.item_type,
        purchase_description: this.purchase_description,
        purchase_rate: this.purchase_rate,
        purchase_account_id: this.purchase_account_id,
        inventory_account_id: this.inventory_account_id,
        vendor_id: this.vendor_id,
        reorder_level: this.reorder_level,
        initial_stock: this.initial_stock,
        initial_stock_rate: this.initial_stock_rate,
        item_tax_preferences: this.item_tax_preferences,
      },
    });
  },
};

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	`zoho_books`	`app`	This component uses the Zoho Books app.
organization_id	`organization_id`	`string`	In Zoho Books, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Books Organization with it's own organization ID, base currency, time zone, language, contacts, reports, etc. The parameter `organization_id` should be sent in with every API request to identify the organization. The `organization_id` can be obtained from the GET `/organizations` API's JSON response. Alternatively, it can be obtained from the Manage Organizations page in the admin console.
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	`tax_id`	`string`	ID of the tax to be associated to the item.
tax_percentage	`tax_percentage`	`string`	Percent of the tax.
sku	`sku`	`string`	SKU value of item,should be unique throughout the product
product_type	`product_type`	`string`	Select a value from the drop down menu:`goodsservicedigital_service`
hsn_or_sac	`hsn_or_sac`	`string`	HSN Code.
is_taxable	`is_taxable`	`boolean`	Boolean to track the taxability of the item.
tax_exemption_id	`tax_exemption_id`	`string`	ID of the tax exemption. Mandatory, if is_taxable is false.
account_id	`account_id`	`string`	ID of the account to which the item has to be associated with.
avatax_tax_code	`avatax_tax_code`	`string`	A tax code is a unique label used to group Items (products, services, or charges) together. Max-length [25]
avatax_use_code	`avatax_use_code`	`string`	Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Max-length [25]
item_type	`item_type`	`string`	Select a value from the drop down menu:`salespurchasessales_and_purchasesinventory`
purchase_description	`purchase_description`	`string`	Purchase description for the item.
purchase_rate	`purchase_rate`	`string`	Purchase price of the item.
purchase_account_id	`purchase_account_id`	`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	`inventory_account_id`	`string`	ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.
vendor_id	`vendor_id`	`string`	Preferred vendor ID.
reorder_level	`reorder_level`	`string`	Reorder level of the item.
initial_stock	`initial_stock`	`string`	Opening stock of the item.
initial_stock_rate	`initial_stock_rate`	`string`	Unit price of the opening stock.
item_tax_preferences	`item_tax_preferences`	`any`

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