# Get Home Delivery Shipping Options — Paazl

> Contains shipping options for your checkout page. See the documentation

- Key: `paazl-get-shipping-options`
- Type: Action (Read-only)
- Version: 0.0.2
- App: Paazl (`paazl`) — https://pipedream.com/apps/paazl.md
- This page (HTML): https://pipedream.com/apps/paazl/actions/get-shipping-options
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/paazl/actions/get-shipping-options/get-shipping-options.mjs

## Description

Contains shipping options for your checkout page. [See the documentation](https://support.paazl.com/hc/en-us/articles/360008633973-REST-API-reference#/Shipping%20options/shippingOptionsUsingPOST)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `consigneeCountryCode` | `string` | Yes | The ISO 3166-2 code for the country to which an order is shipped (e.g., NL, DE) |
| `consigneePostalCode` | `string` | No | The postal code of the address to which an order is shipped |
| `consignorCountryCode` | `string` | No | The ISO 3166-2 code for the country the shipment is being sent from |
| `consignorPostalCode` | `string` | No | The postal code of the address from which an order is shipped |
| `locale` | `string` | No | 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) |
| `timeZone` | `string` | No | Specifies the time zone for which the delivery days should be calculated (e.g., Europe/Amsterdam, UTC) |
| `limit` | `integer` | No | The maximum number of shipping options that Paazl must return (min: 1, max: 99) |
| `numberOfProcessingDays` | `integer` | No | The number of days a warehouse needs to get an order ready for pick-up by a carrier (min: 0, max: 99) |
| `includeExternalDeliveryDates` | `boolean` | No | Gets delivery dates directly from the carrier if the carrier supplies them |
| `deliveryDateStartDate` | `string` | No | The starting point of a range of possible delivery dates (format: YYYY-MM-DD) |
| `deliveryDateNumberOfDays` | `integer` | No | The length of time in days after start date for which shipping options are supplied |
| `token` | `string` | No | The access token returned by the token endpoint |
| `tags` | `string[]` | No | Codes that are used to filter returned shipping options for display |
| `sortOrderBy` | `string` | No | Indicates the field by which to sort the shipping options returned |
| `sortOrder` | `string` | No | Indicates the order in which shipping options should be sorted |
| `sortDistributor` | `string` | No | Indicates which carrier's shipping options should appear at the top (required if orderBy is CARRIER) |
| `totalWeight` | `string` | No | The total weight in kilograms (kg) of the shipment, including packaging |
| `totalPrice` | `string` | No | The total price of a shipment |
| `totalVolume` | `string` | No | The total volume of a shipment, including packaging, in cubic meters |
| `numberOfGoods` | `integer` | No | The total number of packages or individual goods in a shipment |
| `startMatrix` | `string` | No | A one- or two-letter code identifying the delivery matrix column to start with |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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-shipping-options",
  arguments: {
    consigneeCountryCode: "Consignee Country Code",
    consigneePostalCode: "Consignee Postal Code",
  },
})
```

**TypeScript**

```ts
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-shipping-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**

```bash
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-shipping-options",
    "configured_props": {
      "paazl": { "authProvisionId": "apn_xxxxxxx" },
      "consigneeCountryCode": "Consignee Country Code",
      "consigneePostalCode": "Consignee Postal Code"
    }
  }'
```

---

- App: https://pipedream.com/apps/paazl.md · All apps: https://pipedream.com/apps