View as Markdown
PlentyONE icon

PlentyONE ACTION

Get Orders

Retrieves a list of orders from PlentyONE. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's PlentyONE account once, then configure and run Get 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: "plentyone-get-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    plentyone: { authProvisionId: "apn_xxxxxxx" },
    typeID: 10,
    contactId: "Contact ID",
  },
})

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.

Get Orders inputs
Property Type Description
typeID Order Type ID integer
Type of order to retrieve. If not provided, all order types will be retrieved.
Optional
contactId Contact ID string
ID of the contact to retrieve orders for.
Optional Dynamic
contactData Contact Data string
Filter that restricts the search result to orders with a specific contact data.
Optional
referrerId Referrer ID integer
Filter that restricts the search result to orders of a specific order referrer. The ID of the order referrer must be specified.
Optional
shippingProfileId Shipping Profile ID integer
Filter that restricts the search result to orders with a specific shipping profile. The ID of shipping profile must be specified.
Optional
shippingServiceProviderId Shipping Service Provider ID integer
Filter that restricts the search result to orders with a specific shipping service provider (like DHL, UPS, etc.). The ID of shipping service provider must be specified.
Optional
ownerUserId Owner User ID integer
Filter that restricts the search result to orders with a specific owner. The user ID of the owner must be specified.
Optional
warehouseId Warehouse ID integer
Filter that restricts the search result to orders with a specific main warehouse. The ID of the warehouse must be specified.
Optional
isEbayPlus Is eBay Plus boolean
Filter that restricts the search result to orders with the referrer eBay PLUS.
Optional
includedVariation Included Variation integer
Filter that restricts the search result to orders including a specific variation. The ID of the variation must be specified.
Optional
includedItem Included Item integer
Filter that restricts the search result to orders including a specific item. The ID of the item must be specified.
Optional
orderIds Order IDs string[]
Filter that restricts the search result to orders with a specific ID.
Optional Dynamic
countryId Country ID integer
Filter that restricts the search result to orders with a specific delivery or invoice country.
Optional Dynamic
orderItemName Order Item Name string
Filter that restricts the search result to orders including a specific item name. The name of the item must be specified.
Optional
variationNumber Variation Number integer
Filter that restricts the search result to orders including a specific variation number. The number of the variation must be specified.
Optional
packageNumber Package Number string
Filter that restricts the search result to orders including a specific package number. The number of the package must be specified.
Optional
externalOrderId External Order ID string
Filter that restricts the search result to orders including a specific external order ID. The external order ID must be specified.
Optional
clientId Client ID integer
Filter that restricts the search result to orders belonging to a specific client. The ID of the client must be specified.
Optional
paymentStatus Payment Status string
Filter that restricts the search result to orders with a specific payment status.
Optional
paymentMethodId Payment Method ID integer
Filter that restricts the search result to orders with a specific payment method. The ID of the payment method must be specified.
Optional
with With string[]
Load additional relations for an order.
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
plentyone-get-orders
Version
0.0.2
App
PlentyONE
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes