View as Markdown
Delivery Match icon

Delivery Match ACTION

Get Status

Return all status event details of a shipment. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Delivery Match account once, then configure and run Get Status 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: "delivery_march-get-status",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    delivery_march: { authProvisionId: "apn_xxxxxxx" },
    shipmentId: 10,
    orderNumber: "Order Number",
  },
})

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.

Get Status inputs
Property Type Description
shipmentId Shipment ID integer
The ID of the shipment to get status for
Optional Dynamic
orderNumber Order Number string
The order number to get status for
Optional Dynamic
channel Channel string
The channel through which the shipments have been made. Example: shopify
Optional
dateFrom Date From string
The starting date for the shipment status event period. Example: 2023-01-16 15:30:11
Optional
dateTo Date To string
The ending date for the shipment status event period. Example: 2023-01-16 15:30:11
Optional
isIncremental Is Incremental boolean
If true, shows which status events have been received. If false, all status events will be returned.
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
delivery_march-get-status
Version
0.0.1
App
Delivery Match
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes