View as Markdown
PostNL icon

PostNL ACTION

Get Status By Barcode

Retrieve the status of a shipment using its barcode. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's PostNL account once, then configure and run Get Status By Barcode 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: "postnl-get-status-by-barcode",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    postnl: { authProvisionId: "apn_xxxxxxx" },
    barcode: "Barcode",
    detail: true,
  },
})

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 By Barcode inputs
Property Type Description
barcode Barcode string
The barcode of the shipment to track. Eg. 3SABCD123456789
Required
detail Detail boolean
Option to include old statuses in the response
Optional
language Language string
Language of the returned shipment and status descriptions (default is Dutch)
Optional
maxDays Max Days integer
Limit the number of days that will be searched (decrease this amount for better performance).
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
postnl-get-status-by-barcode
Version
0.0.2
App
PostNL
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes