Create Order with ShipStation API on New Deleted Record (of Selectable Type) from Salesforce API

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

Trigger workflow on

New Deleted Record (of Selectable Type) from the Salesforce 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 Salesforce 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 Deleted Record (of Selectable Type) trigger
1. Connect your Salesforce account
2. Configure timer
3. Select a Object Type
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 Deleted Record (of Selectable Type) on Salesforce

Description:Emit new event (at regular intervals) when a record of arbitrary object type (selected as an input parameter by the user) is deleted. [See the docs](https://sforce.co/3msDDEE) for more information.

Version:0.0.4

Key:salesforce_rest_api-record-deleted

View on GitHub

Salesforce Overview#

The Salesforce (REST API) provides a powerful platform for creating and managing customer relationships with a wide array of features like data manipulation, querying, and complex automation. With Pipedream's serverless execution, you can create workflows that automate your sales processes, sync data with other platforms, enhance customer engagement, and trigger actions based on specific events. Dive into Salesforce data, streamline lead management, track customer interactions, and push or pull data to or from Salesforce seamlessly.

Trigger Code#

import startCase from "lodash/startCase.js";

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

export default {
  ...common,
  type: "source",
  name: "New Deleted Record (of Selectable Type)",
  key: "salesforce_rest_api-record-deleted",
  description: "Emit new event (at regular intervals) when a record of arbitrary object type (selected as an input parameter by the user) is deleted. [See the docs](https://sforce.co/3msDDEE) for more information.",
  version: "0.0.4",
  methods: {
    ...common.methods,
    generateMeta(item) {
      const {
        id,
        deletedDate,
      } = item;
      const entityType = startCase(this.objectType);
      const summary = `${entityType} deleted: ${id}`;
      const ts = Date.parse(deletedDate);
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(eventData) {
      const {
        startTimestamp,
        endTimestamp,
      } = eventData;
      const {
        deletedRecords,
        latestDateCovered,
      } = await this.salesforce.getDeletedForObjectType(
        this.objectType,
        startTimestamp,
        endTimestamp,
      );
      this.setLatestDateCovered(latestDateCovered);

      // When a record is deleted, the `getDeleted` API only shows the ID of the
      // deleted item and the date in which it was deleted.
      deletedRecords.forEach((item) => {
        const meta = this.generateMeta(item);
        this.$emit(item, meta);
      });
    },
  },
};

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
Salesforce	`salesforce`	`app`	This component uses the Salesforce app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Object Type	`objectType`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About Salesforce#

Web services API for interacting with Salesforce

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

Action Authentication#

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

The ShipStation API uses Basic HTTP authentication. Use your ShipStation API Key as the username and API Secret as the password. You can find your API Key under Settings.

About ShipStation#

Import, manage and ship your orders with ShipStation

More Ways to Connect ShipStation + Salesforce#

Other Popular Integrations#

Create Order with ShipStation API on New Updated Field on Record (Instant, of Selectable Type) from Salesforce API

Salesforce + ShipStation

Create Order with ShipStation API on New Deleted Record (of Selectable Type) from Salesforce API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular