Create Custom Collection with Shopify API on New Event (Instant) from ShipStation API

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

Trigger workflow on

New Event (Instant) from the ShipStation API

Next, do this

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

Select this integration
Configure the New Event (Instant) trigger
1. Connect your ShipStation account
2. Select a Event Type
3. Optional- Select a Store
Configure the Create Custom Collection action
1. Connect your Shopify account
2. Configure Title
3. Optional- Select one or more Product ID
4. Optional- Configure Metafields
5. Optional- Configure Image URL
6. Optional- Configure Published
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 Event (Instant) on ShipStation

Description:Emit new event for each new webhook event received. [See docs here](https://www.shipstation.com/docs/api/webhooks/subscribe/)

Version:0.0.1

Key:shipstation-new-event

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.

Trigger Code#

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

export default {
  ...base,
  key: "shipstation-new-event",
  name: "New Event (Instant)",
  description: "Emit new event for each new webhook event received. [See docs here](https://www.shipstation.com/docs/api/webhooks/subscribe/)",
  version: "0.0.1",
  type: "source",
  methods: {
    ...base.methods,
    async emitEvent(event) {
      const { body } = event;

      const resource = await this.shipstation.getResourceByUrl({
        url: body.resource_url,
      });

      const ts = new Date();

      this.$emit(resource, {
        id: ts,
        summary: `New event ${ts.getTime()} received`,
        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
ShipStation	`shipstation`	`app`	This component uses the ShipStation 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 Type	`eventType`	`string`	Select a value from the drop down menu:`{ "label": "On New Orders", "value": "ORDER_NOTIFY" }{ "label": "On New Items", "value": "ITEM_ORDER_NOTIFY" }{ "label": "On Orders Shipped", "value": "SHIP_NOTIFY" }{ "label": "On Items Shipped", "value": "ITEM_SHIP_NOTIFY" }`
Store	`storeId`	`string`	Select a value from the drop down menu.

Trigger 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

Action#

Create Custom Collection on Shopify

Description:Create a new custom collection. [See the documentation](https://shopify.dev/docs/api/admin-rest/2023-01/resources/customcollection#post-custom-collections)

Version:0.0.3

Key:shopify_developer_app-create-custom-collection

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Action Code#

import shopify from "../../shopify_developer_app.app.mjs";
import common from "../../../shopify/actions/create-custom-collection/common.mjs";

export default {
  ...common,
  key: "shopify_developer_app-create-custom-collection",
  name: "Create Custom Collection",
  description: "Create a new custom collection. [See the documentation](https://shopify.dev/docs/api/admin-rest/2023-01/resources/customcollection#post-custom-collections)",
  version: "0.0.3",
  type: "action",
  props: {
    shopify,
    title: {
      propDefinition: [
        shopify,
        "title",
      ],
      description: "The name of the custom collection",
    },
    products: {
      propDefinition: [
        shopify,
        "productId",
      ],
      type: "string[]",
      optional: true,
    },
    metafields: {
      propDefinition: [
        shopify,
        "metafields",
      ],
    },
    ...common.props,
  },
};

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
Shopify	`shopify`	`app`	This component uses the Shopify app.
Title	`title`	`string`	The name of the custom collection
Product ID	`products`	`string[]`	Select a value from the drop down menu.
Metafields	`metafields`	`string[]`	An array of objects, each one representing a metafield. If adding a new metafield, the object should contain `key`, `value`, `type`, and `namespace`. Example: `{{ [{ "key": "new", "value": "newvalue", "type": "single_line_text_field", "namespace": "global" }] }}`. To update an existing metafield, use the `id` and `value`. Example: `{{ [{ "id": "28408051400984", "value": "updatedvalue" }] }}`
Image URL	`imageUrl`	`string`	The source URL that specifies the location of the image
Published	`published`	`boolean`	Whether the custom collection is published to the Online Store channel

Action Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

Create Custom Collection with Shopify API on New Event (Instant) from ShipStation API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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