Marcus Cole

Marcus Cole

Last updated on Oct 6, 2026

The CRS API lets a point of sale — a booking site, an agency portal, a metasearch connector — search ChannelRUSH properties, price a stay, and place, retrieve, modify and cancel reservations. This guide is the part the Swagger page does not tell you: how the calls fit together and what trips integrations up.

A complete, runnable example accompanies this guide: a .NET booking site (reservation.services.crs) and a typed client library (reservation.services.crs.client). If you do not have it, ask ChannelRUSH for the CRS API example.

Environments

Base URL Swagger
Test https://testcrs.channelrush.net https://testcrs.channelrush.net/ (UI), /v3/swagger.json
Production https://crs.channelrush.net not served — generate clients from the test document

All paths are /api/v3/.... (/api/v2/... still answers; v3 adds Params on a reserved room and is the version to build against.) JSON property names are camelCase as published in the Swagger document.

Live documentation

The test environment publishes the API's reference documentation:

All message transmission, sending or receiving, is over an encrypted TLS (HTTPS) connection.

Authentication

ChannelRUSH issues one bearer token per channel. Send it on every request:

Authorization: Bearer <token>
  • One token covers every property mapped to your channel. It does not identify a property or a guest.
  • It does not expire; ChannelRUSH revokes it by changing the channel's credentials. Treat it like a password: server-side only, never in a browser or an app bundle, never in source control.
  • First call to make: GET /api/v3/connectioncheck. It succeeds as soon as the token is accepted.
  • PropertyId in every request is the hotel id ChannelRUSH gave you for that property on your channel.

Success is in the body, not the status

HTTP Meaning Body
200 The request was understood. Check successful. the response, with successful and messages[]
400 The request is malformed or fails validation ValidationProblemDetails with errors per field
401 Token missing or rejected { errorCode, errorMessage }
500 Server error { errorCode, errorMessage }

Business outcomes — no availability, reservation not found — are 200 with successful: false. Each message has messageType (Info, Warning, Error), a code and English message text. A successful response can carry a Warning.

code Meaning
-1 The property is not set up or enabled for your channel
0 Unspecified error
3 Availability or price changed; what you asked for cannot be sold as sent
4 Reservation not found
5 Reservation is already cancelled
6 A reservation with that id already exists

Enumerations (status, creditCardType, add-on type and rateType, …) travel as numbers; messageType is the exception and travels as text. The published document lists the numeric values only, so name them in your client (the example's enum-names.json has every name).

The booking sequence

propertysearch ─┐
                ├─► bookingsearch ─► bookcheck ─► book
settings ───────┘                       ▲           │
                                         └── on every cart change
  1. POST propertysearch — availability across your channel for dates and occupancy; each result has the shape of a bookingsearch response. Without dates it lists properties. Only properties that have content mapped to your channel in the requested language are returned. A property without it can still be searched and booked by id.
  2. GET settings/{propertyId}/{language} — room types, rate plans, add-ons, fees, taxes, booking policies and content. settings.content is null, not an error, when the property has no content in that language; settings.contentLanguages lists the languages it does have.
  3. POST bookingsearch — what one property can sell for the stay: each room type with every rate plan, nightly rates (with ratePrePromo when a promotion applies) and add-ons. Treat a rate plan's totalAfterTax as an estimate for comparing options: the amount the guest pays is the one bookcheck returns, which can be higher (for example when tax also applies to fees).
  4. POST bookcheck — send the reservation you intend to book. It comes back with one rate row per night at the live price, the fee and tax lines, and totalBeforeTax / totalAfterTax filled in. It books nothing. Call it whenever the cart changes and once more just before booking.
    • Naming the rate plan is enough: one rates row with the ratePlanId is replaced by a row per night.
    • A room or rate plan that cannot be sold returns successful: false, code 3, and reservation: null.
  5. POST book — send the reservation exactly as bookcheck returned it, plus guest and card details. Totals you calculate yourself are compared with the server's and a mismatch is refused; the refusal message says which total differed. The response has the reservationId to show the guest and a reservationTransactionId that changes with every new/modified/cancelled transaction.

A reservation needs at least one room, at least one person profile, personProfileIdBookedBy pointing at one of them, currencyCode, and status. Keep the currency the search used for the life of the reservation. Stay dates are dates (yyyy-MM-dd), not moments: send them without a time or offset.

Modify and cancel

  • Modify — there is no modify endpoint. Post the whole reservation to book again with status: 1 (Modified) and the same reservationId. It replaces the reservation; it is not a patch. You do not resend the card: the API keeps the one it holds. The API does not return what was previously charged, so keep the old totalAfterTax if you show "amount due for this change".
  • Cancel — GET cancel/{propertyId}/{reservationId}, or book with status: 2 (Canceled). Cancelling twice is safe: successful: true with warning 5.

Retrieving reservations

POST reservations does two jobs:

  • One reservation — send reservationId (with or without propertyId; without, it is looked up across your channel). An id that does not exist is successful: true with an empty list.
  • A feed — send no reservationId, optionally propertyId and status[]. The window is fixed by the API: departures from 28 days ago onward for the whole channel, or from yesterday onward once a propertyId is sent. There is no paging and no "changed since" filter; timestamp on each reservation is its last change.

ARI

POST ari returns allocation, sell rate, taxes and restrictions (min/max nights, closed to arrival/departure) per room type, rate plan and day, for an inclusive date range with day-of-week switches. Days with nothing loaded come back blank rather than missing. Use it to fill your own availability cache or calendar; use bookingsearch and bookcheck when a guest is buying, because ARI carries no add-ons, fees or totals.

Cards and payment

  • A reservation carries either card fields (creditCardNumber, creditCardExpirationMonth/Year, creditCardSecurityCode, holder name, postal code, creditCardType) or a token you already hold (creditCardTransactionToken).

  • The API does not charge the card. It passes the guarantee to the property.

  • If card numbers pass through your servers you are in PCI DSS scope. Do not store the number or the security code, do not log request bodies, and do not send them back to a browser.

  • Test card: 378282246310005, any future expiration, any 4 digit security code. The reservation is accepted and its note is prefixed with a "TEST RESERVATION, NOT REAL" warning for the property.

  • Whether a card is required, how much is due at booking and what is refundable come from the rate plan's booking policy in settings (creditCardRequired, amountDuePercentage, amountRefundablePercentage, cancellationAllowed, cancellationCutOffHours), and from its newer fields:

    Field Meaning
    depositRules { moreThanNights, moreThanDaysOut, amountDuePercentage }, first match wins: a stay of more than moreThanNights nights booked more than moreThanDaysOut days before arrival pays amountDuePercentage at booking instead of the policy's own. The rest is paid at the property. Empty: amountDuePercentage for every stay.
    cancellationFees The cancellation fee schedule, earliest first: { daysBeforeArrival, atTime, feePercent }. From atTime (property-local, HH:mm) on the day daysBeforeArrival days before arrival (0: the arrival day; null: from booking, i.e. non-refundable), a cancellation costs feePercent of the room price (the room's rates, no add-ons, no taxes or fees added on top). Free before the first fee.
    countsEveryNight The property's dates set to this policy apply to every stay that includes that night (a trade fair reaching the stays that run into it), not only to stays arriving on it; the strictest such policy applies.

    A policy with cancellationFees is described by them. For clients that read only the older fields, those carry a conservative summary: amountRefundablePercentage 100 (free before the cutoff), cancellationAllowed false when the fee applies from booking, and cancellationCutOffHours in whole days before the first fee — never a later free deadline than the real one. Example: free until 18:00 on the arrival day, then 90 %, reads as cancellationFees: [{ daysBeforeArrival: 0, atTime: "18:00", feePercent: 90 }] with cancellationCutOffHours: 0. The policy a stay is actually sold on (the rate plan's, or the property's calendar for those dates) is the one bookingsearch names in bookingPolicyId.

Your responsibilities as the point of sale

  • Guests are yours to tell apart. The token can read and cancel every reservation on your channel. Never act on a reservation id taken from a URL or form alone; require something only the booker knows (the example asks for the last name and postal code) and rate limit the lookup.
  • Show the API's numbers. Display what bookcheck returned rather than recomputing prices.
  • Expect change between search and book. Handle code 3 by telling the guest and re-searching.

Generating a client

The published v3 document needs three corrections before a generator produces a usable client; the example's Generated/patch_swagger.py applies them:

  1. enum member names (published as bare integers, so generators emit _0, _1, …),
  2. decimal amounts (every number is published as double),
  3. BookCheckResponse.reservation is published as required but is null when bookcheck refuses a reservation — an unpatched client throws on exactly that answer.

With those corrections, any OpenAPI generator works. The example's client is generated with NSwag; Swagger Codegen (hosted at generator3.swagger.io) generates clients for most other languages.