List Orders with Order Desk API on New File Created from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Order Desk, OpenAI (ChatGPT) and 2,900+ other apps remarkably fast.

Trigger workflow on

New File Created from the OpenAI (ChatGPT) API

Next, do this

List Orders with the Order Desk 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 OpenAI (ChatGPT) trigger and Order Desk action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New File Created trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
3. Optional- Select a Purpose
4. Optional- Configure Include Link
5. Optional- Configure dir
Configure the List Orders action
1. Connect your Order Desk account
2. Optional- Configure Search Start Date Local
3. Optional- Configure Search End Date Local
4. Optional- Configure Search Start Date
5. Optional- Configure Search End Date
6. Optional- Configure Modified Start Date
7. Optional- Configure Modified End Date
8. Optional- Configure Order By
9. Optional- Select a Order
10. Optional- Configure Folder ID
11. Optional- Configure Folder Name
12. Optional- Configure Source ID
13. Optional- Select a Source Name
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 File Created on OpenAI (ChatGPT)

Description:Emit new event when a new file is created in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/files/list)

Version:0.1.0

Key:openai-new-file-created

View on GitHub

OpenAI (ChatGPT) Overview#

OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:

Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:

Trigger Code#

import common from "../common/common.mjs";
import { Readable } from "stream";
import { fileTypeFromBuffer } from "file-type";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "openai-new-file-created",
  name: "New File Created",
  description: "Emit new event when a new file is created in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/files/list)",
  version: "0.1.0",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    purpose: {
      propDefinition: [
        common.props.openai,
        "purpose",
      ],
      description: "If specified, events will only be emitted for files with the specified purpose.",
      optional: true,
    },
    includeLink: {
      label: "Include Link",
      type: "boolean",
      description: "Upload file to your File Stash and emit temporary download link to the file. See [the docs](https://pipedream.com/docs/connect/components/files) to learn more about working with files in Pipedream.",
      default: false,
      optional: true,
    },
    dir: {
      type: "dir",
      accessMode: "write",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getData() {
      return this.openai.listFiles({
        purpose: this.purpose,
      });
    },
    getMeta(item) {
      return {
        id: item.id,
        summary: `New File: ${item.filename}`,
        ts: item.created_at * 1000,
      };
    },
    async stashFile(item) {
      const response = await this.openai.retrieveFileContent({
        file_id: item.id,
        responseType: "arraybuffer",
      });
      const buffer = Buffer.from(response);
      const filepath = `${item.id}/${item.filename}`;
      const type = await fileTypeFromBuffer(buffer);
      const file = await this.dir.open(filepath).fromReadableStream(
        Readable.from(buffer),
        type?.mime,
        buffer.length,
      );
      return await file.withoutPutUrl().withGetUrl();
    },
    async getAndProcessItems(maxEvents) {
      const lastCreated = this._getLastCreated();
      const { data } = await this.getData();
      if (!data?.length) {
        return;
      }
      this._setLastCreated(data[0].created_at);
      const items = data?.filter(({ created_at }) => created_at >= lastCreated).reverse();
      let count = 0;
      for (const item of items) {
        if (!maxEvents || count < maxEvents) {
          if (this.includeLink) {
            try {
              item.file = await this.stashFile(item);
            } catch (error) {
              item.file = `Could not upload file ${item.filename } to File Stash`;
            }
          }
          this.$emit(item, this.getMeta(item));
          count++;
        }
      }
    },
  },
  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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Purpose	`purpose`	`string`	Select a value from the drop down menu:`fine-tuneassistantsvisionbatch`
Include Link	`includeLink`	`boolean`	Upload file to your File Stash and emit temporary download link to the file. See the docs to learn more about working with files in Pipedream.
	`dir`	`dir`

Trigger Authentication#

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

About OpenAI (ChatGPT)#

OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.

Action#

List Orders on Order Desk

Description:List Orders based on a search criteria [See the documentation](https://apidocs.orderdesk.com/#get-multiple-orders).

Version:0.0.2

Key:order_desk-list-orders

View on GitHub

Order Desk Overview#

The Order Desk API allows you to automate and streamline order management processes within the Order Desk platform. With this API, you have the power to create, update, and get detailed information on orders, inventory, and shipments. Pipedream's serverless platform enables you to connect the Order Desk API with numerous other apps and services to build dynamic workflows. Whether you're syncing order data, managing inventory, or connecting to fulfillment services, Pipedream can help you craft custom automations that save time and reduce manual errors.

Action Code#

import options from "../../common/options.mjs";
import app from "../../order_desk.app.mjs";

export default {
  name: "List Orders",
  description: "List Orders based on a search criteria [See the documentation](https://apidocs.orderdesk.com/#get-multiple-orders).",
  key: "order_desk-list-orders",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    app,
    search_start_date_local: {
      type: "string",
      label: "Search Start Date Local",
      description: "Start date from when an order was added. Search in local store time.",
      optional: true,
    },
    search_end_date_local: {
      type: "string",
      label: "Search End Date Local",
      description: "End date from when an order was added. Search in local store time.",
      optional: true,
    },
    search_start_date: {
      type: "string",
      label: "Search Start Date",
      description: "Start date from when an order was added. Search in UTC time.",
      optional: true,
    },
    search_end_date: {
      type: "string",
      label: "Search End Date",
      description: "End date from when an order was added. Search in UTC time.",
      optional: true,
    },
    modified_start_date: {
      type: "string",
      label: "Modified Start Date",
      description: "Start date from when an order was last modified. Search in UTC time.",
      optional: true,
    },
    modified_end_date: {
      type: "string",
      label: "Modified End Date",
      description: "End date from when an order was last modified. Search in UTC time.",
      optional: true,
    },
    order_by: {
      type: "string",
      label: "Order By",
      description: "Order the query by an order field. Defaults to `date_added`",
      optional: true,
    },
    order: {
      type: "string",
      label: "Order",
      description: "Order the query by `asc` or `desc`. Defaults to `desc`",
      options: options.orderDir,
      optional: true,
    },
    folder_id: {
      propDefinition: [
        app,
        "folder_id",
      ],
      description: "Search for orders from a particular folder. For multiple folders, enter multiple ID's separated by a comma: `1004,1009,1010`",
    },
    folder_name: {
      type: "string",
      label: "Folder Name",
      description: "Search for orders from a particular folder. Enter the folder's exact name instead of its ID.",
      optional: true,
    },
    source_id: {
      propDefinition: [
        app,
        "source_id",
      ],
      description: "The Source Id",
    },
    source_name: {
      propDefinition: [
        app,
        "source_name",
      ],
      description: "The Source Name",
    },
  },
  async run({ $ }) {
    const {
      app,
      ...params
    } = this;
    const data = [];
    let page = 0;
    while (true) {
      const res = await app.listOrders(page, params);
      if (res.orders.length === 0) {
        break;
      }
      data.push(...res.orders);
      page++;
    }

    $.export("summary", `Successfully retrieved ${data.length} order(s).`);
    return data;
  },
};

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
Order Desk	`app`	`app`	This component uses the Order Desk app.
Search Start Date Local	`search_start_date_local`	`string`	Start date from when an order was added. Search in local store time.
Search End Date Local	`search_end_date_local`	`string`	End date from when an order was added. Search in local store time.
Search Start Date	`search_start_date`	`string`	Start date from when an order was added. Search in UTC time.
Search End Date	`search_end_date`	`string`	End date from when an order was added. Search in UTC time.
Modified Start Date	`modified_start_date`	`string`	Start date from when an order was last modified. Search in UTC time.
Modified End Date	`modified_end_date`	`string`	End date from when an order was last modified. Search in UTC time.
Order By	`order_by`	`string`	Order the query by an order field. Defaults to `date_added`
Order	`order`	`string`	Select a value from the drop down menu:`ascdesc`
Folder ID	`folder_id`	`string`	Search for orders from a particular folder. For multiple folders, enter multiple ID's separated by a comma: `1004,1009,1010`
Folder Name	`folder_name`	`string`	Search for orders from a particular folder. Enter the folder's exact name instead of its ID.
Source ID	`source_id`	`string`	The Source Id
Source Name	`source_name`	`string`	Select a value from the drop down menu:`Order DeskFoxyCartWooCommerceBigCommerceAmazonShopifyeBayMagentoMagento 2GumroadWufooInterspirePayPalStripeEtsyJetZapierSpark PaySnipcartRecurlyVolusionChargebeeWeeblyWalmartWalmart.comModular MerchantEcwidUltraCartnopCommerceSquarespaceCeleryE-junkieCommerceHQBrightStoresSamCartWayfairSpree`

Action Authentication#

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

To retrieve your API key,

Navigate to your Order Desk account and sign in
Go to “Store Settings” > “API”

List Orders with Order Desk API on New File Created from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Order Desk, OpenAI (ChatGPT) and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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