Methods

  • put - Update booking

Resource

{
    "createdBy": {
        "code": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string"
    },
    "customer": {
        "aboutUs": "string",
        "addressLine": "string",
        "addressLine2": "string",
        "city": "string",
        "companyName": "string",
        "countryCode": "string",
        "dob": "date-time",
        "email": "string",
        "fax": "string",
        "firstName": "string",
        "gender": "string",
        "id": "int64",
        "lastName": "string",
        "marketing": "boolean",
        "middleName": "string",
        "mobile": "string",
        "name": "string",
        "newsletter": "boolean",
        "phone": "string",
        "postCode": "string",
        "preferredLanguage": "string",
        "skype": "string",
        "state": "string",
        "title": "string"
    },
    "fields": [
        {
            "fieldType": "string",
            "label": "string",
            "listOptions": "string",
            "requiredPerBooking": "boolean",
            "requiredPerParticipant": "boolean",
            "value": "string",
            "visiblePerBooking": "boolean",
            "visiblePerParticipant": "boolean"
        }
    ],
    "internalNotes": "string",
    "items": [
        {
            "amount": "float",
            "endTime": "date-time",
            "endTimeLocal": "string",
            "extras": [
                {
                    "id": "int64"
                }
            ],
            "participants": [
                {
                    "fields": [
                        {
                            "fieldType": "string",
                            "label": "string",
                            "listOptions": "string",
                            "requiredPerBooking": "boolean",
                            "requiredPerParticipant": "boolean",
                            "value": "string",
                            "visiblePerBooking": "boolean",
                            "visiblePerParticipant": "boolean"
                        }
                    ]
                }
            ],
            "pickupLocation": {
                "additionalInstructions": "string",
                "address": "string",
                "latitude": "double",
                "locationName": "string",
                "longitude": "double",
                "minutesPrior": "int32",
                "pickupInstructions": "string",
                "pickupTime": "string"
            },
            "productCode": "string",
            "quantities": [
                {
                    "optionId": "int64",
                    "optionLabel": "string",
                    "optionPrice": "float",
                    "value": "int32"
                }
            ],
            "startTime": "date-time",
            "startTimeLocal": "string",
            "subtotal": "float",
            "vouchers": [
                {
                    "code": "string",
                    "expiryDate": "date-time",
                    "internalNotes": "string",
                    "internalReference": "string",
                    "issueDate": "date-time",
                    "sourceOrder": "string",
                    "status": "string",
                    "value": "float",
                    "valueType": "string"
                }
            ]
        }
    ],
    "orderNumber": "string",
    "resellerComments": "string",
    "resellerId": "int64",
    "resellerReference": "string",
    "resellerUser": {
        "code": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string"
    },
    "status": "string"
}

Properties

Name Type Description Additional
createdBy object

Internal Rezdy user details. This is a Rezdy application user who belongs to a Rezdy agent or supplier company.

Optional
createdBy.code string

Unique Rezdy user code

Optional
createdBy.email string

Email

Optional
createdBy.firstName string

First name

Optional
createdBy.lastName string

Last name

Optional
customer object

The customer is the person making the booking, and most of the time paying for it.
It differs from Participants, who are the people attending a tour

Optional
customer.aboutUs string

How did you hear about us?

Optional
customer.addressLine string

Address

Optional
customer.addressLine2 string

Extended Address

Optional
customer.city string

City/Town/Suburb

Optional
customer.companyName string

Company name

Optional
customer.countryCode string

2 letter ISO country code

Optional
customer.dob date-time

Date of birth

Optional
customer.email string

Email

Optional
customer.fax string

Fax number

Optional
customer.firstName string

First name

Optional
customer.gender string

Gender: MALE or FEMALE

Possible values are:

  • MALE
  • FEMALE
Optional
customer.id int64

Rezdy internal ID of the customer

Optional
customer.lastName string

Last Name

Optional
customer.marketing boolean

Agree to receive marketing emails

Optional
customer.middleName string

Middle name

Optional
customer.mobile string

Mobile phone number

Optional
customer.name string

Full name - generated from first/middle/last names

Optional
customer.newsletter boolean

Subscribe to the newsletter

Optional
customer.phone string

Preferred Phone number

Optional
customer.postCode string

Postcode / ZIP

Optional
customer.preferredLanguage string

Preferred language. Should be a 2 letter ISO country code

Optional
customer.skype string

Skype alias

Optional
customer.state string

State/County/Region

Optional
customer.title string

Title

Possible values are:

  • MR
  • MS
  • MRS
  • MISS
Optional
fields[] array

List of custom fields that are required "once per booking" by all the products in this booking

Optional
fields[].fieldType string

Booking field type which determines its format. See Booking Fields Format

Possible values are:

  • String
  • List
  • Boolean
  • Phone
  • Date
  • Hidden
Optional
fields[].label string

Field label that can be shown to customers

Optional
fields[].listOptions string

If this field only allows limited values to be selected from a list, they'll be included in this string, separated by \r\n

Optional
fields[].requiredPerBooking boolean

true if this field must be populated once per booking, regardless of the number of items or participants. It should be in Booking.fields

Currently, required fields are not validated when a booking is created though public API, however, it's a good practice to support them in your client code However, soon the required fields will be enforced for public API booking..

Optional
fields[].requiredPerParticipant boolean

true if this field must be populated for each participant. It should be in Booking.BookingItem.Participant.fields.

Currently, required fields are not validated when a booking is created through public API, however, it's a good practice to support them in your client code. However, soon the required fields will be enforced for public API booking.

Optional
fields[].value string

Value entered by the customer for this field

Optional
fields[].visiblePerBooking boolean

true if this field should be asked once per booking, regardless of the number of items or participants. It should be in Booking.fields

Optional
fields[].visiblePerParticipant boolean

true if this field should be asked for each participant when doing a booking. It should be in Booking.BookingItem.Participant.fields.

Optional
internalNotes string

Comments only visible internally by the supplier

Optional
items[] array

List of items in this booking. A booking can contain multiple products. Each BookingItem is a separate product with its own set of quantities and participant details.

Optional
items[].amount float

Amount charged for this BookingItem. This is automatically generated based on quantities, but you can override the amount by entering a value. If automated payment method is used for the booked product, the Amount of the booked item
has to be grater than Net Rate sum of the booked quantities and Rezdy processing fee.

Optional
items[].endTime date-time

End time of the session for this BookingItem

Optional
items[].endTimeLocal string

End time of the session for this BookingItem in supplier's local timezone.

Optional
items[].extras[] array

List of Extras booked with this product

Optional
items[].extras[].id int64

Extra ID

Optional
items[].participants[] array

List of participants. Each participant object contains all the booking fields for a single participant.

Optional
items[].participants[].fields[] array

List of BookingField for this participant

Optional
items[].participants[].fields[].fieldType string

Booking field type which determines its format. See Booking Fields Format

Possible values are:

  • String
  • List
  • Boolean
  • Phone
  • Date
  • Hidden
Optional
items[].participants[].fields[].label string

Field label that can be shown to customers

Optional
items[].participants[].fields[].listOptions string

If this field only allows limited values to be selected from a list, they'll be included in this string, separated by \r\n

Optional
items[].participants[].fields[].requiredPerBooking boolean

true if this field must be populated once per booking, regardless of the number of items or participants. It should be in Booking.fields

Currently, required fields are not validated when a booking is created though public API, however, it's a good practice to support them in your client code However, soon the required fields will be enforced for public API booking..

Optional
items[].participants[].fields[].requiredPerParticipant boolean

true if this field must be populated for each participant. It should be in Booking.BookingItem.Participant.fields.

Currently, required fields are not validated when a booking is created through public API, however, it's a good practice to support them in your client code. However, soon the required fields will be enforced for public API booking.

Optional
items[].participants[].fields[].value string

Value entered by the customer for this field

Optional
items[].participants[].fields[].visiblePerBooking boolean

true if this field should be asked once per booking, regardless of the number of items or participants. It should be in Booking.fields

Optional
items[].participants[].fields[].visiblePerParticipant boolean

true if this field should be asked for each participant when doing a booking. It should be in Booking.BookingItem.Participant.fields.

Optional
items[].pickupLocation object

PickupLocation object. Holds information about the a pickup location from the pickup list configured for the product.

Optional
items[].pickupLocation.additionalInstructions string

Additional instructions for the pickup location.

Optional
items[].pickupLocation.address string

Address of the pickup location
In a booking item object, it represents a chosen pickup address for the booked item.

Optional
items[].pickupLocation.latitude double

google maps calculated latitude of the pickup address

Optional
items[].pickupLocation.locationName string

Pickup location name - free text name for the location.

In a booking item object, it represents customer's pickup location name (if configured on product). It can be one name from pickup locations list of the booked product, or free text in case of the other pickup location option.

The value will be ignored, if the product does not allow pickups or if the location name does not match one of the product's pickup locations and 'other' pickup option is not enabled for the product pickup.

Optional
items[].pickupLocation.longitude double

google maps calculated latitude of the pickup address

Optional
items[].pickupLocation.minutesPrior int32

Pickup time in minutes, prior to the tour start time.

Optional
items[].pickupLocation.pickupInstructions string

Present only in booking service response

Chosen pickup instructions (general and location specific). Shown when the pickup was chosen for the booked item.

Optional
items[].pickupLocation.pickupTime string

Present only in booking service response

In a booking item object, it represents a calculated pickup time, in supplier's local timezone. Shown when the pickup was chosen for the booked item and pickup location contains duration.

Optional
items[].productCode string

Unique Rezdy code of the product in this BookingItem

Optional
items[].quantities[] array

List of quantities booked by this item. Each Quantity must be linked to a Product price option via its label or ID.If the product only has one price option, only 'Quantity.value' is required.

Optional
items[].quantities[].optionId int64

Price option ID

Optional
items[].quantities[].optionLabel string

Price option label

Optional
items[].quantities[].optionPrice float

Price option price for a single quantity

Optional
items[].quantities[].value int32

Quantity actually booked

Optional
items[].startTime date-time

Start time of the session for this BookingItem

Optional
items[].startTimeLocal string

Start time of the session for this BookingItem in supplier's local timezone.

Optional
items[].subtotal float

Subtotal is the BookingItem.amount plus extras costs plus taxes and fees

Optional
items[].vouchers[] array

List of vouchers created by this booking item - when the product is bought as a gift or is a gift card

Optional
items[].vouchers[].code string

Unique voucher code

Optional
items[].vouchers[].expiryDate date-time

Date this voucher will expire

Optional
items[].vouchers[].internalNotes string

Internal notes only visible by the supplier of this voucher

Optional
items[].vouchers[].internalReference string

Agent code attached to this vouche

Optional
items[].vouchers[].issueDate date-time

Date this voucher was created

Optional
items[].vouchers[].sourceOrder string

If the voucher was generated from an order - by purchasing a gift card or product as a gift card, it will contain the orderNumber which created the voucher. Null for vouchers manually created by user.

Optional
items[].vouchers[].status string

Current voucher status

Possible values are:

  • ISSUED
  • REDEEMED
  • PARTIALLY_REDEEMED
  • EXPIRED
Optional
items[].vouchers[].value float

The value of the voucher. There are different representations of the value - nominal, percentage or empty - in case of the payment for the whole product, see valueType

Optional
items[].vouchers[].valueType string
VALUE_LIMITPRODUCT
Voucher nominal value discount, limited to a certain product
VALUE
Voucher nominal value discount for any product
VALUE_LIMITCATALOG
Voucher nominal value discount, limited to a certain product category
PERCENT_LIMITPRODUCT
Voucher percentage value discount, limited to a certain product
PERCENT
Voucher percentage value discount for any product
PERCENT_LIMITCATALOG
Voucher percentage value discount, limited to a certain product category
PRODUCT
Voucher can be used as a payment method for a specific product

Possible values are:

  • VALUE_LIMITPRODUCT
  • VALUE
  • VALUE_LIMITCATALOG
  • PERCENT_LIMITPRODUCT
  • PERCENT
  • PERCENT_LIMITCATALOG
  • PRODUCT
Optional
orderNumber string

Order number. This is the number you should give to customers and print on booking confirmations. Order number is generated by the system, therefore, even if it is specified in the booking request, it will be overwritten.

Optional
resellerComments string

Comments only visible by the agent and the supplier. This should be used by the agent to send voucher numbers/redemption codes to suppliers.

Optional
resellerId int64

Rezdy internal ID of the agent company attached to this booking

Optional
resellerReference string

External reseller reference, can be used to pass internal booking number. This reference will be shown to a supplier, also it will appear on reports and can be used to filter orders. Maxiumum number of characters is 30

Optional
resellerUser object

Internal Rezdy user details. This is a Rezdy application user who belongs to a Rezdy agent or supplier company.

Optional
resellerUser.code string

Unique Rezdy user code

Optional
resellerUser.email string

Email

Optional
resellerUser.firstName string

First name

Optional
resellerUser.lastName string

Last name

Optional
status string

Status of this booking

Possible values are:

  • PROCESSING
  • NEW
  • ON_HOLD
  • PENDING_SUPPLIER
  • PENDING_CUSTOMER
  • CONFIRMED
  • CANCELLED
  • ABANDONED_CART
Optional