Paazl ACTION
Get Pickup Location Shipping Options
Contains pickup locations for your checkout page. See the documentation
- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Paazl account once, then configure and run Get Pickup Location Shipping Options 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: "paazl-get-pickup-location-options",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
paazl: { authProvisionId: "apn_xxxxxxx" },
consigneeCountryCode: "Consignee Country Code",
consigneePostalCode: "Consignee Postal Code",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "paazl-get-pickup-location-options",
"configured_props": {
"paazl": { "authProvisionId": "apn_xxxxxxx" },
"consigneeCountryCode": "Consignee Country Code",
"consigneePostalCode": "Consignee Postal Code"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "paazl",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "paazl-get-pickup-location-options",
arguments: {
consigneeCountryCode: "Consignee Country Code",
consigneePostalCode: "Consignee Postal Code",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
consigneeCountryCode Consignee Country Code | string | Required |
consigneePostalCode Consignee Postal Code | string | The postal code of the address to which an order is shipped Required |
consignorCountryCode Consignor Country Code | string | The ISO 3166-2 code for the country the shipment is being sent from Optional |
consignorPostalCode Consignor Postal Code | string | The postal code of the address from which an order is shipped Optional |
locale Locale | string | Specifies the language in which the widget is displayed. It is specified using the format {language}_{country}, where {language} is an ISO 639-1 language code and {country} is an ISO 3166-2 country code (e.g., en_US) Optional |
timeZone Time Zone | string | Specifies the time zone for which the delivery days should be calculated (e.g., Europe/Amsterdam, UTC) Optional |
limit Limit | integer | The maximum number of shipping options that Paazl must return (min: 1, max: 99) Optional |
numberOfProcessingDays Number of Processing Days | integer | The number of days a warehouse needs to get an order ready for pick-up by a carrier (min: 0, max: 99) Optional |
includeExternalDeliveryDates Include External Delivery Dates | boolean | Gets delivery dates directly from the carrier if the carrier supplies them Optional |
deliveryDateStartDate Delivery Date Start Date | string | The starting point of a range of possible delivery dates (format: YYYY-MM-DD) Optional |
deliveryDateNumberOfDays Delivery Date Number of Days | integer | The length of time in days after start date for which shipping options are supplied Optional |
token Token | string | The access token returned by the token endpoint Optional |
network Network | string | Specifies what type(s) of pickup locations you want Paazl to send you Optional |
crossBorderStores Cross Border Stores | boolean | Shows stores from different countries Optional |
excludeLockers Exclude Lockers | boolean | Get all shipping options except those that have parcel locker support Optional |
lockersOnly Lockers Only | boolean | Get only shipping options with parcel locker support Optional |
tags Tags | string[] | Codes that are used to filter returned shipping options for display Optional |
totalWeight Total Weight | string | The total weight in kilograms (kg) of the shipment, including packaging Optional |
totalPrice Total Price | string | The total price of a shipment Optional |
totalVolume Total Volume | string | The total volume of a shipment, including packaging, in cubic meters Optional |
numberOfGoods Number of Goods | integer | The total number of packages or individual goods in a shipment Optional |
startMatrix Start Matrix | string | A one- or two-letter code identifying the delivery matrix column to start with 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
- paazl-get-pickup-location-options
- Version
- 0.0.2
- App
- Paazl
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗