Refund Order with Shopify API on New Event from ExhibitDay API

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

Trigger workflow on

New Event from the ExhibitDay API

Next, do this

Refund Order 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 ExhibitDay 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 trigger
1. Connect your ExhibitDay account
2. Configure timer
Configure the Refund Order action
1. Connect your Shopify account
2. Select a Order ID
3. Optional- Configure Note
4. Select one or more Line Item IDs
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 on ExhibitDay

Description:Emit new event when an event is created in ExhibitDay

Version:0.0.1

Key:exhibitday-new-event

View on GitHub

ExhibitDay Overview#

The ExhibitDay API allows you to interact with ExhibitDay's event planning and trade show management features programmatically. Using this API within Pipedream, you can automate tasks like synchronizing event data, managing trade show inventory, and tracking your team's performance at events. By leveraging Pipedream's connectivity, you can trigger workflows based on new events, updates, or specific conditions that you define, streamlining your event management process.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "exhibitday-new-event",
  name: "New Event",
  description: "Emit new event when an event is created in ExhibitDay",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.exhibitday.listEvents;
    },
    getTsField() {
      return "event_created_timestamp";
    },
    generateMeta(event) {
      return {
        id: event.id,
        summary: `New Event - ${event.name}`,
        ts: Date.parse(event[this.getTsField()]),
      };
    },
  },
  sampleEmit,
};

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
ExhibitDay	`exhibitday`	`app`	This component uses the ExhibitDay app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About ExhibitDay#

Plan for Trade Shows and Exhibits. Collaborate with your event team to get things done.

Action#

Refund Order on Shopify

Description:Refund an order. [See the documentation](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/refundcreate)

Version:0.0.1

Key:shopify_developer_app-refund-order

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 { MAX_LIMIT } from "@pipedream/shopify/common/constants.mjs";

export default {
  key: "shopify_developer_app-refund-order",
  name: "Refund Order",
  description: "Refund an order. [See the documentation](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/refundcreate)",
  version: "0.0.1",
  type: "action",
  props: {
    shopify,
    orderId: {
      propDefinition: [
        shopify,
        "orderId",
      ],
    },
    note: {
      type: "string",
      label: "Note",
      description: "An optional note that's attached to the refund",
      optional: true,
    },
    lineItemIds: {
      propDefinition: [
        shopify,
        "lineItemIds",
        (c) => ({
          orderId: c.orderId,
        }),
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.lineItemIds) {
      return props;
    }
    const order = await this.shopify.getOrder({
      id: this.orderId,
      first: MAX_LIMIT,
    });
    for (const id of this.lineItemIds) {
      const lineItem = order.order.lineItems.edges.find((item) => item.node.id === id);
      props[`quantity_${id}`] = {
        type: "integer",
        label: `Quantity for line item - ${lineItem.node.title}`,
        description: "The quantity of the line item to refund",
      };
      props[`restockType_${id}`] = {
        type: "string",
        label: `Restock type for line item - ${lineItem.node.title}`,
        description: "The restock type for the line item",
        options: [
          "CANCEL",
          "NO_RESTOCK",
          "RETURN",
        ],
        default: "RETURN",
      };
      props[`locationId_${id}`] = {
        type: "string",
        label: `Location ID for line item - ${lineItem.node.title}`,
        description: "The location ID for the line item",
        options: async ({ prevContext }) => {
          return this.shopify.getPropOptions({
            resourceFn: this.shopify.listLocations,
            resourceKeys: [
              "locations",
            ],
            labelKey: "name",
            prevContext,
          });
        },
      };
    }
    return props;
  },
  async run({ $ }) {
    const response = await this.shopify.refundOrder({
      input: {
        note: this.note,
        orderId: this.orderId,
        refundLineItems: this.lineItemIds.map((id) => ({
          lineItemId: id,
          quantity: this[`quantity_${id}`],
          locationId: this[`locationId_${id}`],
          restockType: this[`restockType_${id}`],
        })),
      },
    });

    if (response.refundCreate.userErrors.length > 0) {
      throw new Error(response.refundCreate.userErrors[0].message);
    }
    $.export("$summary", `Refunded order with ID: ${this.orderId}`);
    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
Shopify	`shopify`	`app`	This component uses the Shopify app.
Order ID	`orderId`	`string`	Select a value from the drop down menu.
Note	`note`	`string`	An optional note that's attached to the refund
Line Item IDs	`lineItemIds`	`string[]`	Select a value from the drop down menu.

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)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

More Ways to Connect Shopify + ExhibitDay#

Other Popular Integrations#

Update Task with ExhibitDay API on New Article from Shopify Developer App API

Shopify + ExhibitDay

Refund Order with Shopify API on New Event from ExhibitDay API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,800+apps by most popular

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