Methods

  • post - Create availability batch
  • get - Search availability
  • get - Get session resources
  • get - Get resource sessions

Resource

{
    "requestStatus": {
        "error": {
            "errorCode": "string",
            "errorMessage": "string"
        },
        "success": "boolean",
        "version": "string",
        "warning": {
            "warningMessage": "string"
        }
    },
    "sessions": [
        {
            "allDay": "boolean",
            "endTime": "date-time",
            "endTimeLocal": "string",
            "id": "int64",
            "priceOptions": [
                {
                    "id": "int64",
                    "label": "string",
                    "maxQuantity": "int32",
                    "minQuantity": "int32",
                    "price": "float",
                    "priceGroupType": "string",
                    "productCode": "string",
                    "seatsUsed": "int32"
                }
            ],
            "productCode": "string",
            "seats": "int32",
            "seatsAvailable": "int32",
            "startTime": "date-time",
            "startTimeLocal": "string"
        }
    ]
}

Properties

Name Type Description Additional
requestStatus object RequestStatus Required
requestStatus.error object Error Optional
requestStatus.error.errorCode string Required
requestStatus.error.errorMessage string Optional
requestStatus.success boolean Required
requestStatus.version string Optional
requestStatus.warning object Warning Optional
requestStatus.warning.warningMessage string Optional
sessions[] array Optional
sessions[].allDay boolean

If true, this session lasts all day and no time should be shown to customers. Technically the session will be from midnight to midnight.

Optional
sessions[].endTime date-time

End time of this session. Used to show the customer how long that tour will last

Optional
sessions[].endTimeLocal string

End time of this session in supplier's local timezone. Used to show the customer how long that tour will last

Optional
sessions[].id int64

Rezdy internal ID for this session

Optional
sessions[].priceOptions[] array

List of price options attached to this session. Most of the time they'll match the product's price options, but they can be used to change the price of specific dates/times (I.e. high/low season, weekday/weekend, etc.)

Optional
sessions[].priceOptions[].id int64 Optional
sessions[].priceOptions[].label string

Label for this price (I.e. "Adult", "Child")

Optional
sessions[].priceOptions[].maxQuantity int32

Max booking quantity for the product price option. Can be specified, if the price option is fixed or a grouptype. For a successful booking of the product, the number of participants for this price option have to be lesser or equal than this value.

Optional
sessions[].priceOptions[].minQuantity int32

Min booking quantity for the product price option. Can be specified, if the price option is fixed or a group type. For a successful booking of the product, the number of participants for this price option have to be greater or equal than this value.

Optional
sessions[].priceOptions[].price float

Price amount (I.e. "200.00")

Optional
sessions[].priceOptions[].priceGroupType string

If this price is for a group, is the price for the whole group (TOTAL) or per quantity (EACH)

Possible values are:

  • EACH
  • TOTAL
Optional
sessions[].priceOptions[].productCode string

Product code to which the price options belongs to. Since Rezdy introduced shared availability option for products, the product sessions can contain price overrides for all of the products, which share the sessions. Therefore it is necessary to filer only the price options matching the chosen product code on the client side, when processing /availability service responses.

Optional
sessions[].priceOptions[].seatsUsed int32

How many seats one quantity of this price willuse. Used for availability calculations. For example 1 quantity of "Family of 4" will use 4 seats.

Optional
sessions[].productCode string

Rezdy unique productCode linked to this session

Optional
sessions[].seats int32

Total number of seats for this session. Does not change after a booking is made

Optional
sessions[].seatsAvailable int32

Current availability for this session.

Optional
sessions[].startTime date-time

Start Time of this session. This time should be used when showing customers the booking date/time. It should be sent in BookingItem.startTime when making new bookings

Optional
sessions[].startTimeLocal string

Start Time of this session in supplier's local timezone. This time should be used when showing customers the booking date/time. It should be sent in BookingItem.startTimeLocal when making new bookings

Optional