View as Markdown
Shopify  icon

Shopify ACTION

Create Order

Creates a new order. See the documentation.
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shopify 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: "shopify-create-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    lineItems: "Line Items",
    email: "Email",
  },
})

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
lineItems Line Items string
JSON array of line items for the order. Each item accepts variantId (GID) and quantity, plus optional title, priceSet, and taxLines. Example: [{"variantId": "gid://shopify/ProductVariant/123456789", "quantity": 1}]. Retrieve variant GIDs via the Search for Product Variant action.
Required
email Email string
Customer email for the order (e.g. customer@example.com).
Optional
currency Currency string
ISO 4217 currency code for the order (e.g. USD).
Optional
tags Tags string
Comma-separated tags to apply to the order (e.g. vip,priority).
Optional
inventoryBehaviour Inventory Behaviour string
How inventory is claimed for the order. One of BYPASS (do not claim inventory), DECREMENT_IGNORING_POLICY (claim inventory, ignoring the variant's inventory policy), or DECREMENT_OBEYING_POLICY (claim inventory, obeying the variant's inventory policy). Defaults to BYPASS.
Optional
sendReceipt Send Receipt boolean
Whether to send an order confirmation to the customer.
Optional
sendFulfillmentReceipt Send Fulfillment Receipt boolean
Whether to send a shipping confirmation to the customer.
Optional
additionalOrderFields Additional Order Fields object
JSON object of additional fields (e.g. customer, billingAddress, shippingAddress, transactions, note). Example: {"note": "Rush order"}.
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
shopify-create-order
Version
1.0.0
App
Shopify
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes