View as Markdown
Picqer icon

Picqer ACTION

Create Picqer Order

Create a new order in Picqer. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Picqer account once, then configure and run Create Picqer 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: "picqer-create-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    picqer: { authProvisionId: "apn_xxxxxxx" },
    customerId: "Customer ID",
    templateId: "Template Id",
  },
})

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 Picqer Order inputs
Property Type Description
customerId Customer ID string
The customer id for creating a new order.
Optional Dynamic
templateId Template Id string
The template id for creating a new order.
Optional Dynamic
shippingProviderId Shipping Provider Id string
The shipping provider id for creating a new order.
Optional Dynamic
deliveryName Delivery Name string
Name of delivery address. Required if Customer Id is not provided.
Required
deliveryContactName Delivery Contact Name string
Contact name of delivery address.
Optional
deliveryAddress Delivery Address string
Address line of delivery address.
Optional
deliveryAddress2 Delivery Address 2 string
Second address line. Not accepted by all shipping providers.
Optional
deliveryZipcode Delivery Zipcode string
ZIP code of delivery address.
Optional
deliveryCity Delivery City string
City of delivery address.
Optional
deliveryRegion Delivery Region string
Region, province or state of delivery address.
Optional
deliveryCountry Delivery Country string
Country of delivery address (needs to be ISO 3166 2-char code). Required if Customer Id is not provided.
Required
invoiceName Invoice Name string
Name of invoice address. Required if Customer Id is not provided.
Optional
invoiceContactName Invoice Contact Name string
Contact name of invoice address
Optional
invoiceAddress Invoice Address string
Address line of invoice address
Optional
invoiceAddress2 Invoice Address 2 string
Second address line. Not accepted by all shipping providers.
Optional
invoiceZipcode Invoice Zipcode string
ZIP code of invoice address
Optional
invoiceCity Invoice City string
City of invoice address
Optional
invoiceRegion Invoice Region string
Region, province or state of invoice address
Optional
invoiceCountry Invoice Country string
Country of invoice address (needs to be ISO 3166 2-char code).
Required
telephone Telephone string
Telephone number of the customer.
Optional
emailAddress Email Address string
Email address of the customer
Optional
reference Reference string
Reference for customer, will be printed on invoice and picking list
Optional
customerRemarks Customer Remarks string
Remarks from the customer, will be printed on picking and packing list
Optional
partialDelivery Partial Delivery boolean
If Picqer AutoSplit is enabled, order can be split over multiple picklists over multiple warehouses. If disabled, it will wait for all products to be available
Optional
discount Discount string
Discount percentage of order
Optional
invoiced Invoiced boolean
If this order is already invoiced, set this to true. This will make sure Picqer will not invoice this order
Optional
preferredDeliveryDate Preferred Delivery Date string
Customer supplied preferred delivery date, in format yyyy-mm-dd.
Optional
language Language string
Language of the order
Optional
products Products string[]
List of objects of products to add to the order. Format: [{"idproduct": 123, "productcode": "ABC123", "name": "Product Name", "remarks": "Product remarks", "amount": 100, "idvatgroup": 123}]
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
picqer-create-order
Version
0.0.3
App
Picqer
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes