OnSeasonChannel API

Go-live checklist

What to prove on staging before OnSeason issues production credentials.

You build and certify on staging, then OnSeason issues a separate production base URL and API key. Staging and production share nothing: listing IDs, keys, prices, and availability on staging don't exist in production.

Prove the integration on staging

Work through each item on staging and keep the request and response for any item OnSeason asks to see.

Access and content

  • Authenticate, and confirm that an invalid key returns 401.
  • Import paginated property content and map images, amenities, house rules, and unit models.
  • Refresh changed listings from updatedAt.

Search and availability

  • Search by location, dates, party size, and amenities, and by listing IDs.
  • Handle an empty, successful search result.
  • Read day-level availability and minimum-night limits.
  • Show multi-room results correctly when roomsForParty is above 1, or filter them out.

Quote and book

  • Create a quote and store its expiry.
  • Refuse or refresh an expired quoteToken.
  • Show payAtProperty charges and the price breakdown before booking.
  • Create an instant reservation with the token.
  • Store the OnSeason id and the providerReservationID.
  • Handle dates that became unavailable between quote and reservation.
  • Book at least one MULTI_UNIT or COMPLEX property, if they are in your production scope.
  • Check currency conversion and every price component you map.

Cancellation

  • Show the cancellation terms on search results, at checkout, and in the confirmation.
  • Show the right terms for a non-refundable stay and for a stay past its free-cancellation deadline.
  • Get a reservation and cancel a confirmed one.
  • Handle both CANCELLED and CANCELLATION_PENDING after a cancel.
  • Read cancellationCharge and show the refund to the guest.

Errors and load

  • Handle 400, 401, 403, 404, 422, and 5xx responses.
  • Don't retry reservations automatically after a timeout.
  • Run load and retry tests at the volumes you expect.

Agree the commercial and support terms

Agree these with OnSeason before launch:

  • Who is the merchant of record, who charges the guest, and how commission, refunds, invoicing, and settlement work.
  • Your channel's default cancellation policy, if you want a fallback other than non-refundable.
  • How you reconcile ambiguous bookings, and your support contacts on both sides.
  • Expected traffic and retry behavior.

Switch to production

OnSeason sends the production base URL and API key once certification passes. Re-import your catalogue from production. Don't reuse staging listing IDs.

On this page