Skip to content
Wink

Cancellable check

GET
/api/managing-entity/{managingEntityIdentifier}/extranet/booking/{bookingIdentifier}/cancellable
 
curl --request GET \
  --url https://api.wink.travel/api/managing-entity/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/extranet/booking/f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92/cancellable \
  --header 'Authorization: Bearer <token>' \
  --header 'Wink-Version: 2.0'

Reports whether the booking (or its group) can still be cancelled by the property, taking cancellation policy and timing into account.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Check if booking can be cancelled for property with this identifier

Example 
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18
bookingIdentifier
required
string
""

Check if booking can be cancelled with this identifier

Example 
f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Cancellability status of the booking

Media type application/json

Indicates whether a specific booking is eligible for cancellation, along with the reason if it is not.

object
hotelIdentifier
required

Property identifier owning the booking.

string format: uuid
""
bookingIdentifier
required

Booking unique identifier.

string format: uuid
""
cancellable
required

Whether booking can be cancelled.

boolean
key
additional properties
""
Example 
{
  "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18",
  "bookingIdentifier": "f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92",
  "cancellable": true
}

400

Section titled “400 ”

Bad Request — missing or invalid request parameter or body

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

401

Section titled “401 ”

Unauthorized — authentication is required or the session has expired

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

403

Section titled “403 ”

Forbidden — authenticated but lacking the required permission or scope

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

404

Section titled “404 ”

Not Found — the requested resource does not exist

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

405

Section titled “405 ”

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

415

Section titled “415 ”

Unsupported Media Type — use application/json

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

500

Section titled “500 ”

Internal Server Error — an unexpected failure occurred on the server

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

503

Section titled “503 ”

Service Unavailable — a downstream dependency is unreachable

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example