Skip to main content

BookingListResponse

Response containing booking list

auditData object

Audit metadata (AuditData proto). Real wire uses requestId + transactions[] (see G2 E2E captures). There is no processTime field on this message.

requestIdstring

Request correlation id

transactions object[]

Provider transaction audit records when settings.auditTransactions is true.

  • Array [
  • idstring

    Transaction id

    connectionCodestring

    Connection code that produced this exchange

    requeststring

    Outbound request body (as sent to the provider)

    responsestring

    Inbound response body (as received from the provider)

    durationinteger<int32>

    Round-trip duration in milliseconds

    httpUrlstring

    Provider URL that was called

    httpStatusCodeinteger<int32>

    HTTP status code (0 when transport failed before a status)

    httpResponseHeaders object

    Selected response headers from the provider call

    property name*string
  • ]
  • errors object[]
  • Array [
  • codestring

    Error code identifier. Transient provider-side failures (integration unreachable, HTTP 502/503/504, connection error or open circuit breaker) are reported as ERR_CODE_BAD_RESPONSE.

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

    Example: ERR_CODE_CONNECTION_DATA_MISSING
    typestring

    Error type category. Provider-side failures (including transient outages) are reported as ERR_TYPE_PROVIDER.

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

    Example: ERR_TYPE_PROVIDER
    descriptionstring

    Human-readable error description

    connectionCodestring

    Connection code associated with the error (if applicable)

    Example: testb-conn-1876
    additionalData object

    Optional string map. When the aggregator recognizes the provider message, it may set retryable and recommended_action (restart_availability, requote_new_price, verify_booking_then_restart, backoff_and_retry, fix_request).

    property name*string
  • ]
  • warnings object[]
  • Array [
  • codestring

    Warning code identifier

    Example: WARN_CODE_NONE
    descriptionstring

    Human-readable warning description

    Example: No markup configured for connection; selling price uses provider gross/suggested
    connectionCodestring

    Connection code associated with the warning

    Example: testb-conn-1876
    additionalData object

    Additional data providing context about the warning. For INFO_NO_MARKUP_CONFIGURED warnings, includes:

    • warning_type: "INFO_NO_MARKUP_CONFIGURED"
    • connection_code: The affected connection code For STAY_DATE_NORMALIZED warnings, includes:
    • warning_type: "STAY_DATE_NORMALIZED"
    • severity: "INFO"
    • field: "checkIn" or "checkOut"
    • received: original timestamp string
    • used: civil date actually searched (YYYY-MM-DD)
    property name*string
  • ]
  • debugData object[]

    Debug type/value pairs when enabled

  • Array [
  • typestring

    Remark type

    valuestring

    Remark value

  • ]
  • bookings object[]

    List of bookings

  • Array [
  • statusstring

    Reservation lifecycle enum from the aggregator contract (proto BookStatusType). Use these values for UX and polling — not informal labels such as CONFIRMED / PENDING.

    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]

    Example: BOOK_STATUS_TYPE_OK
    reference object

    Booking identifiers (proto Reference)

    bookingIDstring

    Bundleport booking identifier; store for detail, list, and cancel

    clientReferencestring

    Your own reference echoed from the book request; use for idempotency checks and support (e.g. list by clientReference).

    providerReferencestring

    Provider/supplier booking reference

    confirmationReferencestring

    Hotel confirmation at booking level when the provider sets it. The aggregator forwards this field when present. Some providers still leave it empty and only populate rooms[].confirmationReference — prefer room-level when this is blank.

    billingProviderCodestring

    Provider code used for billing (proto field name on aggregator)

    Example: example
    price object

    Price information. Three independent prices coexist: provider cost (net), provider retail (gross/suggested), and the org selling price (markupGross). The org margin configured per connection is applied on top of the provider gross, never on net. When no margin is configured, markupGross equals the provider gross.

    netnumber<float>

    Provider cost (what the agency pays the supplier).

    currencystring

    Currency code

    bindingboolean

    Provider binding flag. When true the provider gross/suggested is the minimum selling price and must be respected (cannot be sold below it).

    suggestednumber<float>

    Provider suggested retail / minimum selling price (preserved from provider, not overwritten by markup).

    grossnumber<float>

    Provider retail price before any org markup (falls back to net when the provider does not send a suggested price).

    markupGrossnumber<float>

    Customer selling price = provider gross + org margin. Equals the provider gross when no margin is configured.

    markupNetnumber<float>

    Provider net cost plus the org margin amount (mandatory field).

    markupCurrencystring

    Currency of the markup (usually same as currency)

    markupBindingboolean

    Indicates if the markup price must be respected (mandatory field).

    marginAmountnumber<float>

    Org margin amount applied on provider gross (markupGross - gross).

    marginPercentnumber<float>

    Effective margin percentage applied on provider gross.

    marginTypestring

    Type of margin applied - FIXED or PERCENTAGE

    remarks object[]

    Booking remarks as type/value pairs (proto TypeValue)

  • Array [
  • typestring

    Remark type

    valuestring

    Remark value

  • ]
  • rooms object[]

    Booked rooms in the response shape (proto BookingDetailRoom). Do not confuse with request BookRoom (occupancy + paxes).

  • Array [
  • occupancyRefIdinteger<int32>

    Occupancy reference from the original search

    codestring

    Room code

    descriptionstring

    Room description

    confirmationReferencestring

    Hotel confirmation reference for this room. Often the populated confirmation even when reference.confirmationReference is empty.

    Example: HTL-3650-102-18690172
  • ]
  • ]
  • BookingListResponse
    {
    "auditData": {
    "requestId": "string",
    "transactions": [
    {
    "id": "string",
    "connectionCode": "string",
    "request": "string",
    "response": "string",
    "duration": 0,
    "httpUrl": "string",
    "httpStatusCode": 0,
    "httpResponseHeaders": {}
    }
    ]
    },
    "errors": [
    {
    "code": "ERR_CODE_CONNECTION_DATA_MISSING",
    "type": "ERR_TYPE_PROVIDER",
    "description": "string",
    "connectionCode": "testb-conn-1876",
    "additionalData": {}
    }
    ],
    "warnings": [
    {
    "code": "WARN_CODE_NONE",
    "description": "No markup configured for connection; selling price uses provider gross/suggested",
    "connectionCode": "testb-conn-1876",
    "additionalData": {
    "warning_type": "INFO_NO_MARKUP_CONFIGURED",
    "connection_code": "testb-conn-1876"
    }
    }
    ],
    "debugData": [
    {
    "type": "string",
    "value": "string"
    }
    ],
    "bookings": [
    {
    "status": "BOOK_STATUS_TYPE_OK",
    "reference": {
    "bookingID": "string",
    "clientReference": "string",
    "providerReference": "string",
    "confirmationReference": "string"
    },
    "billingProviderCode": "example",
    "price": {
    "net": 0,
    "currency": "string",
    "binding": true,
    "suggested": 0,
    "gross": 0,
    "markupGross": 0,
    "markupNet": 0,
    "markupCurrency": "string",
    "markupBinding": true,
    "marginAmount": 0,
    "marginPercent": 0,
    "marginType": "string"
    },
    "remarks": [
    {
    "type": "string",
    "value": "string"
    }
    ],
    "rooms": [
    {
    "occupancyRefId": 0,
    "code": "string",
    "description": "string",
    "confirmationReference": "HTL-3650-102-18690172"
    }
    ]
    }
    ]
    }