View as Markdown
Shipday icon

Shipday ACTION

Create Shipping Order

Creates a new shipping order. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shipday account once, then configure and run Create Shipping 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: "shipday-create-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shipday: { authProvisionId: "apn_xxxxxxx" },
    orderNumber: "Order Number",
    customerName: "Customer Name",
  },
})

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 Shipping Order inputs
Property Type Description
orderNumber Order Number string
Alphanumeric identifier for the order object
Required
customerName Customer Name string
The name of the customer
Required
customerAddress Customer Address string
The address of the customer
Required
customerEmail Customer Email string
The email address of the customer
Required
customerPhoneNumber Customer Phone Number string
Phone number of the customer with country code
Required
restaurantName Restaurant Name string
The name of the restaurant
Required
restaurantAddress Restaurant Address string
The address of the restaurant
Required
expectedDeliveryDate Expected Delivery Date string
Expected delivery date in UTC for the particular order ( yyyy-mm-dd format)
Optional
expectedPickupTime Expected Pickup Time string
Expected pickup time in UTC for the particular order (format hh:mm:ss)
Optional
expectedDeliveryTime Expected Delivery Time string
Expected Delivery Time in UTC for the particular order (format hh:mm:ss)
Optional
pickupLatitude Pickup Latitude string
The latitude of the pickup location
Optional
pickupLongitude Pickup Longitude string
The longitude of the pickup location
Optional
deliveryLatitude Delivery Latitude string
The latitude of the delivery location
Optional
deliveryLongitude Delivery Longitude string
The longitude of the delivery location
Optional
tips Tips string
Tips amount for the order
Optional
tax Tax string
The tax for the order
Optional
discountAmount Discount Amount string
The discount amount for the order
Optional
deliveryFee Delivery Fee string
The delivery fee for the order
Optional
totalOrderCost Total Order Cost string
The total cost of the order
Optional
pickupInstruction Pickup Instruction string
The pickup instructions for the order
Optional
deliveryInstruction Delivery Instruction string
The delivery instructions for the 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
shipday-create-order
Version
0.0.2
App
Shipday
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes