View as Markdown
ShipStation icon

ShipStation ACTION

List Orders

List orders optionally filtered by various criteria. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ShipStation account once, then configure and run List Orders from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "shipstation-list-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shipstation: { authProvisionId: "apn_xxxxxxx" },
    customerName: "Customer Name",
    itemKeyword: "Item Keyword",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Orders inputs
Property Type Description
customerName Customer Name string
Returns orders that match the specified customer name.
Optional
itemKeyword Item Keyword string
Returns orders that contain items that match the specified keyword. Fields searched are Sku, Description, and Options.
Optional
createDateStart Create Date Start string
Returns orders created in ShipStation after the specified date. E.g. 2015-01-01 00:00:00
Optional
createDateEnd Create Date End string
Returns orders created in ShipStation before the specified date. E.g. 2015-01-08 00:00:00
Optional
modifyDateStart Modify Date Start string
Returns orders modified after the specified date. E.g. 2015-01-01 00:00:00
Optional
modifyDateEnd Modify Date End string
Returns orders modified before the specified date. E.g. 2015-01-08 00:00:00
Optional
orderDateStart Order Date Start string
Returns orders greater than the specified date. E.g. 2015-01-01 00:00:00
Optional
orderDateEnd Order Date End string
Returns orders less than or equal to the specified date. E.g. 2015-01-08 00:00:00
Optional
orderNumber Order Number string
Filter by order number using a "starts with" search.
Optional
orderStatus Order Status string
Filter orders by status.
Optional
paymentDateStart Payment Date Start string
Returns orders paid after the specified date. E.g. 2015-01-01 00:00:00
Optional
paymentDateEnd Payment Date End string
Returns orders paid before the specified date. E.g. 2015-01-08 00:00:00
Optional
storeId Store string
A list of stores. Use the List Store ID Options action to get a list of store IDs.
Optional Dynamic
sortBy Sort By string
Sort orders by a specific field.
Optional
sortDir Sort Direction string
Sort direction for results.
Optional
page Page integer
Page number for pagination. Default is 1.
Optional
pageSize Page Size integer
Number of results per page. Maximum is 500.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
shipstation-list-orders
Version
0.0.2
App
ShipStation
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes