View as Markdown
Billbee icon

Billbee ACTION

List Orders

Retrieve a list of orders. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Billbee 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: "billbee-list-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    billbee: { authProvisionId: "apn_xxxxxxx" },
    minOrderDate: "Minimum Order Date",
    maxOrderDate: "Maximum Order Date",
  },
})

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
minOrderDate Minimum Order Date string
Specifies the oldest order date to include in the response (ISO format). Eg. 2025-01-01
Optional
maxOrderDate Maximum Order Date string
Specifies the newest order date to include in the response (ISO format). Eg. 2025-01-01
Optional
shopId Shop IDs string[]
Specifies a list of shop IDs for which orders should be included
Optional Dynamic
orderStateId Order State IDs string[]
Specifies a list of state IDs to include in the response
Optional Dynamic
tag Tags string[]
Specifies a list of tags the order must have attached to be included in the response
Optional
minimumBillBeeOrderId Minimum Billbee Order ID integer
If given, all delivered orders have an ID greater than or equal to the given minimumOrderId
Optional
modifiedAtMin Modified At Minimum string
If given, the last modification has to be newer than the given date (ISO format). Eg. 2025-01-01
Optional
modifiedAtMax Modified At Maximum string
If given, the last modification has to be older or equal than the given date (ISO format). Eg. 2025-01-01
Optional
articleTitleSource Article Title Source integer
The source field for the article title
Optional
excludeTags Exclude Tags boolean
If true the list of tags passed to the call are used to filter orders to not include these tags
Optional
max Maximum Results integer
Maximum number of orders to return
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
billbee-list-orders
Version
0.0.3
App
Billbee
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes