Update availability for a specific session.
Example:

{
    "seatsAvailable": "0"
}
OR
{
    "seats": "30"
}
OR
{
    "priceOptions": [
       {
         "price": 90,
         "label": "Adult"
       }
     ]
}
If you send "seatsAvailable", the session will be updated for the current availability to become this number. The total seats capacity will be updated according to the delta between the current and new seats availability.
If you send "seats", the total seats capacity of the session will be updated, regardless of how many are already booked. The seats available will also change according to the delta between the current and new seats.
If you send both, only seatsAvailable will be used.

Returns the updated Session details

Updating a session with session id is deprecated, use '7. Update product session', with product code and session start time local to identify a session, instead.

Request

PUT https://api.rezdy.com/v1/availability/{sessionId}

Path parameters

Parameter name Value Description Additional
sessionId int64

sessionId Rezdy internal ID for that session

Required

Request body

The request body takes a complete SessionUpdateRequest resource, containing the following writable properties:

{
    "allDay": "boolean",
    "priceOptions": [
        {
            "id": "int64",
            "label": "string",
            "maxQuantity": "int32",
            "minQuantity": "int32",
            "price": "float",
            "priceGroupType": "string",
            "productCode": "string",
            "seatsUsed": "int32"
        }
    ],
    "seats": "int32",
    "seatsAvailable": "int32"
}

Properties

Name Type Description Additional
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
priceOptions[] array

List of price options, which will override the product level price. Price options have to be a subset of the product price options, thus you can not create new price options, use product update service to do so.

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

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

Optional
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
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
priceOptions[].price float

Price amount (I.e. "200.00")

Optional
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
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
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
seats int32

Update the total number of seats for this session. The total seats does not change after a booking is made. The total number of seats can not be less than 0.

Optional
seatsAvailable int32

Update the current availability for this session. The session total number of seats after updating the seats available can not be less than 0.

Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

ResponseSession

Explore this API

apiKey Enter your API Key to try this call
sessionId

sessionId Rezdy internal ID for that session

body

Session data must only include one of seats, seatsAvailable or priceOptions

Request Content-Type
Response Content-Type
Try it out!