BookingDetailResponse

BookingDetailResponse returns detailed information for a booking.

auditData object

Request audit information and downstream trace ids.

requestIdrequestId (string)

Identifier supplied by the caller to correlate the request.

transactions object[]

Downstream transactions performed during the request lifecycle.

Array [

accessIdaccessId (string)

Access identifier used for the provider call.

requestrequest (string)

Raw request payload captured for auditing.

responseresponse (string)

Raw response payload captured for auditing.

idid (string)

Identifier of the transaction within the aggregator.

durationinteger<int32>

Duration in milliseconds for the provider call.

httpUrlhttpUrl (string)

Target URL of the provider call.

httpStatusCodeinteger<int32>

HTTP status code returned by the provider.

httpResponseHeaders object

HTTP headers returned by the provider.

property name*value (string)

]

errors object[]

Blocking errors encountered while retrieving the booking.

Array [

typetype (string)

Error type grouping to help the client react appropriately.

Possible values: [ERR_TYPE_NONE, ERR_TYPE_UNKNOWN, ERR_TYPE_CLIENT, ERR_TYPE_PROVIDER, ERR_TYPE_SERVICE]

codecode (string)

Specific error code exposed by the aggregator.

Possible values: [ERR_CODE_NONE, ERR_CODE_UNKNOWN, ERR_CODE_ACCESS_DATA_MISSING, ERR_CODE_BAD_RESPONSE, ERR_CODE_BAD_REQUEST, ERR_CODE_MISSING_FIELDS, ERR_CODE_CONFIGURATION]

descriptiondescription (string)

Human readable description of the error.

additionalData object

Additional key/value data associated with the error.

property name*value (string)

accessIdaccessId (string)

Access identifier that produced the error when applicable.

]

warnings object[]

Non-blocking warnings returned alongside the booking.

Array [

codecode (string)

Warning code categorising the issue.

Possible values: [WARN_CODE_NONE, WARN_MAPPING_HOTEL_MISSING, WARN_MAPPING_ROOM_MISSING, WARN_MAPPING_RATE_PLAN_MISSING, WARN_MAPPING_BOARD_CODE_MISSING]

descriptiondescription (string)

Human readable warning description.

additionalData object

Additional key/value data associated with the warning.

property name*value (string)

accessIdaccessId (string)

Access identifier that produced the warning when available.

]

debugData object[]

Additional debug data for diagnostic purposes.

Array [

typetype (string)

Type identifier that categorises the value.

valuevalue (string)

Associated value.

]

booking object

Booking details as defined in BookResponse.

statusstatus (string)

Resulting booking status.

Possible values: [BOOK_STATUS_TYPE_OK, BOOK_STATUS_TYPE_KO, BOOK_STATUS_TYPE_ON_REQUEST, BOOK_STATUS_TYPE_CANCELLED, BOOK_STATUS_TYPE_UNKNOWN, BOOK_STATUS_TYPE_PENDING_COMMIT]

reference object

Booking references across aggregator, client and provider.

bookingIDbookingID (string)

Booking identifier generated by the aggregator.

clientReferenceclientReference (string)

Client reference supplied during booking.

providerReferenceproviderReference (string)

Provider booking reference.

confirmationReferenceconfirmationReference (string)

Confirmation reference communicated to travellers.

billingSupplierCodebillingSupplierCode (string)

Supplier code responsible for billing the booking.

price object

Final price associated with the booking.

bindingbinding (boolean)

Indicates whether the price is binding or subject to change.

suggestednumber<double>

Recommended selling price.

netnumber<double>

Net cost injected by the provider.

currencycurrency (string)

ISO 4217 currency code for the price amounts.

remarks object[]

Remarks from the provider related to the booking.

Array [

typetype (string)

Type identifier that categorises the value.

valuevalue (string)

Associated value.

]

rooms object[]

Rooms confirmed as part of the booking.

Array [

occupancyRefIdinteger<int32>

Occupancy reference associated with the room.

codecode (string)

Provider room code.

descriptiondescription (string)

Descriptive room name.

confirmationReferenceconfirmationReference (string)

Provider confirmation reference for the room.

]

BookingDetailResponse

{
  "auditData": {
    "requestId": "string",
    "transactions": [
      {
        "accessId": "string",
        "request": "string",
        "response": "string",
        "id": "string",
        "duration": 0,
        "httpUrl": "string",
        "httpStatusCode": 0,
        "httpResponseHeaders": {}
      }
    ]
  },
  "errors": [
    {
      "type": "ERR_TYPE_NONE",
      "code": "ERR_CODE_NONE",
      "description": "string",
      "additionalData": {},
      "accessId": "string"
    }
  ],
  "warnings": [
    {
      "code": "WARN_CODE_NONE",
      "description": "string",
      "additionalData": {},
      "accessId": "string"
    }
  ],
  "debugData": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "booking": {
    "status": "BOOK_STATUS_TYPE_OK",
    "reference": {
      "bookingID": "string",
      "clientReference": "string",
      "providerReference": "string",
      "confirmationReference": "string"
    },
    "billingSupplierCode": "string",
    "price": {
      "binding": true,
      "suggested": 0,
      "net": 0,
      "currency": "string"
    },
    "remarks": [
      {
        "type": "string",
        "value": "string"
      }
    ],
    "rooms": [
      {
        "occupancyRefId": 0,
        "code": "string",
        "description": "string",
        "confirmationReference": "string"
      }
    ]
  }
}