Skip to main content

QuoteResponse

QuoteResponse returns the result of repricing a specific option.

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 quoting the option.

  • 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 quote data.

  • 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.

  • ]
  • optionQuote object

    Quote result with updated price and policies.

    optionRefIdoptionRefId (string)

    Identifier of the option that was repriced.

    statusstatus (string)

    Status of the quote request.

    Possible values: [STATUS_TYPE_OK, STATUS_TYPE_RQ]

    price object

    Updated price including all applicable charges.

    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.

    acceptVCardacceptVCard (boolean)

    Indicates whether virtual cards are accepted for payment.

    surcharges object[]

    Additional surcharges applied during quoting.

  • Array [
  • typetype (string)

    Surcharge type identifier.

    descriptiondescription (string)

    Human readable description of the surcharge.

    mandatorymandatory (boolean)

    Indicates whether the surcharge is mandatory.

    includedincluded (boolean)

    Indicates whether the surcharge is included in the displayed price.

    price object

    Price associated with the surcharge.

    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.

  • ]
  • cancelPolicy object

    Cancellation policy associated with the quoted option.

    cancelPenalties object[]

    Penalties applicable when cancelling.

  • Array [
  • currencycurrency (string)

    Currency used for the penalty value.

    deadlinestring<date-time>

    Deadline timestamp after which the penalty applies.

    hoursBeforeinteger<int32>

    Hours before arrival when the penalty becomes effective.

    penaltyTypepenaltyType (string)

    Type of penalty value.

    Possible values: [IMPORT, NIGHTS, PERCENT]

    valuenumber<double>

    Penalty value interpreted according to penaltyType.

  • ]
  • refundablerefundable (boolean)

    Indicates whether the booking is refundable.

    remarks object[]

    Additional remarks from the provider.

  • Array [
  • typetype (string)

    Type identifier that categorises the value.

    valuevalue (string)

    Associated value.

  • ]
  • QuoteResponse
    {
    "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"
    }
    ],
    "optionQuote": {
    "optionRefId": "string",
    "status": "STATUS_TYPE_OK",
    "price": {
    "binding": true,
    "suggested": 0,
    "net": 0,
    "currency": "string"
    },
    "acceptVCard": true,
    "surcharges": [
    {
    "type": "string",
    "description": "string",
    "mandatory": true,
    "included": true,
    "price": {
    "binding": true,
    "suggested": 0,
    "net": 0,
    "currency": "string"
    }
    }
    ],
    "cancelPolicy": {
    "cancelPenalties": [
    {
    "currency": "string",
    "deadline": "2024-07-29T15:51:28.071Z",
    "hoursBefore": 0,
    "penaltyType": "IMPORT",
    "value": 0
    }
    ],
    "refundable": true
    },
    "remarks": [
    {
    "type": "string",
    "value": "string"
    }
    ]
    }
    }