CONNECT APP
Build with Billbee
Commerce
- API key
MCP
Give your agent Billbee tools
Every Billbee action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Billbee account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "billbee",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Add Shipment To Order:
const result = await mcp.callTool({
name: "billbee-add-shipment-to-order",
arguments: {
orderId: "Order ID",
shippingProviderId: "Shipping Provider ID",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "billbee",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Add Shipment To Order:
result = await session.call_tool("billbee-add-shipment-to-order", {
"orderId": "Order ID",
"shippingProviderId": "Shipping Provider ID",
})API PROXY
Call the Billbee API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Billbee API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://app.billbee.io/api/v1/shopaccounts",
})
// Any allowed Billbee endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://app.billbee.io/api/v1/shopaccounts
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcHAuYmlsbGJlZS5pby9hcGkvdjEvc2hvcGFjY291bnRz?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Billbee actions from your backend
Connect a user's Billbee account once, then run Add Shipment To Order on their behalf from your own code — TypeScript, Python, or plain HTTP.
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-add-shipment-to-order",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
billbee: { authProvisionId: "apn_xxxxxxx" },
orderId: "Order ID",
shippingProviderId: "Shipping Provider ID",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="billbee-add-shipment-to-order",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"billbee": {"authProvisionId": "apn_xxxxxxx"},
"orderId": "Order ID",
"shippingProviderId": "Shipping Provider ID",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "billbee-add-shipment-to-order",
"configured_props": {
"billbee": { "authProvisionId": "apn_xxxxxxx" },
"orderId": "Order ID",
"shippingProviderId": "Shipping Provider ID"
}
}'TOOLS
Billbee actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Add Shipment To Order
actionAdd a shipment to an existing order. See the documentationWritev0.0.3 -
Change Order State
actionChange the state of an order. See the documentationWritev0.0.3 -
Create Invoice For Order
actionCreate an invoice for an existing order. See the documentationWritev0.0.3 -
Create Order
actionCreate a new order. See the documentationWritev0.0.3 -
Get Order By ID
actionRetrieve a specific order by its ID from Billbee. See the documentationRead-onlyv0.0.3 -
List Carrier ID Options
actionRetrieves available options for the Carrier ID field.Read-onlyv0.0.2 -
List Cloud Storage ID Options
actionRetrieves available options for the Cloud Storage ID field.Read-onlyv0.0.2 -
List Customer ID Options
actionRetrieves available options for the Customer ID field.Read-onlyv0.0.1 -
List Customers
actionRetrieve a list of customers. See the documentationRead-onlyv0.0.3 -
List Order ID Options
actionRetrieves available options for the Order ID field.Read-onlyv0.0.1 -
List Order State ID Options
actionRetrieves available options for the Order State ID field.Read-onlyv0.0.1 -
List Orders
actionRetrieve a list of orders. See the documentationRead-onlyv0.0.3 -
List Products
actionRetrieve a list of products. See the documentationRead-onlyv0.0.3 -
List Shipment Type Options
actionRetrieves available options for the Shipment Type field.Read-onlyv0.0.2 -
List Shipping Provider ID Options
actionRetrieves available options for the Shipping Provider ID field.Read-onlyv0.0.2 -
List Shop ID Options
actionRetrieves available options for the Shop ID field.Read-onlyv0.0.1 -
List Stock ID Options
actionRetrieves available options for the Stock ID field.Read-onlyv0.0.1 -
Update Order
actionPartially update an existing order. See the documentationWritev0.0.3 -
Update Stock
actionUpdate the stock level for a single product. See the documentationWritev0.0.3
EVENTS
Billbee triggers
Event sources your backend can deploy for users and receive through a webhook.
No Billbee triggers are available yet.
MULTI-APP
Use Billbee with other popular apps
Most products don't stop at one integration. Pair Billbee with the other apps your users rely on, and ship use cases that span both.
- App slug
- billbee
- Authentication
- API key
- Categories
- Commerce
- Actions
- 19
- Triggers
- 0
- API proxy
- Available