View as Markdown
WICS icon

WICS ACTION

Update Order

Update an order. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's WICS account once, then configure and run Update 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: "wics-update-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    wics: { authProvisionId: "apn_xxxxxxx" },
    orderNumber: "Order Number",
    deliveryDate: "Delivery Date",
  },
})

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.

Update Order inputs
Property Type Description
orderNumber Order Number string
Number identifier for the order
Required Dynamic
deliveryDate Delivery Date string
The date that the order should be delivered. Format: YYYY-MM-DD
Optional
webshopId Webshop ID integer
The identifier that corresponds to the webshop account of Transmart or Paazl
Optional
warehouseCode Warehouse Code string
The warehouse used for this order
Optional
note Note string
A note that will shown alongside the order
Optional
tag Tag string
A shippingTag or tag that is linked with a shipment option in WICS.
Optional
pickupPoint Pickup Point string
A place for picking up the order
Optional
termsOfDelivery Terms of Delivery string
The delivery condition
Optional
type Type string
The order type of the order
Optional
invoiceAddressName Invoice Address Name string
The name of the invoice address
Optional
invoiceAddressStreetNumber Invoice Address Street Number string
The street number of the invoice address
Optional
invoiceAddressStreet Invoice Address Street Name string
The street name of the invoice address
Optional
invoiceAddressCity Invoice Address City string
The city of the invoice address
Optional
invoiceAddressState Invoice Address State string
The state of the invoice address
Optional
invoiceAddressZipcode Invoice Address Zipcode string
The zipcode of the invoice address
Optional
invoiceAddressCountry Invoice Address Country string
The country of the invoice address
Optional
invoiceEmail Invoice Email string
The email of the invoice address
Optional
deliveryAddressName Delivery Address Name string
The name of the delivery address
Optional
deliveryAddressStreetNumber Delivery Address Street Number string
The street number of the delivery address
Optional
deliveryAddressStreet Delivery Address Street Name string
The street name of the delivery address
Optional
deliveryAddressCity Delivery Address City string
The city of the delivery address
Optional
deliveryAddressState Delivery Address State string
The state of the delivery address
Optional
deliveryAddressZipcode Delivery Address Zipcode string
The zipcode of the delivery address
Optional
deliveryAddressCountry Delivery Address Country string
The country of the delivery address
Optional
deliveryEmail Delivery Email string
The email of the delivery address
Optional
lines Lines string[]
The lines of the order as an array of objects including the key lineNumber. Example: [{ "lineNumber": 20002, "itemCode": "16084", "itemDescription": "Speaker kabel", "quantity": 5 }] See the documentation for additional information
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
wics-update-order
Version
0.0.3
App
WICS
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes