Get Orders with TicketSauce API

Pipedream makes it easy to connect APIs for TicketSauce and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Orders with the TicketSauce 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#

Create a workflow to Get Orders with the TicketSauce API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Orders action
1. Connect your TicketSauce account
2. Optional- Configure Partner ID
3. Optional- Configure Organization ID
4. Select a Event
5. Optional- Configure Per Page
6. Optional- Configure Page
7. Optional- Configure Search Query
8. Optional- Configure Return Questionnaires
9. Optional- Configure Return Tickets
10. Optional- Configure Return Line Item Fees
11. Optional- Configure Ordered After
12. Optional- Configure Ordered Before
13. Optional- Configure Modified After
14. Optional- Configure Modified Before
15. Optional- Select a Sort By
16. Optional- Select a Sort Direction
17. Optional- Configure Total Above
18. Optional- Configure Total Below
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Get Orders on TicketSauce

Description:Get a list of orders from the specified event. [See documentation](https://speca.io/ticketsauce/ticketsauce-public-api?key=204000d6bda66da78315e721920f43aa#orders)

Version:0.0.1

Key:ticketsauce-get-orders

View on GitHub

Code#

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

export default {
  key: "ticketsauce-get-orders",
  name: "Get Orders",
  description: "Get a list of orders from the specified event. [See documentation](https://speca.io/ticketsauce/ticketsauce-public-api?key=204000d6bda66da78315e721920f43aa#orders)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    ticketsauce,
    partnerId: {
      propDefinition: [
        ticketsauce,
        "partnerId",
      ],
    },
    organizationId: {
      propDefinition: [
        ticketsauce,
        "organizationId",
      ],
    },
    eventId: {
      propDefinition: [
        ticketsauce,
        "eventId",
        (c) => ({
          partnerId: c.partnerId,
          organizationId: c.organizationId,
        }),
      ],
    },
    perPage: {
      type: "string",
      label: "Per Page",
      description: "How many results to retrieve (per page). Max 500.",
      optional: true,
      default: "100",
    },
    page: {
      type: "string",
      label: "Page",
      description: "Which page to return. For example, if per_page is 20, and page is 3, the results would show 41-60.",
      optional: true,
      default: "1",
    },
    q: {
      type: "string",
      label: "Search Query",
      description: "Exact email address or last name attached to an order.",
      optional: true,
    },
    returnQuestionnaires: {
      type: "boolean",
      label: "Return Questionnaires",
      description: "Whether or not to return the question responses from questionnaires (will include attendee responses as well IF tickets are returned)",
      optional: true,
      default: false,
    },
    returnTickets: {
      type: "boolean",
      label: "Return Tickets",
      description: "Whether or not to return the tickets for each order as well.",
      optional: true,
      default: false,
    },
    returnLineItemFees: {
      type: "boolean",
      label: "Return Line Item Fees",
      description: "Whether or not to return the itemized line item fees for each order (if they exist).",
      optional: true,
      default: false,
    },
    orderedAfter: {
      type: "string",
      label: "Ordered After",
      description: "Only retrieve orders that were ordered AFTER the specified date/time (format`: YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`).",
      optional: true,
    },
    orderedBefore: {
      type: "string",
      label: "Ordered Before",
      description: "Only retrieve orders that were ordered BEFORE the specified date/time (format`: YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`).",
      optional: true,
    },
    modifiedAfter: {
      type: "string",
      label: "Modified After",
      description: "Only retrieve orders that were modified AFTER the specified date/time (format`: YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`).",
      optional: true,
    },
    modifiedBefore: {
      type: "string",
      label: "Modified Before",
      description: "Only retrieve orders that were modified BEFORE the specified date/time (format`: YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`).",
      optional: true,
    },
    sortBy: {
      type: "string",
      label: "Sort By",
      description: "Field to sort orders by.",
      optional: true,
      default: "date",
      options: [
        {
          label: "Ordered date",
          value: "date",
        },
        {
          label: "Last name",
          value: "name",
        },
      ],
    },
    sortDir: {
      type: "string",
      label: "Sort Direction",
      description: "Direction to sort results.",
      optional: true,
      default: "asc",
      options: [
        {
          label: "Ascending",
          value: "asc",
        },
        {
          label: "Descending",
          value: "desc",
        },
      ],
    },
    totalAbove: {
      type: "string",
      label: "Total Above",
      description: "Return only orders whose order total is greater than this value.",
      optional: true,
    },
    totalBelow: {
      type: "string",
      label: "Total Below",
      description: "Return only orders whose order total is less than this value.",
      optional: true,
    },
  },
  async run({ $ }) {
    const params = {
      per_page: this.perPage,
      page: this.page,
      q: this.q,
      return_questionnaires: String(this.returnQuestionnaires),
      return_tickets: String(this.returnTickets),
      return_line_item_fees: String(this.returnLineItemFees),
      ordered_after: this.orderedAfter,
      ordered_before: this.orderedBefore,
      modified_after: this.modifiedAfter,
      modified_before: this.modifiedBefore,
      sort_by: this.sortBy,
      sort_dir: this.sortDir,
      total_above: this.totalAbove,
      total_below: this.totalBelow,
    };

    return this.ticketsauce.listOrders($, {
      eventId: this.eventId,
      params,
    });
  },
};

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
TicketSauce	`ticketsauce`	`app`	This component uses the TicketSauce app.
Partner ID	`partnerId`	`string`	Including this ID will limit the result set to the specific partner.
Organization ID	`organizationId`	`string`	Including this ID will limit the result set to the specific organization.
Event	`eventId`	`string`	Select a value from the drop down menu.
Per Page	`perPage`	`string`	How many results to retrieve (per page). Max 500.
Page	`page`	`string`	Which page to return. For example, if per_page is 20, and page is 3, the results would show 41-60.
Search Query	`q`	`string`	Exact email address or last name attached to an order.
Return Questionnaires	`returnQuestionnaires`	`boolean`	Whether or not to return the question responses from questionnaires (will include attendee responses as well IF tickets are returned)
Return Tickets	`returnTickets`	`boolean`	Whether or not to return the tickets for each order as well.
Return Line Item Fees	`returnLineItemFees`	`boolean`	Whether or not to return the itemized line item fees for each order (if they exist).
Ordered After	`orderedAfter`	`string`	Only retrieve orders that were ordered AFTER the specified date/time (format`: YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`).
Ordered Before	`orderedBefore`	`string`	Only retrieve orders that were ordered BEFORE the specified date/time (format`: YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`).
Modified After	`modifiedAfter`	`string`	Only retrieve orders that were modified AFTER the specified date/time (format`: YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`).
Modified Before	`modifiedBefore`	`string`	Only retrieve orders that were modified BEFORE the specified date/time (format`: YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`).
Sort By	`sortBy`	`string`	Select a value from the drop down menu:`{ "label": "Ordered date", "value": "date" }{ "label": "Last name", "value": "name" }`
Sort Direction	`sortDir`	`string`	Select a value from the drop down menu:`{ "label": "Ascending", "value": "asc" }{ "label": "Descending", "value": "desc" }`
Total Above	`totalAbove`	`string`	Return only orders whose order total is greater than this value.
Total Below	`totalBelow`	`string`	Return only orders whose order total is less than this value.

Authentication#

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

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