← OTO

List Orders with OTO API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
List Orders with the OTO API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

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

  1. Configure the List Orders action
    1. Connect your OTO account
    2. Optional- Select a Status
    3. Optional- Configure Min Date
    4. Optional- Configure Max Date
    5. Optional- Configure Max Results
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

List Orders with OTO API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + OTO
 
Try it
List Orders with OTO API on New Submission from Typeform API
Typeform + OTO
 
Try it
List Orders with OTO API on New Submission (Instant) from Jotform API
Jotform + OTO
 
Try it
List Orders with OTO API on New Scheduled Tasks from Pipedream API
Pipedream + OTO
 
Try it
List Orders with OTO API on New Download Counts from npm API
npm + OTO
 
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 Orders on OTO
Description:Retrieves a list of orders. [See the documentation](https://apis.tryoto.com/#c2e94027-5214-456d-b653-0a66c038e3a4)
Version:0.0.1
Key:oto-list-orders

Code

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

export default {
  key: "oto-list-orders",
  name: "List Orders",
  description: "Retrieves a list of orders. [See the documentation](https://apis.tryoto.com/#c2e94027-5214-456d-b653-0a66c038e3a4)",
  version: "0.0.1",
  type: "action",
  props: {
    oto,
    status: {
      propDefinition: [
        oto,
        "status",
      ],
    },
    minDate: {
      type: "string",
      label: "Min Date",
      description: "Starting \"Order Creation Date\" of your orders in \"yyyy-mm-dd\" format",
      optional: true,
    },
    maxDate: {
      type: "string",
      label: "Max Date",
      description: "Ending \"Order Creation Date\" of your orders in \"yyyy-mm-dd\" format",
      optional: true,
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "The maximum number of orders to return",
      default: 100,
      optional: true,
    },
  },
  async run({ $ }) {
    const results = this.oto.paginate({
      fn: this.oto.listOrders,
      args: {
        $,
        params: {
          minDate: this.minDate,
          maxDate: this.maxDate,
          status: this.status,
        },
      },
      resourceKey: "orders",
      max: this.maxResults,
    });

    const orders = [];
    for await (const order of results) {
      orders.push(order);
    }

    if (orders[0].items?.length) {
      $.export("$summary", `Successfully retrieved ${orders.length} order${orders.length === 1
        ? ""
        : "s"}`);
    } else {
      $.export("$summary", "No orders found");
    }
    return orders;
  },
};

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.
LabelPropTypeDescription
OTOotoappThis component uses the OTO app.
StatusstatusstringSelect a value from the drop down menu:newpaymentConfirmedwaitingAddressConfirmationaddressConfirmedneedConfirmationpaymentTypeConfirmedcodOrderConfirmedorderConfirmedpickupFromStoreinterDepotTransfercanceleddeletedreadyForCollectionbranchAssignedassignedToWarehouseshipmentOnHoldWarehouseshipmentOnHoldToCancelnotAvailableBRnotAvailableWHpickedpackedsearchingDrivershipmentCreatedgoingToPickuparrivedPickuppickedUparrivedDestinationTerminalarrivedTerminaldepartedTerminalinTransitarrivedOriginTerminaloutForDeliveryarrivedDestinationshipmentInProgressundeliveredAttemptshipmentOnHolddeliveredreturnedreturnProcessingreturnShipmentProcessingreverseShipmentProcessingreverseShipmentCreatedreverseShipmentCanceledreverseGoingToPickupreversePickedUpreverseOutForDeliveryreverseArrivedTerminalreverseDepartedTerminalreverseArrivedDestinationTerminalreverseUndeliveredAttemptreverseShipmentOnHoldreverseReturnedreverseConfirmReturnshipmentCanceledlostOrDamagedconfirmedReturnapprovedrejectedreturnReverseComment
Min DateminDatestring

Starting "Order Creation Date" of your orders in "yyyy-mm-dd" format

Max DatemaxDatestring

Ending "Order Creation Date" of your orders in "yyyy-mm-dd" format

Max ResultsmaxResultsinteger

The maximum number of orders to return

Authentication

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

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

About OTO

The Best Shipping Gateway to Ship & Manage Orders

More Ways to Use OTO

Triggers

Order Status Updated (Instant) from the OTO API

Emit new event when the status of an order changes. See the documentation

 
Try it

Actions

Create Product with the OTO API

Creates a new product. See the documentation

 
Try it
Get Order Details with the OTO API

Provides detailed information about a specific order. See the documentation

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
OpenAI (ChatGPT)
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.
Anthropic (Claude)
Anthropic (Claude)
AI research and products that put safety at the frontier. Introducing Claude, a next-generation AI assistant for your tasks, no matter the scale.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Telegram
Telegram
Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
Pinterest
Pinterest
Pinterest is a visual discovery engine for finding ideas like recipes, home and style inspiration, and more.
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Shopify
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.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.