View as Markdown
Square icon

Square ACTION

Create Order

Creates a new order that can include information about products for purchase. See docs here.
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Square account once, then configure and run Create Order 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: "square-create-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    square: { authProvisionId: "apn_xxxxxxx" },
    location: "Location",
    customer: "Customer",
  },
})

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 Order inputs
Property Type Description
location Location string
The source of orders and fulfillments for a physical or virtual business
Required Dynamic
customer Customer string
The ID of the customer
Optional Dynamic
referenceId Reference ID string
An optional second ID used to associate the customer profile with an entity in another system
Optional
lineItems Line Items object
The line items included in the order. Please insert an array of OrderLineItems as a custom expression. For example: {{ [{"quantity": "1", "name": "Item 1", "base_price_money": {amount: 1, currency: "USD"} }, {"quantity": "2", "name": "Item 2", "base_price_money": {amount: 2, currency: "USD"} }] }}. See docs here
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
square-create-order
Version
0.0.4
App
Square
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes