Create Order with ShipStation API on New Guild Member (Instant) from Discord API

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

Trigger workflow on

New Guild Member (Instant) from the Discord API

Next, do this

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

Select this integration
Configure the New Guild Member (Instant) trigger
1. Connect your Discord account
2. Configure discordApphook
Configure the Create Order action
1. Connect your ShipStation account
2. Configure Order Number
3. Configure Order Date
4. Select a Order Status
5. Configure Bill To
6. Configure Ship To
7. Optional- Configure Customer Username
8. Optional- Select a Customer Email
9. Optional- Configure Items
10. Optional- Configure Gift
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 Guild Member (Instant) on Discord

Description:Emit new event for each new member added to a guild

Version:0.0.3

Key:discord-new-guild-member

View on GitHub

Discord Overview#

The Discord API interacts seamlessly with Pipedream, empowering you to craft customized automations and workflows for your Discord server. With this powerful integration, you can automate tasks like message posting, user management, and notifications, based on a myriad of triggers and actions from different apps. These automations can enhance the Discord experience for community moderators and members, by synchronizing with external tools, organizing community engagement, and streamlining notifications.

Trigger Code#

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

export default {
  key: "discord-new-guild-member",
  name: "New Guild Member (Instant)",
  description: "Emit new event for each new member added to a guild",
  version: "0.0.3",
  dedupe: "unique",
  type: "source",
  props: {
    discord,
    discordApphook: {
      type: "$.interface.apphook",
      appProp: "discord",
      eventNames: [
        "GUILD_MEMBER_ADD",
      ],
    },
  },
  async run(event) {
    this.$emit(event, {
      id: `${event.userId}${event.guildId}`,
      summary: `Member ${event.displayName} added`,
      ts: Date.now(),
    });
  },
};

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
Discord	`discord`	`app`	This component uses the Discord app.
	`discordApphook`	`$.interface.apphook`

Trigger Authentication#

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

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

botemailidentifyguilds

About Discord#

Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.

Action#

Create Order on ShipStation

Description:Create a new order. [See docs here](https://www.shipstation.com/docs/api/orders/create-update-order)

Version:0.0.1

Key:shipstation-create-order

View on GitHub

ShipStation Overview#

The ShipStation API allows for streamlined management of shipping operations for e-commerce. With it, you can automate order processing, label creation, and tracking updates. Pipedream excels as a platform for integrating ShipStation with other services to create custom workflows.

Action Code#

import shipstation from "../../shipstation.app.mjs";
import constants from "../common/constants.mjs";
import utils from "../common/utils.mjs";

export default {
  key: "shipstation-create-order",
  name: "Create Order",
  description: "Create a new order. [See docs here](https://www.shipstation.com/docs/api/orders/create-update-order)",
  version: "0.0.1",
  type: "action",
  props: {
    shipstation,
    orderNumber: {
      label: "Order Number",
      description: "A user-defined order number used to identify an order.",
      type: "string",
    },
    orderDate: {
      label: "Order Date",
      description: "The date the order was placed. E.g. 2015-06-29T08:46:27.0000000",
      type: "string",
    },
    orderStatus: {
      label: "Order Status",
      description: "The order's status.",
      type: "string",
      options: constants.ORDER_STATUSES,
    },
    billTo: {
      label: "Bill To",
      description: "The recipients billing address. Use the [Address](https://www.shipstation.com/docs/api/models/address) model.",
      type: "string",
    },
    shipTo: {
      label: "Ship To",
      description: "The recipient's shipping address. Use the [Address](https://www.shipstation.com/docs/api/models/address) model.",
      type: "string",
    },
    customerUsername: {
      label: "Customer Username",
      description: "The customer's username. Note: This property needs to be defined in order to generate a customer profile",
      type: "string",
      optional: true,
    },
    customerEmail: {
      label: "Customer Email",
      description: "The customer's email address.",
      optional: true,
      propDefinition: [
        shipstation,
        "customerEmail",
      ],
    },
    items: {
      label: "Items",
      description: "An array of item objects. Use an array of [OrderItem](https://www.shipstation.com/docs/api/models/order-item) models.",
      type: "string[]",
      optional: true,
    },
    gift: {
      label: "Gift",
      description: "Specifies whether or not this Order is a gift",
      type: "boolean",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      orderNumber,
      orderDate,
      orderStatus,
      billTo,
      shipTo,
      customerUsername,
      customerEmail,
      items,
      gift,
    } = this;

    const parsedItems = typeof items !== "string" && items?.length
      ? items.map((item) => utils.parseStringToJSON(item))
      : utils.parseStringToJSON(items, []);

    const response = await this.shipstation.createOrder({
      data: {
        orderNumber,
        orderDate,
        orderStatus,
        billTo: utils.parseStringToJSON(billTo),
        shipTo: utils.parseStringToJSON(shipTo),
        customerUsername,
        customerEmail,
        items: parsedItems,
        gift,
      },
      $,
    });

    $.export("$summary", "Successfully created order.");

    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
ShipStation	`shipstation`	`app`	This component uses the ShipStation app.
Order Number	`orderNumber`	`string`	A user-defined order number used to identify an order.
Order Date	`orderDate`	`string`	The date the order was placed. E.g. 2015-06-29T08:46:27.0000000
Order Status	`orderStatus`	`string`	Select a value from the drop down menu:`awaiting_paymentawaiting_shipmentshippedon_holdcancelled`
Bill To	`billTo`	`string`	The recipients billing address. Use the Address model.
Ship To	`shipTo`	`string`	The recipient's shipping address. Use the Address model.
Customer Username	`customerUsername`	`string`	The customer's username. Note: This property needs to be defined in order to generate a customer profile
Customer Email	`customerEmail`	`string`	Select a value from the drop down menu.
Items	`items`	`string[]`	An array of item objects. Use an array of OrderItem models.
Gift	`gift`	`boolean`	Specifies whether or not this Order is a gift