rv_create

rv_create

Description

Creates a reservation, and returns the reservation ID and the price of the created reservation.

Access

Writes new data, master access not required, user must have update access to the “Availability calendar” function.

Parameters

Number	Name	O/R	Usage
1	Auth	Required	Authentication structure.*
2	Items	Required	An array of itinerary items to be created as part of the reservation. The array must consist of either a list of further arrays or a list of structures – see the table below for options.
3	Rate type	Optional	“Id” of the rate type to use. If left blank the user’s default rate type is used. Case sensitive.
4	Status	Optional	The requested status for the reservation may be one of several options – see the table below.
5	Name	Optional	The name of the reservation. If left blank this will default to “API: “ followed by a the date and time on which the reservation was created. This field is limited to 50 characters.
6	Voucher reference	Optional	This is the agent’s reference number. This field is limited to 50 characters.
7	Notes (general)	Optional	Any general notes on the reservation including contact details, special requests and originator. This is a free format field and is limited to 65535 characters.
8	Notes (guest)	Optional	Any guest specific notes including guest names and special requests specific to a guest. This is a free format field and is limited to 65535 characters.
9	Agent	Optional	Internal users only. If this optional parameter is included and it references a valid agent id, the agent for the reservation is overridden. Unless otherwise specified, the applicable agent’s commission flag, commission percentage, payment plan and default rate are also pulled in. When left blank this will result in a direct booking for internal users and the linked agent for external users. This parameter may be set to “linked” to specify that the linked agent should be used for internal users.
10	Originator	Optional	Internal users only. If this optional parameter is included and it references a valid contact, the originator for the reservation is overridden.
11	Commission type	Optional	Internal users only. If this optional parameter is set to “0” (gross) or “1” (nett) then the commission flag is overridden.
12	Commission percentage	Optional	Internal users only. If this optional parameter contains a valid commission percentage (a number with up to 2 decimal places) then the commission percentage is overridden.
13	Payment plan	Optional	Internal users only. If this optional parameter is set and links to a valid payment plan, the payment plan for the reservation is overridden.
14	Source	Optional	Internal users only. If this optional parameter is set and links to a valid source, the source for the reservation is overridden (otherwise it is set to “API”).
15	Consultant	Optional	Internal users only. This optional parameter can be used to override the consultant on a booking. This is either a valid internal user ID, or the string “none” to override with NO consultant. If left blank and the API user is in a consultant group, that user will be used. Where the API user is not a consultant the consultant will be left blank and the reservation will go into requests received.
16	Allow overbooking	Optional	If this optional value is not empty then an overbooking will be allowed if the user has access to process it.
17	Contact	Optional	Internal users only. If this optional parameter is set then the contact for the booking will be the overridden by the specified contact.

*See call structure explanation.

2. Itinerary item array structure:

Array key	Structure key	Version	Description
	accommodation_type		“Id” of the accommodation type to book stock for.
1	date_arrive		Date from which the accommodation would be required.
2	date_depart		Date to which the accommodation would be required.
3	rate_groups		Array consisting of the rate groups and quantities thereof. This includes the unit (ie. rooms) quantity. (see table below)
4	override		Override value. This optional value is dependent on the level and type of override allowed per rate. If left empty, or false, no override takes place.
5	rate_type		This optional value allows the rate type of the itinerary to be overridden. If left empty, or false, the reservation rate type is used.
6	use_allocations	5.20.0+	If this optional value is not empty available allocations are used for the itinerary. If left empty, or false, allocations are not used.
7	guests		The “guests” field consists of an array for each group to be allocated to the itinerary. Guests should be comma delimited guest ids separated with a colon for each group.

2. Rate Group array structure:

Array key	Structure key	Description
0	rate_group_id	“Id” of the rate group
1	qty	Quantity for the rate group

4. Status options:

Code	Name	Description
0	Quotation	Used to generate a quotation only. No follow up will be made on this reservation and no stock will be held.
10	Wait listed	Used to be put on a waiting list for stock. A follow up will be made if the stock becomes available. No stock is held initially.
20	Provisional	Used to hold stock provisionally. This provisional hold on the stock will expire after a predetermined amount of time. This amount of time may differ per principal and needs to be confirmed for each implementation if necessary. This is the default
30	Confirmed	Used to hold stock on and confirm the booking.
90	Cancelled	Used to cancel the reservation.

Example

Create a reservation.

Note
Under rate groups, the Unit rate group must always be specified, in addition to the adults, children, etc.

Request

{
    "method": "rv_create",
    "params": [
        {
            "bridge_username":"username",
            "bridge_password":"password",
            "link_id":"4"
        },
        [
            [
                "WB7",
                "2018-04-1",
                "2018-04-3",
                [
                    [
                        "RS1",
                        "1"
                    ],
                    [
                        "RS2",
                        "2"
                    ],
                    [
                        "RS3",
                        "0"
                    ]
                ]
            ]
        ],
        "",
        "20",
        "Example reservation name",
        "",
        "General reservation note",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        ""
        
    ],
    "id": 1
}

Response

{
  "id": 1,
  "error": null,
  "result": "WB854"
}

rv_create

Description

Access

Parameters

Example

Note

Keep up to date with us

Menu

Visit our website

ResRequest Modules