View as Markdown
Business Edge icon

Business Edge ACTION

Order Upload

Upload an order to Business Edge via POST /documents/orderupload/export.json. ImpOrder is required and validated before the request (OrdDate, ImpDtlLine with product id + OrdQty; ShipTo/BillTo/ThirdPartyBillTo require Name when set). See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Business Edge account once, then configure and run Order Upload 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: "business_edge-order-upload",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    business_edge: { authProvisionId: "apn_xxxxxxx" },
    entity: "Entity",
    dateFormatOpt: "Date Format (DateFormatOpt)",
  },
})

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.

Order Upload inputs
Property Type Description
entity Entity string
Entity for this request. Options load from customer V3 args.json when available; otherwise numeric codes 1–20 are shown (configurable fallback).
Required Dynamic
dateFormatOpt Date Format (DateFormatOpt) string
A=mm-dd-yy; B=yy-mm-dd; C=yyyy-mm-dd; D=mmddyy; E=yymmdd; F=yyyymmdd; G=dd-mm-yy; H=ddmmyy
Optional
dateDelim Date Delimiter (DateDelim) string
Separator for delimited date formats. Ignored (not sent) when DateFormatOpt is D, E, F, or H (compact formats without delimiters). Default "-" for other formats.
Optional
savedSchemaId Saved Schema ID (SavedSchemaID) string
Optional saved API schema ID for returned data (use with or instead of schema code)
Optional
savedSchemaCode Saved Schema Code (SavedSchemaCode) string
Optional saved API schema code for returned data (use with or instead of schema ID)
Optional
impOrder Import Order (ImpOrder) object
Order header and lines (ImpDtlLine). OrdDate required; each line needs OrdQty plus one of ProdCode, ProdID, BinBarcode, AnyScan; optional ShipTo/BillTo/ThirdPartyBillTo require Name when included
Required

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
business_edge-order-upload
Version
0.0.3
App
Business Edge
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes