Skip to content
Wink

Show Bookings

GET
/api/channel-manager/property/{propertyIdentifier}/booking/list
 
curl --request GET \
  --url 'https://integrations.wink.travel/api/channel-manager/property/property-1/booking/list?startDate=2018-01-01T03%3A07%3A58.742%2B0000&endDate=2018-01-02T03%3A07%3A58.742%2B0000' \
  --header 'Wink-Version: 2.0'

Retrieves a list of all bookings created for the specified property within the specified date range.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
propertyIdentifier
required
string
default: ##default

Retrieve record owned by this propertyIdentifier

Example 
property-1

Query Parameters

Section titled “Query Parameters ”
startDate
required
string
default: ##default

Limit results on date range starting with

Example 
2018-01-01T03:07:58.742+0000
endDate
string
default: ##default

Limit results on date range ending with

Example 
2018-01-02T03:07:58.742+0000

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 ”

OK

Media type application/json
Array<object>
object
bookingIdentifier
required

Booking ID

string format: uuid
default: ##default >= 1 characters
propertyIdentifier
required

Property ID

string format: uuid
default: ##default >= 1 characters
roomRateIdentifier
required

Master Rate ID

string format: uuid
default: ##default >= 1 characters
name
required

Master Rate name

string
default: ##default >= 1 characters
guestRoomName
required

Guest room name

string
default: ##default >= 1 characters
ratePlanName
required

Rate plan name

string
default: ##default >= 1 characters
rooms
required

Number of rooms

integer format: int32
default: ##default
guests
required

Number of guests

integer format: int32
default: ##default
adults
required

Number of adults

integer format: int32
default: ##default
children
required

Number of children

integer format: int32
default: ##default
firstName
required

First name of traveler

string
default: ##default >= 1 characters
lastName
required

Last name of traveler

string
default: ##default >= 1 characters
email
required

E-mail of traveler

string
default: ##default >= 1 characters
amount
required

Total booking amount

number
default: ##default
currencyCode
required

Supplier currency

string
default: ##default >= 1 characters
bookingCode
required

Ref. code for traveler

string
default: ##default >= 1 characters
startDate
required

Arrival date

string format: date
default: ##default
endDate
required

Departure date

string format: date
default: ##default
createdDate
required

Created date

string format: date-time
default: ##default
cancelled
required

Whether booking is cancelled or not

boolean
cancelDate

Cancellation date if booking was cancelled

string format: date-time
default: ##default
paymentMethodType
required

Payment method

string
default: ##default >= 1 characters
paymentWalletType

Optional payment wallet type

string
default: ##default
paymentMethodStatus
required

Status of payment

string
default: ##default
Allowed values: INITIALIZED PROCESSING SUCCEEDED FAILED
salesChannelName
required

Sales channel name

string
default: ##default >= 1 characters
salesChannelIdentifier
required

Sales channel ID

string format: uuid
default: ##default >= 1 characters
Example 
[
  {
    "bookingIdentifier": "##default",
    "propertyIdentifier": "##default",
    "roomRateIdentifier": "##default",
    "name": "##default",
    "guestRoomName": "##default",
    "ratePlanName": "##default",
    "rooms": "##default",
    "guests": "##default",
    "adults": "##default",
    "children": "##default",
    "firstName": "##default",
    "lastName": "##default",
    "email": "##default",
    "amount": "##default",
    "currencyCode": "##default",
    "bookingCode": "##default",
    "startDate": "##default",
    "endDate": "##default",
    "createdDate": "##default",
    "cancelled": false,
    "cancelDate": "##default",
    "paymentMethodType": "##default",
    "paymentWalletType": "##default",
    "paymentMethodStatus": "INITIALIZED",
    "salesChannelName": "##default",
    "salesChannelIdentifier": "##default"
  }
]

400

Section titled “400 ”

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401 ”

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}