RON API Developers Test Data

Owned by Former user (Deleted)
Last updated: 26 Sept, 2024 by support_howto

Introduction

The RON API (ResPax Online Network Application Programming Interface) facilitates seamless integration between OTAs and Operators, allowing clients to interact with various services programmatically. This document provides an overview of the key RON API tests required before going live and the most popular endpoints used in our system.

Follow below the most popular methods in our system:

Method - Read Tours

  • Description: Retrieve all details of a product, including Tour Code, Basis ID, SubBasis ID, and Tour Time ID, which are required in the reservation endpoint. The product description is also included.
  • Endpoint: read-tours

Method - Read Extras

  • Description: Retrieve details specific to Extras/Add-Ons, including descriptions and the Extra ID required in the reservation endpoint.
  • Endpoint: read-extras

Method - Read Payment Options

  • Description: Typically used by OTAs to retrieve Payment Option details required in the reservation endpoint. This endpoint shows the options added by the Operator. We usually provide this information at the mapping time.
  • Endpoint: read-payment-options

Method - Read Availability Range

  • Description: Check availability for specific products over a period to display on your website.
  • Endpoint: read-availability-range
  • Note: There is no method to read availability for Pickup. If required, use the method "Check Reservation".

Method - Read Tour Price Range

  • Description: Retrieve the product price for a date range for specific Pax Types, including non-per-pax prices and commissions.
  • Endpoint: read-price-range
  • Note: Some prices, such as special prices for Family Packages (Smart Rule) and Transfers, cannot be read by this request. Use the method "Check Reservation" for these cases.

Method - Read Transfers

  • Description: Retrieve all fields required in the reservation endpoint and further details for pickup and drop-off.
  • Endpoint: read-transfers

Method - Check Reservation

  • Description: It is recommended to use this endpoint to verify all prices applied to a booking, as outlined in the examples provided above. This ensures accuracy before displaying prices on your website and proceeding with the reservation endpoint. 
  • Endpoint: check-reservation

Method - Write Reservation

Method - Cancel Reservation

  • Description: Cancel bookings that were created incorrectly or are no longer required.
  • Endpoint: write-cancelation
  • Some rules applied for this endpoint:
    • Cancellation is not allowed within the web expiry time.
    • Cancellation is not allowed after the tour date.
    • Cancellation is not allowed if payment has already been collected (via Credit Card, PayPal, etc).
    • If the Operator has edited the booking, the agent can only cancel parts that were not edited. For example, if the Operator added a new tour, only the unedited parts of the booking will be canceled.

______________________________________________________________________________________________________________

Key RON API Tests

To ensure proper functionality and integration, clients are required to perform a series of tests. These tests validate the core features and interactions with the RON API, ensuring that the endpoints work correctly and return the expected data. Here are the main tests that clients should conduct:

The data is configured against the sales-trinity software organisation (Host ID = SALES and Domain = https://ron2-sandbox.respax.com/).


1. Tour with Levy (Tour Code: CNRCITY)


Purpose: Create a booking that includes a Levy price for both Adult and Child.

Required Data: 


1x Adult

1x Child

No Pickup included

Price: Adult $60 + $5 (Levy)

          Child $50 + $5 (Levy)

Provide to ResPax for this test: read-price-range request & booking number

_______________________________________

2. Tour with Family Discount - Smart Rule (Tour Code: CNRCNH)

Purpose: Create a booking with a Family Discount and verify accurate pricing before booking.

TIP: Use the check-reservation endpoint to check Family Discount. 

Required Data: 

2x Adults

2x Children

No Pickup included

Price: Adult $240

          Child $200

          Discount: $100 

Provide to ResPax for this test: check-reservation request & booking number

________________________________________

3. Tour with Mandatory Pickup (Tour Code: MB)

Purpose: Create a booking with pickup included. 

TIP: You can verify if the tour requires pickup in the read-tours endpoint ("is_mpup": true)

Required Data: 

1 x Adult

Include Pickup

Price: Adult $90

Provide to ResPax for this test: booking number

________________________________________

4. Tour with Pickup and Drop off - Price included (Tour Code: REEF)

Purpose: Create a booking that includes both pickup and drop off. 

TIP: Use the check-reservation endpoint to check Transfer Price

Required Data: 

1 x Adult 

Include Pickup

Include Dropoff

Price: Adult $150 + Pickup $10 + Dropoff $10 (Departing Mission Beach)

          Adult $150 + Pickup $5 + Dropoff $5 (Departing Cairns)

Provide to ResPax for this test: check-reservation request & booking number for both locations

________________________________________

5. Tour with restrict Availability (Tour Code: CT)

Purpose: Create a booking with restricted availability. 

TIP: Use the read-availability-range endpoint to check availability for multiple days

Required Data: 

1 x Adult 

No Pickup included

Price: Adult $130

Provide to ResPax for this test: availability request & booking number

________________________________________

6. Tour with an Extra Tour (Tour Code: PD and Extra Tour: RESTAURANT)

Purpose: Create a booking that includes an extra/add-on tour.

TIP: Use the read-extras endpoint to check details about Extras and ID required, and check-reservation for price and availability applied for Extras.

Required Data: 

2 x Adults 

No Pickup included

Add Extra Tour

Price: Adult $220 + Extra $100

Provide to ResPax for this test: check-reservation request & booking number

_______________________________________

7. Tour with Family Discount - Pax Discount (Tour Code: GRAND)

Purpose: Create a booking with a different pax type to apply a Family Package discount. This test is required when the OTA does not work with Smart Rule (Test 2).

Required Data: 

2x Adults

1x Child

1x Family Child (Pax ID = 5)

No Pickup included

Price: Adults $220

          Child $100

          Family Child $50

Provide to ResPax for this test: read-price-range request and response, & booking number