List Customers with Orderspace API

Pipedream makes it easy to connect APIs for Orderspace and 2,700+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

List Customers with the Orderspace 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 List Customers with the Orderspace API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the List Customers action
1. Connect your Orderspace account
2. Optional- Configure Created Since
3. Optional- Configure Company Name
4. Optional- Configure Buyer's Email Address
5. Optional- Select a Status
6. Optional- Configure Reference
7. Optional- Select a Payment Term ID
8. Optional- Select a Customer Group ID
9. Optional- Select a Price List ID
10. Optional- Configure Max Results
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

Integrations#

List Customers with Orderspace API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Orderspace

Try it

List Customers with Orderspace API on New Submission from Typeform API

Typeform + Orderspace

Try it

List Customers with Orderspace API on New Submission (Instant) from Jotform API

Jotform + Orderspace

Try it

List Customers with Orderspace API on New Scheduled Tasks from Pipedream API

Pipedream + Orderspace

Try it

List Customers with Orderspace API on New Download Counts from npm API

npm + Orderspace

Try it

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.

List Customers on Orderspace

Description:List a list of customers. [See the documentation](https://apidocs.orderspace.com/#list-customers)

Version:0.0.1

Key:orderspace-list-customers

View on GitHub

Code#

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

export default {
  key: "orderspace-list-customers",
  name: "List Customers",
  description: "List a list of customers. [See the documentation](https://apidocs.orderspace.com/#list-customers)",
  version: "0.0.1",
  type: "action",
  props: {
    orderspace,
    createdSince: {
      type: "string",
      label: "Created Since",
      description: "Return records created since the given date and time in ISO 8601 format, e.g. 2019-10-29T21:00",
      optional: true,
    },
    companyName: {
      type: "string",
      label: "Company Name",
      description: "Return customers with the specified company name",
      optional: true,
    },
    buyersEmailAddress: {
      type: "string",
      label: "Buyer's Email Address",
      description: "Return customers with the specified buyers email address",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "Return customers with the specified status",
      options: [
        "new",
        "active",
        "closed",
      ],
      optional: true,
    },
    reference: {
      type: "string",
      label: "Reference",
      description: "Return customers with the specified reference",
      optional: true,
    },
    paymentTermId: {
      propDefinition: [
        orderspace,
        "paymentTermId",
      ],
      description: "Return customers with the specified payment terms",
    },
    customerGroupId: {
      propDefinition: [
        orderspace,
        "customerGroupId",
      ],
      description: "Return customers in the specified group",
    },
    priceListId: {
      propDefinition: [
        orderspace,
        "priceListId",
      ],
      description: "Return customers with the specified price list",
    },
    maxResults: {
      propDefinition: [
        orderspace,
        "maxResults",
      ],
    },
  },
  async run({ $ }) {
    const { customers } = await this.orderspace.listCustomers({
      $,
      params: {
        created_since: this.createdSince,
        company_name: this.companyName,
        buyers_email_address: this.buyersEmailAddress,
        status: this.status,
        reference: this.reference,
        payment_terms_id: this.paymentTermId,
        customer_group_id: this.customerGroupId,
        price_list_id: this.priceListId,
        limit: this.maxResults,
      },
    });
    $.export("$summary", `Successfully listed ${customers.length} customers`);
    return customers;
  },
};

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
Orderspace	`orderspace`	`app`	This component uses the Orderspace app.
Created Since	`createdSince`	`string`	Return records created since the given date and time in ISO 8601 format, e.g. 2019-10-29T21:00
Company Name	`companyName`	`string`	Return customers with the specified company name
Buyer's Email Address	`buyersEmailAddress`	`string`	Return customers with the specified buyers email address
Status	`status`	`string`	Select a value from the drop down menu:`newactiveclosed`
Reference	`reference`	`string`	Return customers with the specified reference
Payment Term ID	`paymentTermId`	`string`	Select a value from the drop down menu.
Customer Group ID	`customerGroupId`	`string`	Select a value from the drop down menu.
Price List ID	`priceListId`	`string`	Select a value from the drop down menu.
Max Results	`maxResults`	`integer`	The maximum number of results to return. The default is `50` and the maximum limit is `200`

Authentication#

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

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