View as Markdown
SureCart icon

SureCart ACTION

Update Shipment

Update an existing shipment. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SureCart account once, then configure and run Update Shipment 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: "surecart-update-shipment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    surecart: { authProvisionId: "apn_xxxxxxx" },
    shipmentId: "Shipment ID",
    labelFileType: "Label File Type",
  },
})

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 Shipment inputs
Property Type Description
shipmentId Shipment ID string
The unique identifier of the shipment. Use List Shipments to retrieve a list of available shipments.
Required
labelFileType Label File Type string
Format of the shipping label to generate.
Optional
parcelTemplate Parcel Template ID string
UUID of a parcel template to use for dimensions and weight. Example: pt_abc123
Optional
weight Weight string
Weight of the shipment as a string. Example: 2.5
Optional
weightUnit Weight Unit string
Unit for the weight value.
Optional
inheritWeight Inherit Weight boolean
Automatically calculate weight from the fulfillment items.
Optional
shippingDate Shipping Date (Unix timestamp) integer
Scheduled ship date as a Unix timestamp. Example: 1700000000
Optional
dimensions Dimensions object
Package dimensions object with length, width, height, and unit. Example: { "length": 10, "width": 8, "height": 4, "unit": "in" }
Optional
fulfillment Fulfillment ID string
The unique identifier of the fulfillment. Use List Fulfillments to retrieve a list of available fulfillments.
Required
shippingProvider Shipping Provider ID string
UUID of the shipping provider to use. Example: sp_abc123
Optional
fromContact From Contact object
Origin address details. Example: { "name": "Sender", "street1": "123 Main St", "city": "New York", "state": "NY", "zip": "10001", "country": "US" }
Optional
toContact To Contact object
Destination address details. Example: { "name": "Recipient", "street1": "456 Oak Ave", "city": "Los Angeles", "state": "CA", "zip": "90001", "country": "US" }
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
surecart-update-shipment
Version
0.0.3
App
SureCart
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes