View as Markdown
Mews icon

Mews ACTION

Fetch Reservations

Retrieve reservations using Mews Connector API. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mews account once, then configure and run Fetch Reservations 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: "mews-fetch-reservations",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mews: { authProvisionId: "apn_xxxxxxx" },
    createdStartUtc: "Created Start (UTC)",
    createdEndUtc: "Created End (UTC)",
  },
})

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.

Fetch Reservations inputs
Property Type Description
createdStartUtc Created Start (UTC) string
Start of the interval in which Reservation was created. ISO 8601 format. Eg. 2025-01-01T00:00:00Z
Optional
createdEndUtc Created End (UTC) string
End of the interval in which Reservation was created. ISO 8601 format. Max 3 months interval. Eg. 2025-01-01T00:00:00Z
Optional
updatedStartUtc Updated Start (UTC) string
Start of the interval in which Reservations were updated. ISO 8601 format. Eg. 2025-01-01T00:00:00Z
Optional
updatedEndUtc Updated End (UTC) string
End of the interval in which Reservations were updated. ISO 8601 format. Max 3 months interval. Eg. 2025-01-01T00:00:00Z
Optional
collidingStartUtc Colliding Start (UTC) string
Start of the interval in which reservations are active. Reservation is selected if any part of its interval intersects with the interval specified. ISO 8601 format. Eg. 2025-01-01T00:00:00Z
Optional
collidingEndUtc Colliding End (UTC) string
End of the interval in which reservations are active. ISO 8601 format. Max 3 months interval. Eg. 2025-01-01T00:00:00Z
Optional
scheduledStartStartUtc Scheduled Start - Start (UTC) string
Start of the interval filtering Reservations by their scheduled start time. Cannot be used with Actual Start. ISO 8601 format. Eg. 2025-01-01T00:00:00Z
Optional
scheduledStartEndUtc Scheduled Start - End (UTC) string
End of the interval filtering Reservations by their scheduled start time. ISO 8601 format. Max 3 months interval. Eg. 2025-01-01T00:00:00Z
Optional
scheduledEndStartUtc Scheduled End - Start (UTC) string
Start of the interval filtering Reservations by their scheduled end time. Cannot be used with Actual End. ISO 8601 format. Eg. 2025-01-01T00:00:00Z
Optional
scheduledEndEndUtc Scheduled End - End (UTC) string
End of the interval filtering Reservations by their scheduled end time. ISO 8601 format. Max 3 months interval. Eg. 2025-01-01T00:00:00Z
Optional
actualStartStartUtc Actual Start - Start (UTC) string
Start of the interval filtering Reservations by their actual start (check-in) time. Cannot be used with Scheduled Start. Note that the filter applies only to started or processed reservations. ISO 8601 format. Eg. 2025-01-01T00:00:00Z
Optional
actualStartEndUtc Actual Start - End (UTC) string
End of the interval filtering Reservations by their actual start (check-in) time. ISO 8601 format. Max 3 months interval. Eg. 2025-01-01T00:00:00Z
Optional
actualEndStartUtc Actual End - Start (UTC) string
Start of the interval filtering Reservations by their actual end (check-out) time. Cannot be used with Scheduled End. ISO 8601 format. Eg. 2025-01-01T00:00:00Z
Optional
actualEndEndUtc Actual End - End (UTC) string
End of the interval filtering Reservations by their actual end (check-out) time. ISO 8601 format. Max 3 months interval. Eg. 2025-01-01T00:00:00Z
Optional
enterpriseIds Enterprise IDs string[]
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. Max 1000 items.
Optional Dynamic
reservationIds Reservation IDs string[]
Unique identifiers of the Reservations. Max 1000 items.
Optional Dynamic
serviceIds Service IDs string[]
Unique identifiers of the Services. If not provided, all bookable services are used. Max 1000 items.
Optional Dynamic
reservationGroupIds Reservation Group IDs string[]
Unique identifiers of Reservation groups. Max 1000 items.
Optional Dynamic
accountIds Account IDs string[]
Unique identifiers of accounts (currently only Customers, in the future also Companies) the reservation is associated with. Max 1000 items.
Optional Dynamic
partnerCompanyIds Partner Company IDs string[]
Unique identifiers of the Companies on behalf of which the reservations were made. Max 100 items.
Optional Dynamic
travelAgencyIds Travel Agency IDs string[]
Identifier of the Travel Agencies (Company) that mediated the reservations. Max 100 items. (Company with a TravelAgencyContract)
Optional Dynamic
numbers Confirmation Numbers string[]
Reservation confirmation numbers. Max 1000 items.
Optional
channelNumbers Channel Numbers string[]
Numbers or references used by a Channel (OTA, GDS, CRS, etc.) in case the reservation group originates there, e.g. Booking.com confirmation numbers. Max 100 items.
Optional
assignedResourceIds Assigned Resource IDs string[]
Unique identifiers of the Resources assigned to the reservations. Max 1000 items.
Optional Dynamic
availabilityBlockIds Availability Block IDs string[]
Unique identifiers of the Availability blocks assigned to the reservations. Max 100 items.
Optional
states States string[]
A list of service order states to filter by.
Optional
maxResults Max Results integer
Maximum number of records to return (min 1, max 99999). Leave blank to return every matching record.
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
mews-fetch-reservations
Version
0.1.0
App
Mews
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes