Data Types

JSON

type description
Address Address of a company, customer or product location.
AgentPaymentType Define the Payment rules for Agent bookings, for a specific relationship between a supplier and an agent
Booking Booking object. Lists all the possible fields for all product types and scenarios. Most of them are not required when sending a new booking. A single Booking can be used to book multiple products, each of them being a BookingItem. All the products of one booking have to be from the same supplier.
BookingField An information about a booking or a participant, based on context - either under a booking or a participant object (I.e. "First Name", "Dietary requirements", "Hotel Pickup")
BookingItem A BookingItem is a unique product/startTime combination in a booking
BookingMode Defines the booking mode of a product. Impacts required date/time fields when making a booking
BookingPayment Record of an already processed payment.
BookingPaymentRecipient Recipient of a booking payment.
Category A Category is used to group products
Checkin Check-in information.
Company Company object. Holds general details and information about a specific company.
ConfirmMode Defines how orders are confirmed
CreditCard Credit card details.

Used to send payment details for a booking

CreditCardType Types of credit card
Currency Currency codes
Customer 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
DataObject Root element for the main objects that can be returned by the API
Error Details about an error from the request processing.
Extra Optional service or item that can be purchased when booking a specific product
ExtraPriceType Extra Price Type
Gender Gender.
Image Image links.
OrderSource Defines the source of the order viewed from the Rezdy software
OrderStatus Order Status. Determines if the order blocks availability
Participant Details about a single participant for a single BookingItem. The participant is a person attending a tour. It differs from the Customer, who is the person making the booking and most of the time paying for it.
PaymentOption The payment option determines how a booking should be charged. When you do not want Rezdy to process any payment (I.e. payment was taken on a different system), this should be left empty and a BookingPayment should be recorded instead.
PaymentType List the payment types
PickupLocation PickupLocation object. Holds information about the a pickup location from the pickup list configured for the product.
PriceGroupType Group price type
PriceOption A Price Option belongs to a product. It holds the price details for a specific price type. Products can have one or many price options (I.e. Adult, Child, Family, etc.)
Product Product object. Holds general details and settings of a specific tour, activity or event.
ProductType Product type.
Quantity Quantity of a single price option attached to a BookingItem.
  • If the product only has 1 price option, only "Quantity.value" is required.
  • If the product has multiple price options, "Quantity.optionLabel" is also required.
  • It is recommended to use "Quantity.optionLabel" and optionally "Quantity.optionPrice" instead of "Quantity.optionId" because the latter can vary depending on the session booked.
I.e. enter optionLabel = "Adult", optionPrice = 100 and value = "2" to book for 2 x Adults ticket for 100
RequestStatus Status of the request processing, it is always returned in a response object. Contains the status of the request and potential error and warning messages.
Resource Supplier resource - e.g. raft, bus, tour guide, venue which has a limited capacity. The resources can be shared between different supplier's products. If the resource does not have any spare availability, the booking of any of the product sessions, where the resource is used will not be possible.
ResourceType List of the resource types
Response Base Response class for all API calls. Contains all the possible response types for all API calls. Only one type will be returned per request, matching the request endpoint.
Session A Session holds availability for a unique product / start time combination and also the rates for the session booking.
Title Title
User Internal Rezdy user details. This is a Rezdy application user who belongs to a Rezdy agent or supplier company.
Voucher A Voucher is a gift card that can be used to pay for a booking. It can also be generated by a booking when a customer buys a Gift Card. This is not a "confirmation voucher", you should use Booking.orderNumber as a confirmation code to show to customers.
VoucherStatus Status of a voucher.
VoucherValueType Voucher value types.
Warning Request Warning

XML

Namespace https://api.rezdy.com/v1 (schema)
type description
address Address of a company, customer or product location.
booking Booking object. Lists all the possible fields for all product types and scenarios. Most of them are not required when sending a new booking. A single Booking can be used to book multiple products, each of them being a BookingItem. All the products of one booking have to be from the same supplier.
bookingField An information about a booking or a participant, based on context - either under a booking or a participant object (I.e. "First Name", "Dietary requirements", "Hotel Pickup")
bookingItem A BookingItem is a unique product/startTime combination in a booking
bookingPayment Record of an already processed payment.
bookingPaymentRecipient Recipient of a booking payment.
category A Category is used to group products
checkin Check-in information.
company Company object. Holds general details and information about a specific company.
creditCard Credit card details.

Used to send payment details for a booking

customer 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
dataObject Root element for the main objects that can be returned by the API
error Details about an error from the request processing.
extra Optional service or item that can be purchased when booking a specific product
image Image links.
participant Details about a single participant for a single BookingItem. The participant is a person attending a tour. It differs from the Customer, who is the person making the booking and most of the time paying for it.
pickupLocation PickupLocation object. Holds information about the a pickup location from the pickup list configured for the product.
priceOption A Price Option belongs to a product. It holds the price details for a specific price type. Products can have one or many price options (I.e. Adult, Child, Family, etc.)
product Product object. Holds general details and settings of a specific tour, activity or event.
quantity Quantity of a single price option attached to a BookingItem.
  • If the product only has 1 price option, only "Quantity.value" is required.
  • If the product has multiple price options, "Quantity.optionLabel" is also required.
  • It is recommended to use "Quantity.optionLabel" and optionally "Quantity.optionPrice" instead of "Quantity.optionId" because the latter can vary depending on the session booked.
I.e. enter optionLabel = "Adult", optionPrice = 100 and value = "2" to book for 2 x Adults ticket for 100
request Base Request class for all API calls
requestStatus Status of the request processing, it is always returned in a response object. Contains the status of the request and potential error and warning messages.
resource Supplier resource - e.g. raft, bus, tour guide, venue which has a limited capacity. The resources can be shared between different supplier's products. If the resource does not have any spare availability, the booking of any of the product sessions, where the resource is used will not be possible.
response Base Response class for all API calls. Contains all the possible response types for all API calls. Only one type will be returned per request, matching the request endpoint.
session A Session holds availability for a unique product / start time combination and also the rates for the session booking.
user Internal Rezdy user details. This is a Rezdy application user who belongs to a Rezdy agent or supplier company.
voucher A Voucher is a gift card that can be used to pay for a booking. It can also be generated by a booking when a customer buys a Gift Card. This is not a "confirmation voucher", you should use Booking.orderNumber as a confirmation code to show to customers.
warning Request Warning
agentPaymentType Define the Payment rules for Agent bookings, for a specific relationship between a supplier and an agent
bookingMode Defines the booking mode of a product. Impacts required date/time fields when making a booking
confirmMode Defines how orders are confirmed
creditCardType Types of credit card
currency Currency codes
extraPriceType Extra Price Type
gender Gender.
orderSource Defines the source of the order viewed from the Rezdy software
orderStatus Order Status. Determines if the order blocks availability
paymentOption The payment option determines how a booking should be charged. When you do not want Rezdy to process any payment (I.e. payment was taken on a different system), this should be left empty and a BookingPayment should be recorded instead.
paymentType List the payment types
priceGroupType Group price type
productType Product type.
resourceType List of the resource types
title Title
voucherStatus Status of a voucher.
voucherValueType Voucher value types.