View as Markdown
Monta icon

Monta ACTION

Create Inbound Forecast Group

Create a new inbound forecast group describing stock expected at the warehouse. Manage the group afterwards with Update Inbound Forecast Group, Get Inbound Forecast Group, or Delete Inbound Forecast Group. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Monta account once, then configure and run Create Inbound Forecast Group 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: "monta-create-inbound-forecast-group",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    monta: { authProvisionId: "apn_xxxxxxx" },
    reference: "Reference",
    inboundForecasts: ["Inbound Forecasts"],
  },
})

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.

Create Inbound Forecast Group inputs
Property Type Description
reference Reference string
A unique reference for the new inbound forecast group
Required
inboundForecasts Inbound Forecasts string[]
The forecasts in the group. Each entry is a JSON object with Sku, Quantity, and a DeliveryDate (ISO 8601), e.g. {"Sku":"ABC-123","Quantity":10,"DeliveryDate":"2026-07-31T00:00:00Z"}
Required
supplierCode Supplier Code string
The code of the supplier delivering this inbound
Optional
comment Comment string
A comment for the inbound forecast group
Optional
warehouseDisplayName Warehouse Display Name string
The display name of the warehouse the inbound is expected at
Optional
allocateStockOnDelivery Allocate Stock On Delivery boolean
Whether to allocate stock to backorders on delivery
Optional
expectedDeliveryDate Expected Delivery Date string
The expected delivery date in ISO 8601 format (e.g. 2026-07-24T14:30:00Z)
Optional
additionalFields Additional Fields object
Additional properties to send in the request body, using Monta's request-body casing (e.g. { "UniqueId": "..." })
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
monta-create-inbound-forecast-group
Version
0.0.2
App
Monta
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes