Skip to content
aerandil.com
GitHub

Search Reservation

POST
/v1/object-types/hospitality.reservation/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.reservation/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "confirmation_number", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

A confirmed or held intent to occupy one or more rooms over a set of nights. Linked to a property, a primary guest, optionally a company, a rate plan, and a room type.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid
cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string
filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array
One of:
object
property
required
Allowed value: confirmation_number
type
required
Allowed value: eq
value
required
string
limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer
>= 1 <= 500
order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string
default: asc
Allowed values: asc desc
property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid
scope
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string
default: created_at
Allowed values: created_at updated_at confirmation_number arrival_date departure_date adults children status source market_segment channel_reference visitor_id guarantee special_requests booked_at deposit_due_at prepayment_status no_show_fee_status no_show_fee_attempt_open_at no_show_fee_attempt_provider_card_ref no_show_fee_attempt_provider_customer_ref no_show_posting_basis hold_expires_at cancellation_policy_text cancellation_fee_due_at cancellation_fee_status stay_context_kind stay_context_notes cancellation_reason no_show_reason cancelled_at external_ref fraud_warning_at fraud_warning_response cancellation_fee_attempt_open_at cancellation_fee_attempt_provider_card_ref cancellation_fee_attempt_provider_customer_ref

Responses

Section titled “Responses”

200

Section titled “200”

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

Media typeapplication/json
object
data
required
Array<object>
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.reservation
properties
required
object
adults
required
Adults
integer
arrival_date
required
Arrival date
string format: date
booked_at
required
Booked at
string format: date-time
cancellation_fee_amount
Reservation cancellation fee amount

Cancellation fee

object
amount
required
string format: decimal
currency
required
string format: iso-4217
cancellation_fee_attempt_card_ref
The stored card an open cancellation fee collection is charging — drawn again by its retry whatever the house's merchant account did in between
string format: uuid
cancellation_fee_attempt_open_at
Set while a collection of the cancellation fee is open — written before the processor is asked, cleared when its outcome is recorded; an open attempt is asked again under the same key
string format: date-time
cancellation_fee_attempt_provider_card_ref
The processor payment method an open cancellation fee collection is charging — the card's `provider_card_ref` when the attempt opened
string
cancellation_fee_attempt_provider_customer_ref
The processor customer an open cancellation fee collection is charging — the card's `provider_customer_ref` when the attempt opened
string
cancellation_fee_due_at
Cancellation fee due at (frozen at booking)
string format: date-time
cancellation_fee_status
Cancellation fee status
string
Allowed values: assessed collected authentication_required uncollectible
cancellation_policy_ref
Cancellation policy (live ref)
string format: uuid
cancellation_policy_text
Cancellation policy text (snapshot at booking)
string
cancellation_reason
Cancellation reason (set by cancel_reservation)
string
cancellation_schedule
Reservation cancellation schedule

Cancellation ladder resolved to money (frozen at booking)

Array<object>
object
effective_from
required
string format: date-time
penalty_amount
required
object
amount
required
string format: decimal
currency
required
string format: iso-4217
penalty_kind
required
string
Allowed values: absolute percent_of_total n_nights
tier_index
required
integer
cancelled_at
Cancelled at
string format: date-time
channel_reference
External channel reference
string
children
required
Children
integer
confirmation_number
Confirmation number
string
departure_date
required
Departure date
string format: date
deposit_due_at
Deposit due by
string format: date-time
deposit_paid_amount
Reservation deposit paid amount

Deposit paid (accumulating)

object
amount
required
string format: decimal
currency
required
string format: iso-4217
deposit_policy_ref
Deposit policy (frozen at derivation)
string format: uuid
deposit_required_amount
Reservation deposit required amount

Deposit required

object
amount
required
string format: decimal
currency
required
string format: iso-4217
deposit_returned_amount
Reservation deposit returned amount

Deposit returned (accumulating)

object
amount
required
string format: decimal
currency
required
string format: iso-4217
expected_total
Reservation expected total

Expected total revenue

object
amount
required
string format: decimal
currency
required
string format: iso-4217
external_ref
Source-system key for connector-landed reservations
string
fraud_warning_at
When an issuer warned of fraud on a payment for this booking

Set by record_fraud_warning when an issuer’s early fraud warning reaches a payment behind this booking (the payment carries the warning itself). Before arrival the desk decides whether to cancel and refund while the room can still be resold; a voided hold leaves the booking without its guarantee.

string format: date-time
fraud_warning_response
What the card rail did about that warning
string
Allowed values: hold_voided refunded desk_review not_actionable
guarantee
required
Guarantee
string
Allowed values: none hold credit_card deposit prepaid corporate_billed voucher
hold_expires_at
Hold expires at
string format: date-time
market_segment
Market segment
string
Allowed values: transient group contract
no_show_fee_amount
Reservation no show fee amount

No-show fee

object
amount
required
string format: decimal
currency
required
string format: iso-4217
no_show_fee_attempt_card_ref
The stored card an open no-show fee collection is charging — drawn again by its retry whatever the house's merchant account did in between
string format: uuid
no_show_fee_attempt_open_at
Set while a collection of the no-show fee is open — written before the processor is asked, cleared when its outcome is recorded; an open attempt is asked again under the same key
string format: date-time
no_show_fee_attempt_provider_card_ref
The processor payment method an open no-show fee collection is charging — the card's `provider_card_ref` when the attempt opened
string
no_show_fee_attempt_provider_customer_ref
The processor customer an open no-show fee collection is charging — the card's `provider_customer_ref` when the attempt opened
string
no_show_fee_status
No-show fee status
string
Allowed values: assessed collected authentication_required uncollectible
no_show_posted_amount
Reservation no show posted amount

No-show amount posted

object
amount
required
string format: decimal
currency
required
string format: iso-4217
no_show_posting_basis
No-show posting basis applied
string
Allowed values: all_nights first_night deposit_only none
no_show_reason
No-show reason (set by mark_reservation_no_show)
string
prepayment_status
Prepayment status
string
Allowed values: not_required required invoiced partially_paid paid applied_to_folio refunded forfeited
source
required
Source
string
Allowed values: direct_web direct_call property_direct ota gds wholesale corporate walk_in group_block agent loyalty
special_requests
Special requests
string
status
required
Status
string
Allowed values: held confirmed modified in_house checked_out cancelled no_show
stay_context_kind
Stay context kind
string
Allowed values: leisure business anniversary wellness_retreat family event_attendance bleisure other
stay_context_notes
Stay context notes
string
visitor_id
Booking engine visitor
string
provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object
pins
object
key
additional properties
object
pinned_at
string format: date-time
pinned_by
object
reason
required
string
properties
object
key
additional properties
object
external_id
string
recorded_at
required
string format: date-time
source
required
string
source_updated_at
string format: date-time
stream
string
scope
required
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer
>= 1
has_more
required
boolean
next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string
Example
{
  "data": [
    {
      "object_type": "hospitality.reservation",
      "properties": {
        "cancellation_fee_status": "assessed",
        "cancellation_schedule": [
          {
            "penalty_kind": "absolute"
          }
        ],
        "fraud_warning_response": "hold_voided",
        "guarantee": "none",
        "market_segment": "transient",
        "no_show_fee_status": "assessed",
        "no_show_posting_basis": "all_nights",
        "prepayment_status": "not_required",
        "source": "direct_web",
        "status": "held",
        "stay_context_kind": "leisure"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.