Get Property Rates

Overview

Retrieves available rates for a specific property with Journey-enriched pricing, including both cash and points payment options. This endpoint requires member authentication and provides personalized pricing based on the member's status and benefits.

The rates include detailed pricing breakdowns, room availability, cancellation policies, and Journey-specific features like points redemption options.

Authentication

Requires a valid Clerk JWT token in the Authorization header.

Request Body

strapiPropertyIdbodystringrequired

Strapi property Document ID

checkInbodystringrequired

Check-in date in ISO format (YYYY-MM-DD). Cannot be in the past.

checkOutbodystringrequired

Check-out date in ISO format (YYYY-MM-DD). Must be at least 1 day after check-in.

adultsbodynumberrequired

Number of adults (minimum: 1, maximum: 20)

childrenbodynumber

Number of children (minimum: 0, maximum: 10, default: 0)

strapiRoomIdsbodyarray

Array of Strapi room IDs to filter rates. If provided, only rates for these rooms will be returned.

Response

Returns available rates with Journey-enriched pricing and booking options.

ratesarrayrequired

Array of available rates

rate items

offerIdstringrequired

LiteAPI offer ID for booking

roomIdstringrequired

Strapi room Document ID

roomNamestringrequired

Room type name

rateCodestringrequired

Rate plan code

rateNamestringrequired

Rate plan name

boardTypestring

Meal plan included (e.g., "Room Only", "Breakfast Included")

refundablebooleanrequired

Whether the rate is refundable

cancellationPolicyobject

Cancellation terms and deadlines

cancellation policy

refundablebooleanrequired

Whether refunds are available

deadlinestring

Cancellation deadline (ISO datetime)

penaltyobject

Cancellation penalty details

penalty

amountnumber

Penalty amount

currencystring

Penalty currency

typestring

Penalty type (fixed, percentage, nights)

pricingobjectrequired

Journey-enriched pricing options

pricing

cashobjectrequired

Cash payment option

cash pricing

totalnumberrequired

Total cost in cash

currencystringrequired

Currency code (USD, EUR, etc.)

breakdownobject

Cost breakdown

breakdown

baseRatenumberrequired

Base room rate

taxesnumber

Taxes and fees

journeyFeenumber

Journey service fee

pointsobject

Points payment option (if available)

points pricing

totalnumberrequired

Total cost in points

availablebooleanrequired

Whether points payment is available

memberBalancenumber

Member's current points balance

redemptionRatenumber

Points to cash conversion rate

referenceobject

Reference pricing for transparency

reference pricing

retailRateobject

Journey's net cost before margin

retail rate

amountnumberrequired

Amount

currencystringrequired

Currency

sourcestring

Data source

suggestedSellingPriceobject

Suggested selling price from provider

taxesAndFeesobject

Separate taxes and fees

occupancyobjectrequired

Room occupancy details

occupancy

maxAdultsnumberrequired

Maximum adults for this room

maxChildrennumberrequired

Maximum children for this room

maxTotalnumberrequired

Maximum total occupancy

amenitiesarray

Rate-specific amenities and inclusions

imagesarray

Room images

image items

urlstringrequired

Image URL

altstring

Alt text

categorystring

Image category

propertyobjectrequired

Property information summary

property details

idstringrequired

Property Strapi Document ID

namestringrequired

Property name

addressobjectrequired

Property address

contactobject

Property contact information

searchCriteriaobjectrequired

Echo of the search parameters

search criteria

checkInstringrequired

Check-in date

checkOutstringrequired

Check-out date

adultsnumberrequired

Number of adults

childrennumber

Number of children

nightsnumberrequired

Number of nights

Example

const response = await fetch('https://api.journey.com/members/reservations/rates', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${clerkToken}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    strapiPropertyId: 'fkihstwpqlezcm1ogi31yu8f',
    checkIn: '2024-06-15',
    checkOut: '2024-06-17',
    adults: 2,
    children: 0
  })
});

Request

curl -X POST "https://api.journey.com/members/reservations/rates" \
  -H "Authorization: Bearer YOUR_CLERK_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "strapiPropertyId": "fkihstwpqlezcm1ogi31yu8f",
    "checkIn": "2024-06-15",
    "checkOut": "2024-06-17",
    "adults": 2,
    "children": 0,
    "strapiRoomIds": ["k87cr02ph4s17msgcndg3yxz"]
  }'

Response

200 Response

{
  "rates": [
    {
      "offerId": "GE5ESNBSIZKVMQ2Q...",
      "roomId": "k87cr02ph4s17msgcndg3yxz",
      "roomName": "Deluxe King Room",
      "rateCode": "JOURNEY_MEMBER",
      "rateName": "Journey Member Rate",
      "boardType": "Room Only",
      "refundable": true,
      "cancellationPolicy": {
        "refundable": true,
        "deadline": "2024-06-14T18:00:00Z",
        "penalty": null
      },
      "pricing": {
        "cash": {
          "total": 450.00,
          "currency": "USD",
          "breakdown": {
            "baseRate": 380.00,
            "taxes": 45.60,
            "journeyFee": 24.40
          }
        },
        "points": {
          "total": 45000,
          "available": true,
          "memberBalance": 125000,
          "redemptionRate": 0.01
        },
        "reference": {
          "retailRate": {
            "amount": 380.00,
            "currency": "USD",
            "source": "LiteAPI"
          },
          "suggestedSellingPrice": {
            "amount": 520.00,
            "currency": "USD",
            "source": "Hotel Direct"
          },
          "taxesAndFees": {
            "amount": 45.60,
            "currency": "USD"
          }
        }
      },
      "occupancy": {
        "maxAdults": 2,
        "maxChildren": 2,
        "maxTotal": 4
      },
      "amenities": [
        "Free WiFi",
        "City View",
        "Air Conditioning",
        "Mini Bar"
      ],
      "images": [
        {
          "url": "https://cdn.journey.com/rooms/deluxe-king-1.jpg",
          "alt": "Deluxe King Room interior",
          "category": "room"
        }
      ]
    }
  ],
  "property": {
    "id": "fkihstwpqlezcm1ogi31yu8f",
    "name": "Manhattan Boutique Hotel",
    "address": {
      "street": "123 Fifth Avenue",
      "city": "New York",
      "state": "NY",
      "country": "United States"
    },
    "contact": {
      "phone": "+1-212-555-0123",
      "email": "reservations@manhattanboutique.com"
    }
  },
  "searchCriteria": {
    "checkIn": "2024-06-15",
    "checkOut": "2024-06-17",
    "adults": 2,
    "children": 0,
    "nights": 2
  }
}

Usage Notes

Date Requirements

Check-in date: Cannot be in the past
Check-out date: Must be at least 1 day after check-in
Date format: ISO format (YYYY-MM-DD)

Pricing Features

Points redemption: Available when member has sufficient points balance
Transparent pricing: Reference pricing shows Journey's cost structure
Member rates: Exclusive rates available to authenticated members
Real-time availability: Rates are live and subject to availability

Room Filtering

Use strapiRoomIds to filter rates for specific room types when you already know which rooms are of interest.

Get Property Rates

OverviewCopy Anchor Link

AuthenticationCopy Anchor Link

Request BodyCopy Anchor Link

ResponseCopy Anchor Link

ExampleCopy Anchor Link

Usage NotesCopy Anchor Link

Date RequirementsCopy Anchor Link

Pricing FeaturesCopy Anchor Link

Room FilteringCopy Anchor Link

On this page

Overview

Authentication

Request Body

Response

Example

Usage Notes

Date Requirements

Pricing Features

Room Filtering