Create Discount with Snipcart API on Monthly Schedule from Schedule API

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

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Discount action
1. Connect your Snipcart account
2. Configure Name
3. Select a Trigger
4. Optional- Configure Code
5. Optional- Configure Total to Reach
6. Select a Type
7. Optional- Configure Amount
8. Optional- Configure Rate
9. Optional- Configure Max Number of Usages
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#

Monthly Schedule on Schedule

Description:Trigger your workflow on one or more days each month at a specific time (with timezone support).

Version:0.0.2

Key:schedule-monthly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 1 * *",
      },
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Discount on Snipcart

Description:Create a new Discount. [See the documentation](https://docs.snipcart.com/v3/api-reference/discounts#post-discounts)

Version:0.0.1

Key:snipcart-create-discount

View on GitHub

Snipcart Overview#

Snipcart is a developer-centric e-commerce solution designed to be easily embedded into any website. With the Snipcart API, you gain the ability to automate cart and checkout operations, manage products, retrieve order details, update inventory, and handle customers. The flexibility of this API opens doors to enhancing e-commerce workflows, including real-time inventory management, order processing, and personalized customer engagement.

Action Code#

import app from "../../snipcart.app.mjs";

export default {
  key: "snipcart-create-discount",
  name: "Create Discount",
  description: "Create a new Discount. [See the documentation](https://docs.snipcart.com/v3/api-reference/discounts#post-discounts)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    name: {
      propDefinition: [
        app,
        "name",
      ],
    },
    trigger: {
      propDefinition: [
        app,
        "trigger",
      ],
      reloadProps: true,
    },
    code: {
      propDefinition: [
        app,
        "code",
      ],
      optional: true,
      hidden: true,
    },
    totalToReach: {
      propDefinition: [
        app,
        "totalToReach",
      ],
      optional: true,
      hidden: true,
    },
    type: {
      propDefinition: [
        app,
        "type",
      ],
      reloadProps: true,
    },
    amount: {
      propDefinition: [
        app,
        "amount",
      ],
      optional: true,
      hidden: true,
    },
    rate: {
      propDefinition: [
        app,
        "rate",
      ],
      optional: true,
      hidden: true,
    },
    maxNumberOfUsages: {
      propDefinition: [
        app,
        "maxNumberOfUsages",
      ],
    },
  },
  async additionalProps(props) {
    const triggerIsCode = this.trigger === "Code";
    const triggerIsTotal = this.trigger === "Total";

    props.code.hidden = !triggerIsCode;
    props.code.optional = !triggerIsCode;
    props.totalToReach.hidden = !triggerIsTotal;
    props.totalToReach.optional = !triggerIsTotal;

    const typeIsFixedAmount = this.type === "FixedAmount";
    const typeIsRate = this.type === "Rate";

    props.amount.hidden = !typeIsFixedAmount;
    props.amount.optional = !typeIsFixedAmount;
    props.rate.hidden = !typeIsRate;
    props.rate.optional = !typeIsRate;

    return {};
  },
  async run({ $ }) {
    const response = await this.app.createDiscount({
      $,
      data: {
        name: this.name,
        maxNumberOfUsages: this.maxNumberOfUsages,
        trigger: this.trigger,
        code: this.code,
        totalToReach: this.totalToReach,
        type: this.type,
        amount: this.amount,
        rate: this.rate,
      },
    });

    $.export("$summary", `Successfully created Discount 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
Snipcart	`app`	`app`	This component uses the Snipcart app.
Name	`name`	`string`	Name of the discount
Trigger	`trigger`	`string`	Select a value from the drop down menu:`TotalCode`
Type	`type`	`string`	Select a value from the drop down menu:`FixedAmountRate`
Max Number of Usages	`maxNumberOfUsages`	`integer`	The maximum number of usage for the discount. If not specified, customers will be able to use this discount indefinitely.